Histórico da Página
| Nota |
|---|
Api em construção e sujeita a alterações |
Fluxo de utilização de API
draw.io Diagram border true diagramName fluxo_api_informe simpleViewer false width links auto tbstyle top lbox true diagramWidth 786 revision 3
| border | true |
|---|---|
| diagramName | fluxo_api_informe |
| simpleViewer | false |
| width | |
| links | auto |
| tbstyle | top |
| lbox | true |
| diagramWidth | 786 |
| revision | 3 |
Endpoint: Consulta de Informe
Caminho: /api/v1/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
Método: GET
Content Type: JSON
QueryString:
- nomeArq: nome do arquivo
- page: página da paginação
- size: tamanho de página
| Painel | |||||
|---|---|---|---|---|---|
| |||||
200 - OkContent Type: application/json Corpo
|
| Painel | |||||
|---|---|---|---|---|---|
| |||||
40X - Erro RequisiçãoContent Type: application/json Corpo:
|
| Painel | |||||
|---|---|---|---|---|---|
| |||||
500 - Erro InternoContent Type: application/json Corpo:
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas