Consulta de templates disponíveis

Este endpoint permite a consulta de todos os templates disponíveis para serem utilizados no sistema de escrituração.

Request

ENDPOINT

/document_generator/document_template

MÉTODO

GET

Query Params

Campo	Tipo	Descrição	Obrigatório
document_type	string	Tipo do documento. Enumeradores document_type	Não
page	integer	Número da página (padrão: 1).	Não
page_size	integer	Itens por página (padrão e máximo: 100).	Não

---

Response

STATUS

200

Response Body

{
  "data": [
    {
      "name": "NC - Padrão",
      "document_template_key": "7668cf4a-e19a-4f94-b209-8186909ea650",
      "document_type": "commercial_paper",
      "version": 1,
      "extra_fields": []
    },
    {
      "name": "TA Sandbox",
      "document_template_key": "2165ba90-99c8-442a-9dc3-3f651a08c113",
      "document_type": "adhesion_term",
      "version": 1,
      "extra_fields": []
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "rows_per_page": 100,
    "total_pages": 1,
    "total_rows": 2
  }
}

Response Body Params

Campo	Tipo	Descrição	Caracteres Máx.
name *	string	Nome do template.	255
document_template_key *	string	Chave única do template (UUID v4). É o valor enviado no cadastro da operação.	36
document_type *	string	Tipo do documento gerado a partir do template. Enumeradores document_type	50
version *	integer	Versão atual do template.	-
extra_fields *	array	Campos extras exigidos pelo template. Lista vazia quando o template não exige nenhum. Campos extras	-

Objeto Pagination

Campo	Tipo	Descrição
current_page *	integer	Página atual da consulta.
next_page	integer	Próxima página, caso exista.
rows_per_page *	integer	Número de registros por página.
total_pages *	integer	Total de páginas disponíveis.
total_rows *	integer	Total de registros encontrados para os filtros aplicados.

---

Enumeradores document_type

Tipos utilizados no fluxo de emissão de nota comercial:

Valor	Descrição
commercial_paper	Minuta da nota comercial.
adhesion_term	Termo de adesão.
subscription_note	Boletim de subscrição.
amendment_term	Termo de aditamento.