| Índice |
|---|
Objetivo
Este documento tem como objetivo orientar a construção dos webservices para apresentação de declarações, comumente utilizados para ara declarações de Carta de Quitação e Declaração anual de Imposto de Renda, INSS, e também pode ser utilizado para exibição de outros tipos de documentos.
...
| Abreviação | Nome | Descrição |
|---|---|---|
| M | Mandatório | O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado. |
| C | Condicional | O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado. |
| OP | Opcional | Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array |
...
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/listarDeclaracoes
| POST | application/json | Endpoint que retorna lista de débitos relacionados ao localizador |
Parâmetros de entrada
...
Request body
...
| Nota |
|---|
...
Request body
| Bloco de código | |
|---|---|
|
...
chaveBeneficiario
...
String
...
Chave única do beneficiário no seu sistema de gestão
| |
| No corpo da requisição serão enviadas as informações do atributo integração do retorno do login. |
Objetos e atributos de retorno
...
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/declaracaoPdf
| POST | application/json | Endpoint que retorna uma URL ou um campo BASE64 contendo o arquivo PDF da declaração |
...