POST
/
v1
/
employments
curl --request POST \
  --url https://api.base39.io/v1/employments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "working",
  "grossSalary": 49999.5,
  "netSalary": 49999.5,
  "hiredAt": "2023-12-25",
  "limitPerInstallment": 123,
  "limitPerLoan": 123,
  "customer": {
    "document": "<string>",
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "birthDate": "<string>",
    "externalId": "<string>"
  },
  "company": "comp_62d9889bd3985729e5a048ef",
  "role": "Desenvolvedor",
  "description": "<string>",
  "date": "2023-12-25",
  "severancePayment": 123,
  "transferredTo": "comp_62d9889bd3985729e5a048ef",
  "metadata": {}
}'
{
  "id": "empl_5f92f01728e009f403d8502e",
  "status": "working",
  "grossSalary": 49999.5,
  "netSalary": 49999.5,
  "hiredAt": "2023-12-25",
  "limitPerInstallment": 123,
  "limitPerLoan": 123,
  "customer": {
    "document": "<string>",
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "birthDate": "<string>",
    "externalId": "<string>"
  },
  "company": "comp_62d9889bd3985729e5a048ef",
  "role": "Desenvolvedor",
  "description": "<string>",
  "date": "2023-12-25",
  "severancePayment": 123,
  "transferredTo": "comp_62d9889bd3985729e5a048ef",
  "transferredFrom": "comp_62d9889bd3985729e5a048ef",
  "expiredAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false,
  "houseTime": 12,
  "eligible": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

Query Parameters

​
expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

​
fields
string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Body

application/json

Criar um vínculo empregatício

Response

201 - application/json

Retorna o objeto Employment se a criação for bem-sucedida. Retorna um erro se os parâmetros de criação forem inválidos (por exemplo, especificar um documento inválido).

Este objeto representa um vínculo empregatício.