Histórico da Página
| Nota |
|---|
Api em construção e sujeita a alterações |
...
|
Fluxo de utilização de API
...
Endpoint: Consulta de Informe
Caminho: /api/v1
...
Consulta de informe
...
/informe
Método: GET
Content Type: JSON (application/json) ou PDF (application/pdf)
- Será alterado dependendo do header Accept
QueryString:
- numeroDocumento: CPF ou CNPJ cliente
- competencia: competência (MMAAAA) - Para anual, enviar mês "13"
- periodo: A (anual), T (trimestral
...
- )
...
- empresa: código de empresa
Retornos
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Endpoint: Consulta Status Importação
Caminho: /api/v1/informe/importacao
Método: GET
Content Type: JSON
QueryString:
- nomeArq: nome do arquivo
| Painel | |||||
|---|---|---|---|---|---|
| |||||
200 - OkContent Type: application/json Corpo
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
| Painel | ||||
|---|---|---|---|---|
| ||||
40X - Erro |
RequisiçãoContent Type: application/json Corpo:
|
| Painel | |||||
|---|---|---|---|---|---|
| |||||
500 - Erro InternoContent Type: application/json Corpo:
|
Endpoint: Consulta
...
erros Importação
...
Caminho: /api/v1/informe/
...
relatorio/erro
Método: GET
Content Type: JSON
QueryString:
- nomeArq: nome do arquivo
...
- tipoProcesso: Informar "I" para importação
- page: página da paginação
- size: tamanho de página
| Painel | |||||
|---|---|---|---|---|---|
| |||||
200 - OkContent Type: application/json Corpo
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
| Painel |
|---|
Retornos
202 - Aceito: Processamento assíncrono Iniciado
Content Type: text/plain
...
| ||||
40X - Erro |
...
RequisiçãoContent Type: application/json Corpo:
|
| Painel | |||||
|---|---|---|---|---|---|
| |||||
500 - Erro InternoContent Type: application/json Corpo:
|