Available templates query

This endpoint allows querying all templates available for use in the bookkeeping system.

Request

ENDPOINT

/document_generator/document_template

METHOD

GET

Query Params

Field	Type	Description	Required
document_type	string	Document type. document_type enumerators	No
page	integer	Page number (default: 1).	No
page_size	integer	Items per page (default and maximum: 100).	No

---

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

Field	Type	Description	Max Characters
name *	string	Template name.	255
document_template_key *	string	Unique template key (UUID v4). This is the value sent when creating the operation.	36
document_type *	string	Type of generated document. document_type enumerators	50
version *	integer	Current template version.	-
extra_fields *	array	Extra fields required by the template. Empty list when the template requires none. Extra fields	-

Pagination Object

Field	Type	Description
current_page *	integer	Current page of the query.
next_page	integer	Next page, if any.
rows_per_page *	integer	Number of records per page.
total_pages *	integer	Total pages available.
total_rows *	integer	Total records found for the applied filters.

---

document_type enumerators

Types used in the commercial paper issuance flow:

Value	Description
commercial_paper	Commercial paper draft.
adhesion_term	Adhesion term.
subscription_note	Subscription note.
amendment_term	Amendment term.