Ir para o conteúdo

4.1. Listar e Consultar Emitentes

Listar Emitentes

🔗 Endpoint

Método URL
GET /public/v1/emitentes

🧾 Descrição

Retorna a lista paginada de emitentes disponíveis. Caso a chave de acesso pertença a um parceiro, apenas os emitentes vinculados ao parceiro serão retornados.

📋 Query Parameters

Parâmetro Tipo Obrigatório Descrição
pagina integer Não Número da página (padrão: 1)
quantidade integer Não Registros por página (padrão: 10, máx: 100)
busca string Não Filtro por razão social ou CNPJ

🧪 Exemplo de cURL

curl -X GET "https://api.vehub.com.br/public/v1/emitentes?pagina=1&quantidade=10" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Response — 200 OK

{
  "registros": [
    {
      "id": 1,
      "razaoSocial": "Empresa Emissora LTDA",
      "documento": "12345678000199",
      "situacao": 1
    }
  ],
  "paginacao": {
    "paginaAtual": 1,
    "paginaTotal": 3,
    "paginaQuantidadeRegistro": 10,
    "quantidadeRegistros": 25,
    "temProximaPagina": true,
    "temPaginaAnterior": false
  }
}

Detalhamento dos Campos — registros[]

Campo Tipo Descrição
id integer Identificador único do emitente
razaoSocial string Razão social
documento string CNPJ (somente números)
situacao integer 1 = Ativo, 2 = Inativo

Consultar Emitente

🔗 Endpoint

Método URL
GET /public/v1/emitentes/{id}

🧾 Descrição

Retorna os dados completos de um emitente específico.

🔹 Path Parameter

Parâmetro Tipo Descrição
id integer Identificador único do emitente

🧪 Exemplo de cURL

curl -X GET https://api.vehub.com.br/public/v1/emitentes/1 \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Response — 200 OK

{
  "id": 1,
  "razaoSocial": "Empresa Emissora LTDA",
  "documento": "12345678000199",
  "situacao": 1,
  "email": "financeiro@empresaemissora.com.br",
  "telefone": "11999990000",
  "dataFundacao": "2010-03-15",
  "site": "https://www.empresaemissora.com.br",
  "idRamoAtividade": 5,
  "numeroProximaEmissao": 3,
  "serieEmissao": "A",
  "endereco": {
    "endereco": "Rua das Empresas",
    "cep": "01310100",
    "numero": "200",
    "complemento": "Andar 10",
    "bairro": "Centro",
    "cidade": "São Paulo",
    "uf": "SP"
  },
  "contaCorrente": {
    "id": 10,
    "idBanco": 341,
    "agencia": "0001",
    "conta": "12345-6"
  }
}

Detalhamento dos Campos

Campo Tipo Descrição
id integer Identificador único
razaoSocial string Razão social da empresa
documento string CNPJ (somente números)
situacao integer 1 = Ativo, 2 = Inativo
email string E-mail do emitente
telefone string Telefone (somente números)
dataFundacao string Data de fundação (YYYY-MM-DD)
site string URL do site
idRamoAtividade integer ID do ramo de atividade (ver Enumerações)
numeroProximaEmissao integer Número da próxima emissão de NC
serieEmissao string Série da emissão
endereco object Dados de endereço
contaCorrente object Dados da conta corrente principal

❌ 404 Not Found

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
  "titulo": "Não encontrado",
  "status": 404,
  "erros": ["Emitente não encontrado."]
}