Criar departamento

Este endpoint permite criar um novo departamento (unidade organizacional) na empresa.

Campos obrigatórios

name: Nome. Máximo de 300 caracteres.
type: Tipo. Valores: DEPARTMENT, SECTOR, SECTIONS.
externalCode: Código externo. Máximo de 50 caracteres. Único na empresa.
description: Descrição. Máximo de 900 caracteres.
costCenter: Objeto com externalCode do centro de custo (deve existir na empresa).

Exemplo de requisição (cURL)

curl --request POST \
     --url 'https://api.gupy.io/os/v1/departments' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer bearer_token_value_here' \
     --data '{
       "name": "Produto",
       "type": "DEPARTMENT",
       "externalCode": "OU-F98",
       "description": "Departamento de produto",
       "costCenter": { "externalCode": "CC-001" }
     }'

Atenção: Forneça o token no cabeçalho Authorization.

Possíveis erros

Código externo já existente (409)

{
  "message": "An department with this external code already exists in the company"
}

Centro de custo não encontrado (422)

{
  "message": "The cost center with the provided external code was not found"
}

Updated about 16 hours ago