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

What is a month of salary ?

A month of salary (salary_campaigns) contains the list of salaries paid to each employee this month.

Getting the month of salaries list

GET /salary_campaigns.xml

Returns all month of salaries, page by page
Add a page parameter to navigate

Getting a single month of salary

GET /salary_campaigns/#{id}.xml

Returns a single month of salary, identified by its id

Creating a new month of salary

POST /salary_campaigns.xml

Creates a new month of salary, and returns the month of salary data

Updating an existing month of salary

PUT /salary_campaigns/#{id}.xml

Updates some fields of an existing month of salary

Deleting an existing month of salary

DELETE /salary_campaigns/#{id}.xml

Deletes the month of salary identified by its id

Object data

<salary_campaign>
 <id>id of this object</id>
 <status_id>status of this month (see below)</status_id>
 <period>month for this (a date)</period>
 <salaries>
  <salary>
   <staff_member_id>id of staff</staff_member_id>
   <base_salary>base salary paid this month</base_salary>
   <base_salary_is_net>1 if base salary is net</base_salary_is_net>
   <result_bonus>result bonus paid this month</result_bonus>
   <result_bonus_is_net>1 if bonus is net</result_bonus_is_net>
   <exceptional_bonus>exceptional bonus paid this month</exceptional_bonus>
   <exceptional_bonus_is_net>1 if exceptional bonus is net</exceptional_bonus_is_net>
   <vacation_days_nb>number of days of vacation this month</vacation_days_nb>
   <recup_days_nb>number of days of rest this month</recup_days_nb>
   <recup_gained_days>number of days of rest gained this month</recup_gained_days>
   <RTT_employee_nb>number of days of employee rtt this month</RTT_employee_nb>
   <RTT_employer_nb>number of days of employer rtt this month</RTT_employer_nb>
   <RTT_gained_days>number of days of gained days of rtt this month</RTT_gained_days>
   <vacation_gained_days>number of days of vacation gained this month</vacation_gained_days>
   <sickness_days_nb>number of days of sickness this month</sickness_days_nb>
   <absence_days_nb>number of days of absence this month</absence_days_nb>
   <comment></comment>
   <insurance>1 if employee has social insurance this month</insurance>
   <arrival_day>day of arrival in the month, if in the month</arrival_day>
   <departure_day>day of departure in the month, if in the month</departure_day>
   <meal_tickets_nb>number of meal tickets this month</meal_tickets_nb>
   <commute_zones_nb>number of transport zones</commute_zones_nb>
  </salary>
 </salaries>
</salary_campaign>

Possible values of salary month status

• 52 if being written

• 53 if submitted

• 54 if validated