v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Employments Brazil

List employments

▶️ Usage

With the List Employments method, you can:

[Required] List employments related to a specific link.id (using the link query parameter).
Get the details of a specific employment.id (using the id query parameter).

📖 Pagination

This method returns a paginated response (default: 100 items per page). You can use the page_size query parameter to increase the number of items returned to a maximum of 1000 items. You can use the page query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our <a href="https://developers.belvo.com/docs/belvo-pagination-tips" target="_blank">Pagination Tips</a> article.

🔦 Filtering Responses

Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> article.

get/api/br/employments/

Query parameters

linkstring uuid required

Example:8848bd0c-9c7e-4f53-a732-ec896b11d4c4

The link.id you want to filter by.

page_sizeinteger

Example:100

Indicates how many results to return per page. By default we return 100 results per page.

ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000).

pageinteger

Example:1

A page number within the paginated result set.

idstring uuid

Example:24ccab1d-3a86-4136-a6eb-e04bf52b356f

Return information only for this resource id.

id__instring[]

Return information for these resource ids.

[
  "6b3dea0f-be29-49d1-aabe-1a6d588642e6"
]

link__instring[]

Return results only for these link.ids.

[
  "5722d0ba-69d7-42dc-8ff5-33767b83c5d6"
]

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.

start_datestring date

Example:2022-05-05

Return employments that started on this date, in YYYY-MM-DD format.

start_date__gtstring date

Example:2022-05-06

Return employments that started after this date, in YYYY-MM-DD format.

start_date__gtestring date

Example:2022-05-04

Return employments that started on or after this date, in YYYY-MM-DD format.

start_date__ltstring date

Example:2022-03-02

Return employments that started before this date, in YYYY-MM-DD format.

start_date__ltestring date

Example:2022-03-01

Return employments that started on or before this date, in YYYY-MM-DD format.

start_date__rangestring[]

Return employments that started within these two dates, in YYYY-MM-DD,YYYY-MM-DD format. The first value indicates the start of the range and the second value indicates the end of the range.

[
  "2022-01-01",
  "2022-12-31"
]

end_datestring date

Example:2022-05-05

Return employments that finished on this date, in YYYY-MM-DD format.

end_date__gtstring date

Example:2022-05-06

Return employments that finished after this date, in YYYY-MM-DD format.

end_date__gtestring date

Example:2022-05-04

Return employments that finished on or after this date, in YYYY-MM-DD format.

end_date__ltstring date

Example:2022-03-02

Return employments that finished before this date, in YYYY-MM-DD format.

end_date__ltestring date

Example:2022-03-01

Return employments that finished on or before this date, in YYYY-MM-DD format.

end_date__rangestring[]

Return employments that finished within these two dates, in YYYY-MM-DD,YYYY-MM-DD format. The first value indicates the start of the range and the second value indicates the end of the range.

[
  "2022-01-01",
  "2022-12-31"
]

created_atstring date

Example:2022-05-05

Return items that were last updated in Belvo's database on this date (in YYYY-MM-DD format).

created_at__gtstring date

Example:2022-05-05

Return items that were last updated in Belvo's database after this date (in YYYY-MM-DD format).

created_at__gtestring date

Example:2022-05-04

Return items that were last updated in Belvo's database after or on this date (in YYYY-MM-DD format).

created_at__ltstring date

Example:2022-04-01

Return items that were last updated in Belvo's database before this date (in YYYY-MM-DD format).

created_at__ltestring date

Example:2022-03-30

Return items that were last updated in Belvo's database before or on this date (in YYYY-MM-DD format).

created_at__rangestring[]

Return accounts that were last updated in Belvo's database between two dates (in YYYY-MM-DD format). The first value indicates the start of the range and the second value indicates the end of the range.

[
  "2022-01-01",
  "2022-12-31"
]

Response

countinteger

The total number of results in your Belvo account.

nextstring uri nullable

The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.

In our documentation example, we use {endpoint} as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, accounts or owners).

previousstring uri nullable

The URL to the previous page of results. If there is no previous page, the value is null.

Example response

{
  "count": 130,
  "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2",
  "results": [
    {
      "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"
        }
      ]
    }
  ]
}