Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
BookkeepersManagement > Incidence

Reads all Incidences

Reads all Incidences

get/api/2026-07-01/resources/bookkeepers_management/incidences

Query parameters

ids[]string[]

A list of incidence identifiers.

A list of incidence identifiers.

[
  "1",
  "2",
  "3"
]
legal_entities_ids[]string[]

A list of legal entities identifiers.

A list of legal entities identifiers.

[
  "1",
  "2",
  "3"
]
status[]string[]

A list of statuses.

A list of statuses.

[
  "in-preparation",
  "to-do",
  "doing",
  "done",
  "discarded"
]
starts_onstring

Get the incidence (aka employee update) that start safter this date (included).

Example:2020-01-01

Get the incidence (aka employee update) that start safter this date (included).

ends_onstring

Get the incidence (aka employee update) that ends before this date (included).

Example:2020-01-01

Get the incidence (aka employee update) that ends before this date (included).

type[]string[]

A list of types. It can be any of the following address, bank, cost_center, contract, gender, hiring, id, irpf, legal_entity, manual_incidence, name, nationality, parental, phone_number, sick, tax_id, termination, workplace

A list of types. It can be any of the following address, bank, cost_center, contract, gender, hiring, id, irpf, legal_entity, manual_incidence, name, nationality, parental, phone_number, sick, tax_id, termination, workplace

[
  "hiring",
  "workplace"
]
sort_bystring

Field to sort by. It can be any of the following employee_first_name, employee_last_name, type, legal_entity_name, effective_date, status.

Example:effective_date

Field to sort by. It can be any of the following employee_first_name, employee_last_name, type, legal_entity_name, effective_date, status.

directionstring

Sort direction. It can be 'asc' or 'desc'.

Example:desc

Sort direction. It can be 'asc' or 'desc'.

searchstring

Filter the result by the name of the employee.

Example:Hellen

Filter the result by the name of the employee.

employee_ids[]string[]

A list of employee identifiers.

A list of employee identifiers.

[
  "1",
  "2",
  "3"
]
contains_messageboolean

Boolean that filters incidences that does or does not contains messages.

Example:true

Boolean that filters incidences that does or does not contains messages.

message_fromstring

Filter by message sender.

Example:bookkeeper

Filter by message sender.

custom_leave_name[]string[]

A list of custom leave names.

A list of custom leave names.

[
  "Medical Leave",
  "Paternity Leave"
]

Response

OK

Example response

{
  "data": [
    {
      "id": "1",
      "employee_id": "1",
      "legal_entity_id": "1",
      "name": "hiring",
      "target_id": "1",
      "target_type": "Timeoff::Leave",
      "starts_on": "2020-01-01",
      "ends_on": "2020-01-01",
      "read_at": "2020-01-01",
      "company_id": "1",
      "message_from": "admin",
      "has_message": true,
      "is_reopened": true
    }
  ]
}