These docs are for v5.0. Click to read the latest docs for v7.0.

Obter as versões de documento

Para que serve?

Serve para consultar todas as versões existentes de um documento.

Quando usar?

Este serviço geralmente é utilizado para consultar as versões que existem para um documento.

Como usar?

Na chamada do serviço é preciso passar o código do tipo do documento (templateId) e o código do documento (documentId).

Esse serviço só pode ser executado pelo usuário que tenha permissão ao tipo de documento (template).

O código do documento (documentoId) é obtido no momento da inclusão do documento. Caso não tenha essa informação, é possível consultar através do serviço Listar documentos.

O retorno da execução será a identificação do documento com todas as versões e suas informações listadas de forma paginada. Desta forma, na chamada dele podem ser informadas a página e a quantidade de itens por página, que é limitado a 100 itens. Quando não informada a página, são retornados os itens referente a primeira página. Caso não seja informada a quantidade de itens por página, serão retornados 20 itens por página.

Para consultar todos os detalhes, utilize o link abaixo para acessar a documentação técnica.

Link da API

VersõesLinkRelease InicialRelease FinalStatus
v1Documentação Técnica5.70 RTM 1.00🟢

🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada