Pular para o conteúdo principal
POST
Forçar a geração de um arquivo de retorno

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json
institutionId
string
obrigatório

The institution the return file is generated for (UUID).

Exemplo:

"44444444-4444-4444-4444-444444444444"

Resposta

OK

generated
boolean
obrigatório

Whether this run created a new return file.

Exemplo:

true

recordCount
integer<int64>
obrigatório

The number of records in the generated file.

Exemplo:

42

environment
string

The resolved SISBAJUD environment.

Exemplo:

"production"

fileHash
string

The file content hash.

Exemplo:

"sha256:abc123..."

fileName
string

The generated file name.

Exemplo:

"retorno-2026-07-14.txt"

fileType
string

The SISBAJUD file-type code.

Exemplo:

"RETORNO"

generationDate
string

The RFC3339 generation timestamp.

Exemplo:

"2026-07-14T12:00:00Z"

id
string

The generated file id.

Exemplo:

"dddddddd-dddd-dddd-dddd-dddddddddddd"

status
string

The file status.

Exemplo:

"GENERATED"