Download OpenAPI specification:
Disponibiliza serviços para solicitação de retificações totais e parciais de GRU.
Autenticação: Requer Token JWT (Bearer). O Sistema Externo deve estar previamente cadastrado no SISGRU com permissão de retificação via Web Service concedida pelo Tesouro Nacional.
Limite por requisição: máximo de 50 GRUs por chamada.
Códigos de retorno comuns:
200 — solicitação processada com sucesso (status: "Sucesso").422 — erros de validação de negócio (status: "Erro"); os detalhes ficam no campo msg
do objeto raiz (erros globais) ou nos campos msg de cada item de GRU/parcela.500 — erro inesperado no servidor.Solicita retificações totais de GRU. Cada item representa uma GRU a ser retificada. Apenas os atributos da GRU que devem ser retificados precisam ser informados e ao menos um campo deve ser efetivamente alterado para retificar a GRU original.
| cpfOperador required | string CPF do operador solicitante. Deve conter somente dígitos, ser válido e corresponder a um usuário SIAFI. Sua UG deve pertencer ao mesmo órgão do Sistema Externo autenticado, que deve ter permissão de retificação via Web Service. |
required | Array of objects (Item de GRU) [ 1 .. 50 ] items Lista de GRUs a serem retificadas totalmente. |
{- "cpfOperador": "12345678909",
- "retificacoesTotais": [
- {
- "idGRU": "12345678901234567890",
- "ugEmitenteRA": "170500",
- "recolhimento": "18830",
- "contribuinte": "12345678901",
- "referencia": "12345",
- "competencia": "042026",
- "processo": "",
- "servico": "123",
- "vlPrincipal": "100.00",
- "vlDescontosAbatimentos": "0.00",
- "vlOutrasDeducoes": "0.00",
- "vlMoraMulta": "0.00",
- "vlJurosEncargos": "0.00",
- "vlOutrosAcrescimos": "0.00",
- "observacao": "Ajuste cadastral"
}
]
}{- "status": "Sucesso",
- "retificacoesTotais": [
- {
- "idGRU": "12345678901234567890",
- "protocolo": "1705002026PT000001",
- "situacao": "REGISTRADO"
}
]
}Solicita retificações parciais de GRU. Cada item representa uma GRU com múltiplas
parcelas, permitindo alterar campos de cada parcela individualmente.
Ao menos um campo deve ser efetivamente alterado em cada parcela para retificar a GRU original.
Obs.: Os campos de valores monetários que não forem informados na retificação parcial serão preenchidos automaticamente com zero. Por exemplo, se vlPrincipal for omitido em uma parcela, o sistema irá tratá-lo como "0.00".
| cpfOperador required | string CPF do operador solicitante. Deve conter somente dígitos, ser válido e corresponder a um usuário SIAFI. Sua UG deve pertencer ao mesmo órgão do Sistema Externo autenticado, que deve ter permissão de retificação via Web Service. |
required | Array of objects (Item de GRU) [ 1 .. 50 ] items Lista de GRUs a serem retificadas parcialmente. Não pode ser nula ou vazia. Não pode haver |
{- "cpfOperador": "12345678909",
- "retificacoesParciais": [
- {
- "idGRU": "12345678901234567890",
- "parcelas": [
- {
- "seqParcela": "1",
- "ugEmitenteRA": "170500",
- "recolhimento": "18830",
- "contribuinte": "12345678901",
- "referencia": "12345",
- "competencia": "042026",
- "processo": "12345678901234567",
- "servico": "123",
- "vlPrincipal": "60.00",
- "vlDescontosAbatimentos": "0.00",
- "vlOutrasDeducoes": "0.00",
- "vlMoraMulta": "0.00",
- "vlJurosEncargos": "0.00",
- "vlOutrosAcrescimos": "0.00",
- "vlTotal": "60.00",
- "observacao": "Parcela 1"
}, - {
- "seqParcela": "2",
- "ugEmitenteRA": "170500",
- "recolhimento": "18830",
- "contribuinte": "12345678901",
- "referencia": "12345",
- "competencia": "042026",
- "processo": "12345678901234567",
- "servico": "123",
- "vlPrincipal": "40.00",
- "vlDescontosAbatimentos": "0.00",
- "vlOutrasDeducoes": "0.00",
- "vlMoraMulta": "0.00",
- "vlJurosEncargos": "0.00",
- "vlOutrosAcrescimos": "0.00",
- "vlTotal": "40.00",
- "observacao": "Parcela 2"
}
]
}
]
}{- "status": "Sucesso",
- "retificacoesParciais": [
- {
- "idGRU": "12345678901234567890",
- "protocolo": "1705002026PP000002",
- "situacao": "REGISTRADO"
}
]
}