3.3. Esteiras¶

🧾 O que é uma Esteira?¶

A esteira é um conjunto de configurações que define o fluxo operacional de uma Nota Comercial para um determinado financiador. Ela determina:

Qual escriturador será responsável pelo registro da NC
Quais documentos serão exigidos na operação
Os parâmetros financeiros pré-configurados (limites de taxa, prazo, etc.)

Cada financiador possui uma esteira padrão e pode ter acesso a esteiras adicionais. O idEsteira é obrigatório na criação de toda Nota Comercial.

Listar Esteiras do Financiador¶

🔗 Endpoint¶

Método	URL
	`/public/v1/financiadores/{id}/esteiras`

🧾 Descrição¶

Retorna a lista de esteiras disponíveis para um financiador específico. Inclui a esteira padrão e as demais que o financiador tem permissão de utilizar.

🔹 Path Parameter¶

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

🧪 Exemplo de cURL¶

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

📥 Response — `200 OK`¶

[
  {
    "id": 10,
    "nome": "Esteira Padrão — Nota Comercial",
    "padrao": true,
    "situacao": 1,
    "idEscriturador": 1,
    "nomeEscriturador": "Escriturador Central S.A."
  },
  {
    "id": 11,
    "nome": "Esteira com Garantia Real",
    "padrao": false,
    "situacao": 1,
    "idEscriturador": 2,
    "nomeEscriturador": "Registradora Digital LTDA"
  }
]

Detalhamento dos Campos¶

Campo	Tipo	Descrição
id	integer	Identificador único da esteira — usar como `idEsteira` na criação da NC
nome	string	Nome descritivo da esteira
padrao	boolean	Indica se é a esteira padrão do financiador
situacao	integer	`1` = Ativa, `2` = Inativa
idEscriturador	integer	ID do escriturador vinculado a esta esteira
nomeEscriturador	string	Nome do escriturador

🕒 Observações¶

Utilize o id retornado neste endpoint como valor do campo idEsteira nos endpoints de criação de NC (5.3 e 5.4).
Caso o financiador possua apenas uma esteira, utilize-a diretamente.
A esteira com padrao: true é a configuração recomendada para operações convencionais.
Esteiras com situacao: 2 (Inativas) são exibidas apenas para consulta histórica e não podem ser utilizadas em novas operações.

❌ Erros Comuns¶

404 Not Found¶

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