Retrieve employments for a link
POST {{baseUrl}}/api/br/employments/
Retrieve employments from an existing link.
We highly recommend using the
X-Belvo-Request-Mode: async
header to make your POST request to retrieve invoices asynchronous (thus preventing timeouts).
When you make a asynchronous request, Belvo responds with a
202 - Accepted
payload, including the
request_id
. Once we have retrieved the invoice information, you will receive a
new_employments_available
webhook with the link and request IDs.
Request Body
{"link"=>"uuid"}
HEADERS
| Key | Datatype | Required | Description |
| X-Belvo-Request-Mode
| string | | Recommended header parameter to make your POST request to retrieve invoices asynchronous (thus preventing timeouts). |
RESPONSES
status: Created
[{"id":"fb7f01eb-99ca-409f-8fcd-3cf0d0452e1d","link":"2ccd5e15-194a-4a19-a45a-e7223c7e6717","created_at":"2020-04-23T21:32:55.336854+00:00","collected_at":"2020-04-23T21:32:55.336854+00:00","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"},{"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":50.94,"month":"2022-01","currency":"BRL"},{"base_amount":1033.09,"retained_amount":50.94,"month":"2022-01","currency":"BRL"}]},{"id":"3a825c09-91ed-4ccb-b48f-4056eed27e9b","link":"2ccd5e15-194a-4a19-a45a-e7223c7e6717","created_at":"2020-04-23T21:32:55.336854+00:00","collected_at":"2020-04-23T21:32:55.336854+00:00","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"},{"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":50.94,"month":"2022-01","currency":"BRL"},{"base_amount":1033.09,"retained_amount":50.94,"month":"2022-01","currency":"BRL"}]}]