API Reference

for object "Expenses"

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




What is an expense ?

It's a payment made by an employee on the payroll, for a purpose serving the company. This payment will be reimbursed by the company to the employee.




Getting the expenses list

GET /expense_sheets.xml

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




Getting a single expense

GET /expense_sheets/#{id}.xml

Returns a single expense, identified by its id




Creating a new expense

POST /expense_sheets.xml

Creates a new expense, and returns the expense data




Updating an existing expense

PUT /expense_sheets/#{id}.xml

Updates some fields of an existing expense




Deleting an existing expense

DELETE /expense_sheets/#{id}.xml

Deletes the expense identified by its id




Object data

<expense_sheet>
 <id>id of this object</id>
 <staff_member_id>id of staff member for this expense sheet</staff_member_id>
 <vehicule_fiscal_power>fiscal power of employee's vehicle</vehicule_fiscal_power>
 <period>month for this expense sheet (a date)</period>
 <advance_amount>advance amount paid to employee</advance_amount>
 <status_id>status of expense (see below)</status_id>
 <submission_date>date of submission of sheet</submission_date>
 <validator_id>user id of validator</validator_id>
 <validated_at>date of validation</validated_at>
 <expense_lines>
 <expense_line>
  <day>day in the month</day>
  <description>description of this</description>
  <type_id>type of expense (see below)</type_id>
  <amount>value including tax</amount>
  <tva_pct>vat id (see below)</tva_pct>
 </expense_line>
 </expense_lines>
</expense_sheet>




Possible values of expense line type

  • 245 if driving by the kilometer

  • 246 if car oil

  • 247 if parking, car toll

  • 248 if taxi

  • 249 if internal meals

  • 250 if external meals

  • 251 if hotel

  • 252 if post office

  • 253 if phone

  • 254 if documentation

  • 255 if miscellaneous

  • 571 if goodies

  • 572 if raw materials



Possible values of expense status

  • 242 if being completed

  • 243 if submitted

  • 244 if archived