Ir para o conteúdo

5.9. Assinantes da Nota Comercial

🔗 Endpoint

Método URL
GET /public/v1/nota-comercial/{id}/assinantes

🧾 Descrição

Retorna a lista de assinantes vinculados a uma Nota Comercial específica. Os assinantes provêm de diferentes origens: emitente, financiador e escriturador.


🔹 Path Parameter

Parâmetro Tipo Descrição
id integer Identificador único da NC

🧪 Exemplo de cURL

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

📥 Responses

✅ 200 OK

[
  {
    "id": 10,
    "nome": "João da Silva",
    "documento": "12345678901",
    "email": "joao.silva@empresaemissora.com.br",
    "telefone": "11988880000",
    "tipoAssinatura": "Eletrônica",
    "origem": "Emitente"
  },
  {
    "id": 11,
    "nome": "Maria Souza",
    "documento": "98765432100",
    "email": "maria.souza@financiadora.com.br",
    "telefone": "11977770000",
    "tipoAssinatura": "Digital",
    "origem": "Financiador"
  }
]

Detalhamento dos Campos

Campo Tipo Descrição
id integer Identificador único do assinante
nome string Nome completo
documento string CPF (somente números)
email string E-mail para envio do link de assinatura
telefone string Telefone de contato
tipoAssinatura string Tipo de assinatura eletrônica
origem string Origem do assinante: "Emitente", "Financiador" ou "Escriturador"

❌ Erros Comuns

404 Not Found

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