Skip to main content
POST
Force a return-file generation

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
institutionId
string
required

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

Example:

"44444444-4444-4444-4444-444444444444"

Response

OK

generated
boolean
required

Whether this run created a new return file.

Example:

true

recordCount
integer<int64>
required

The number of records in the generated file.

Example:

42

environment
string

The resolved SISBAJUD environment.

Example:

"production"

fileHash
string

The file content hash.

Example:

"sha256:abc123..."

fileName
string

The generated file name.

Example:

"retorno-2026-07-14.txt"

fileType
string

The SISBAJUD file-type code.

Example:

"RETORNO"

generationDate
string

The RFC3339 generation timestamp.

Example:

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

id
string

The generated file id.

Example:

"dddddddd-dddd-dddd-dddd-dddddddddddd"

status
string

The file status.

Example:

"GENERATED"