Módulo Empresas

Gerencie as empresas vinculadas à sua conta, bem como suas divisões (hierarquia nível 1) e subdivisões (hierarquia nível 2). Veículos e condutores são sempre associados a uma empresa.

Listar empresas

GET /key/companies

curl -X GET \
  'https://apidev.v1.frota162.com.br/key/companies?per_page=50' \
  -H 'Authorization: Basic SEU_ACCESS_TOKEN' \
  -H 'Key: SUA_ASSINATURA_HMAC'

Resposta

{
  "companies": [
    {
      "id": 1,
      "name": "Transportadora XYZ Ltda",
      "fantasy_name": "Transportadora XYZ",
      "doc": "00.000.000/0001-00"
    }
  ],
  "error": false,
  "code": "fbk_200"
}

Criar empresa

POST /key/create-company

curl -X POST \
  https://apidev.v1.frota162.com.br/key/create-company \
  -H 'Authorization: Basic SEU_ACCESS_TOKEN' \
  -H 'Key: SUA_ASSINATURA_HMAC' \
  -H 'Content-Type: application/json' \
  -d '{
    "cnpj": "00000000000100",
    "name": "Transportadora XYZ Ltda",
    "fantasy_name": "Transportadora XYZ"
  }'

Campos

Campo	Tipo	Obrigatório	Descrição
cnpj	string	Sim	CNPJ da empresa (somente números)
name	string	Não	Razão social
fantasy_name	string	Não	Nome fantasia
address	string	Não	Logradouro
address_number	string	Não	Número
address_comp	string	Não	Complemento
district	string	Não	Bairro
city	string	Não	Cidade
state	string	Não	UF (ex: SP)
zip_code	string	Não	CEP (somente números)
email	string	Não	E-mail de contato
phone_1	string	Não	Telefone principal
phone_2	string	Não	Telefone secundário

Resposta

{
  "company": {
    "id": 1,
    "name": "Transportadora XYZ Ltda",
    "fantasy_name": "Transportadora XYZ",
    "doc": "00000000000100",
    "address": null,
    "city": null,
    "state": null,
    "zip_code": null,
    "email": null,
    "phone_1": null,
    "phone_2": null,
    "account_id": 10,
    "created_at": "2024-01-15T10:00:00.000Z"
  },
  "error": false
}

Erros comuns

Código	Descrição
fbk_400	CNPJ já cadastrado
fbk_004	CNPJ inválido
fbk_001	Usuário não encontrado

Desativar empresa

DELETE /key/disable-company/{id_company}

curl -X DELETE \
  https://apidev.v1.frota162.com.br/key/disable-company/1 \
  -H 'Authorization: Basic SEU_ACCESS_TOKEN' \
  -H 'Key: SUA_ASSINATURA_HMAC'

Resposta

{
  "message": "Empresa desabilitada com sucesso",
  "error": false,
  "code": "fbk_200"
}

Reativar empresa

GET /key/enable-company/{id_company}

curl -X GET \
  https://apidev.v1.frota162.com.br/key/enable-company/1 \
  -H 'Authorization: Basic SEU_ACCESS_TOKEN' \
  -H 'Key: SUA_ASSINATURA_HMAC'

Divisões (hierarquia nível 1)

Divisões são empresas filiais de nível 1. Use os IDs retornados aqui ao criar veículos com o campo divisao.

GET /key/divisions

curl -X GET \
  'https://apidev.v1.frota162.com.br/key/divisions?page=1&limit=10' \
  -H 'Authorization: Basic SEU_ACCESS_TOKEN' \
  -H 'Key: SUA_ASSINATURA_HMAC'

Resposta

{
  "divisions": [
    {
      "id": 123,
      "name": "Filial São Paulo",
      "fantasy_name": "SP",
      "doc": "00.000.000/0002-00",
      "active": true,
      "hierarchy_level": 1
    }
  ],
  "error": false,
  "code": "fbk_200"
}

Subdivisões (hierarquia nível 2)

Subdivisões são empresas filiais de nível 2. Use os IDs retornados aqui ao criar veículos com o campo subdivisao.

GET /key/subdivisions

curl -X GET \
  'https://apidev.v1.frota162.com.br/key/subdivisions?page=1&limit=10' \
  -H 'Authorization: Basic SEU_ACCESS_TOKEN' \
  -H 'Key: SUA_ASSINATURA_HMAC'

Resposta

{
  "subdivisions": [
    {
      "id": 789,
      "name": "Setor Operacional SP",
      "fantasy_name": "Operacional",
      "doc": "00.000.000/0003-00",
      "active": true,
      "hierarchy_level": 2
    }
  ],
  "error": false,
  "code": "fbk_200"
}

Divisões em veículos

Ao criar ou atualizar um veículo, use os campos divisao (ID de divisão) e subdivisao (ID de subdivisão) para organizar o veículo na hierarquia da empresa. Consulte o Módulo Veículos para detalhes.

---