v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Employments Brazil

Get an employment's details

Get the details of a specific employment.

get/api/br/employments/{id}/

Path parameters

idstring uuid required

The employment.id you want to get detailed information about.

Query parameters

omitstring

Omit certain fields from being returned in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

fieldsstring

Return only the specified fields in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

Response

idstring uuid required

Belvo's unique identifier for the current item.

linkstring uuid nullable required

The link.id the data belongs to.

created_atstring date-time required

The ISO-8601 timestamp of when the data point was created in Belvo's database.

collected_atstring date-time required

The ISO-8601 timestamp when the data point was collected.

start_datestring date required

The employee's start date at the employer, in YYYY-MM-DD format.

end_datestring date nullable required

The employee's end date at the employer, in YYYY-MM-DD format. If null, the employee is still working at the employer.

Example response

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "collected_at": "2022-02-09T08:45:50.406032Z",
  "start_date": "2022-01-01",
  "end_date": "2023-01-01",
  "employer_data": {
    "name": "Wayne Industries",
    "code": "49430669",
    "economic_activity": "6421-2 - BANCOS COMERCIAIS"
  },
  "occupations": [
    {
      "start_date": "2022-01-01",
      "end_date": "2023-01-01",
      "description": "ANALISTA DE PRODUTOS BANCARIOS",
      "name": "ANALISTA DE PRODUTOS BANCARIOS - 2525-40",
      "locale": "Urbana"
    }
  ],
  "salaries": [
    {
      "base_amount": 1033.09,
      "retained_amount": 0.01,
      "type": "VOLUNTARY",
      "month": "2022-01",
      "currency": "BRL"
    }
  ]
}