Criar área

Campos obrigatórios

• name: Nome da área. Máximo de 300 caracteres.
• externalCode: Código externo. Máximo de 50 caracteres. Deve ser único na empresa.
• similarity: Similaridade da área (ex.: ACCOUNTING, PRODUCT, HUMAN_RESOURCES, TECHNOLOGY).

Campos opcionais

• description: Descrição. Máximo de 900 caracteres.
• organizationUnit: Referência ao departamento por uuid e/ou externalCode (pelo menos um). Se ambos forem enviados, uuid tem prioridade.
• costCenter: Referência ao centro de custo por uuid e/ou externalCode (pelo menos um). Se ambos forem enviados, uuid tem prioridade.

Validações

• Campos obrigatórios não podem ser vazios.
• externalCode não pode já existir para outra área na mesma empresa.
• Referências aninhadas devem existir na empresa.

Exemplo de requisição (cURL)

curl --request POST \
     --url 'https://api.gupy.io/os/v1/areas' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer bearer_token_value_here' \
     --data '{
       "name": "Produto Digital",
       "externalCode": "A-F98",
       "similarity": "PRODUCT",
       "description": "Área de produto",
       "organizationUnit": { "externalCode": "OU-001" },
       "costCenter": { "externalCode": "CC-001" }
     }'

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

Possíveis erros

Erro de validação (400)

{
  "statusCode": 400,
  "message": "Validation failed",
  "errors": [
    { "code": "ValidationError", "target": "name", "message": "name should not be empty" }
  ]
}

Não autenticado (401)

Token ausente ou inválido.

Código externo já existente (409)

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

Referência não encontrada (422)

Departamento ou centro de custo informado não existe.