Force a return-file generation
Forces one return-file generation for the institution in the path and returns the generated file’s summary. A malformed institutionId is 400; a caller without the role is 403; an institution not configured with an institution_code is 422; a missing reception flow fails closed with 503.
Autorizações
JWT bearer token issued by the identity provider.
Parâmetros de caminho
The institution the return file is generated for (UUID). Authorized by the caller's RBAC role.
"44444444-4444-4444-4444-444444444444"
Resposta
OK
The number of response groups whose answer failed in this run. Non-zero with generated=true is a partial failure: the generated files stand and the failed groups are retried by the next run.
0
Whether this run created a new return file.
true
The number of return files created by this run. A remittance whose answer matches an existing file is stamped onto that file and creates none. The fields above describe the newest one.
3
The number of records in the generated file.
42
The resolved SISBAJUD environment.
"production"
The file content hash.
"sha256:abc123..."
The generated file name.
"retorno-2026-07-14.txt"
The SISBAJUD file-type code.
"RETORNO"
The RFC3339 generation timestamp.
"2026-07-14T12:00:00Z"
The generated file id.
"dddddddd-dddd-dddd-dddd-dddddddddddd"
The file status.
"GENERATED"

