FAfactorialhr
BookkeepersManagement > Incidence

Updates an Incidence

Changed on

Updates an Incidence

put/api/2026-10-01/resources/bookkeepers_management/incidences/{id}

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/bookkeepers_management/incidences/{id}
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: employee_updates
    • or API key in header x-api-key

Path parameters

idstring required

incidence (aka employee update) identifier to update.

Request body

idstring required

incidence (aka employee update) identifier to update.

statusstring

status of the incidence (aka employee update). It can be any of 'in-preparation', 'to-do', 'doing', 'done', 'discarded'

has_messageboolean

Boolean that indicates is the incidence (aka employee update) has message

message_fromstring
read_atstring

Date in which the incidence (aka employee update) was read

mark_as_readboolean

Boolean that indicate if the incidence is read

Example request

{
  "id": "1",
  "status": "to-do",
  "has_message": true,
  "read_at": "2020-01-01",
  "mark_as_read": true
}

Response

OK

idstring required

identifier of the incidence (aka employee update).

employee_idstring

identifier of employee related.

legal_entity_idstring required

identifier of legal entity related.

namestring required

name of the incidence (aka employee update). It also represent the incidence type. For example a new hire incidence will be

custom_namestring
target_idstring required

The incidence (aka employee update) is also related to a another resource, for example for a leave target, the target identifier will be the leave id.

target_typestring required

The incidence (aka employee update) is also related to a another resource, for example a leave. This is the target type. The other types are Employee, Contracts::ContractVersion, BookkeepersManagement::ManualIncidence, Finance::CostCenterMembership.

starts_onstring

The date the incidence (aka employee update) starts.

ends_onstring

The date the incidence (aka employee update) end.

read_atstring

The date the incidence (aka employee update) was read.

statusstring required
company_idstring required

identifier of company related.

message_fromstring

Indicate the message sender on the incidence (aka employee update). It can be any of 'bookkeeper', 'admin'

has_messageboolean

Boolean that indicates if the incidence (aka employee update) has unread messages.

created_atstring required

Date in which incidence (aka employee update) was created.

is_reopenedboolean required

Boolean that indicates if the incidence (aka employee update) has been reopened.

legal_entity_namestring
employee_first_namestring
employee_last_namestring

Example response

{
  "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
}

Changes