API - Métodos de documentos - V2 | Themis

Limitações:

O campo nomeArquivo é limitado em 120 caracteres.
O campo nomeArquivoOrigem é limitado em 99 caracteres.
Caracteres especiais ou espaços não são aceitos.
Os campos de id devem enviar obrigatoriamente números inteiros.

Inserir documento

Path: /api/v2/documentos
Método: POST

Deve-se utilizar no formato form-data

Campo	Tipo	Descrição
entidade*	String	Identificador principal da entidade ou tipo de registro.
idEntidade*	Integer	Código ou ID único da entidade principal.
idDesdobramento	Integer	Código que indica o desdobramento, subdivisão ou categoria da entidade.
idTipoDocumento*	Integer	Código que identifica o tipo de documento associado a esta despesa.
arquivo*	String	Caminho ou URI do arquivo associado ao registro (e.g., comprovante, nota).
titulo	String	Título ou breve descrição formal do registro.
data	Date (YYYY-MM-DD)	Data de ocorrência ou registro da despesa.
descricao	String	Descrição detalhada ou notas sobre a despesa.

Editar documento

Path: '/api/v2/documentos/{idDocumento}'
Método: PUT

Deve-se utilizar no formato form-data

Editar documento (exemplo):

Campo	Tipo	Descrição
idTipoDocumento*	Integer	Código que identifica o novo tipo de documento associado.
arquivo	String	Novo caminho ou URI do arquivo associado.
titulo	String	Novo título ou breve descrição formal do registro.
descricao	String	Nova descrição detalhada ou notas sobre a despesa.
data	Date (YYYY-MM-DD)	Nova data de ocorrência ou registro.

Listar documentos

Lista os documentos com possibilidade de filtrar por entidade relacionada, idEntidade, idTipoDocumento

Path: api/v2/documentos

Método: GET

Query params

Campo	Tipo	Descrição
entidade	String	Identificador principal da entidade, indicando um registro avulso.
idEntidade	Integer	Código ou ID único da entidade principal (possivelmente 1 neste caso).
idTipoDocumento	Integer	Código que identifica o tipo de documento associado a este registro avulso.

Lista todos os documentos de um registro específico. JSON retornado (exemplo):

{
    "content": [
        {
            "id": 14,
            "titulo": "Untitled",
            "nomeArquivo": "Untitled.png.png",
            "tamanho": "0,71",
            "dataCadastro": "2025-10-20T18:48:03.867+00:00",
            "tipoDocumento": {
                "id": 4,
                "nome": "Carta"
            },
            "resumoEntidade": "avulso"
        }
    ],
    "pageable": {
        "sort": {
            "empty": true,
            "sorted": false,
            "unsorted": true
        },
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 25,
        "paged": true,
        "unpaged": false
    },
    "totalElements": 1,
    "totalPages": 1,
    "last": true,
    "size": 25,
    "number": 0,
    "sort": {
        "empty": true,
        "sorted": false,
        "unsorted": true
    },
    "numberOfElements": 1,
    "first": true,
    "empty": false
}

Retorna documento específico

Path: '/api/v2/documentos/{idDocumento}'

Método: GET

Retorna as informações de um documento específico. JSON retornado (exemplo):

{
    "id": 17,
    "titulo": "Untitled",
    "nomeArquivo": "Untitled.png.png",
    "tamanho": "0,71",
    "dataCadastro": "2025-10-22T02:25:42.758+00:00",
    "tipoDocumento": {
        "id": 2,
        "nome": "Ata"
    },
    "entidade": "Processo",
    "resumoEntidade": "AUR-000001 - Trabalhista - Aurum Software - Aurum Software x Matheus Faraco - 1020628-95.2021.8.26.0021",
    "idEntidade": 1,
    "idDesdobramento": 1
}