Advanced Search
Search Results
75 total results found
Introdução
Essa API tem por objetivo validar documentos fiscais e gerar um resultado em JSON.
Acesso
Comunicação: REST/JSONListagem dos Endpoints que contemplam o manual da API de Diagnóstico Fiscal Descrição Versão Método URL Endpoint URL Token Importar os arquivos v1 Post https://api-gateway.systax.com.br/p...
Autenticação
A autenticação nas API´s mencionadas nesse documento, é feita via bearer token.
Descrição dos campos de chamada - API Upload
O campo "id_empresa" é passado como parâmetro na URL: Campo PAI Descrição Tipo Obrigatório id_empresa / Código da empresa Inteiro Não No body da URL é feito a importação dos arquivos com o seguinte formato: Arquivos NF-e: é n...
Descrição dos campos de retorno - API Upload
Campo PAI Descrição Tipo sucesso / Código do retorno Boolean mensagem / Mensagem do retorno String nome_arquivo dados Identificador do arquivo importado (*.zip) String status dados Status do processamento do arquivo (Upl...
Exemplos de chamada - API Upload
Parâmetros da requisição: Corpo da requisição:
Exemplos de retorno - API Upload
{ "sucesso": true, "mensagem": null, "dados": { "nome_arquivo": "a5c9f73f-37a4-42b0-b933-58b2f2744f23.zip", "status": "Finalizado", "mensagem_erro": null, "config_blob": "empresateste" } }
Descrição dos campos de chamada - API de listagem
Os campos "id_empresa", "offset" e "limit" são passados como parâmetros na URL: Campo PAI Descrição Tipo Obrigatório id_empresa / Código da empresa Inteiro Sim offset / Deslocamento Inteiro Sim limit / Quantidade de registro...
Descrição dos campos de retorno - API de listagem
Campo PAI Descrição Tipo data / / / id_config data ID de consulta. Usado na consulta do resultado. Int32 identificador data Identificador do arquivo importado (*.zip) String status_processamento data Arqu...
Exemplos de chamada - API de listagem
Parâmetros da requisição:
Exemplos de retorno - API de listagem
{ "id_config": 202550, "identificador": "1ffffa76-f812-4f43-a31d-6a14239acd3b.zip", "status_processamento": "Finalizado", "resultados": "https://enginefiscal.blob.core.windows.net/produtos/relatorios/202550-1ffffa7...
Descrição dos campos de chamada - API de resultado
Campo PAI Descrição Tipo Obrigatório id_empresa / Código da empresa Inteiro Não id_config / ID da consulta (gerado no retorno da API de listagem) Inteiro Não continuation_token / Ponteiro utilizado para paginação....
Descrição dos campos de retorno - API de resultado
Campo PAI Descrição Tipo continuationToken / Ponteiro utilizado para paginação String data / Resultado em formato JSON / success / Status do retorno Boolean message / Mensagem do retorno String re...
Exemplos de chamada - API de resultado
Corpo da requisição:
Exemplos de retorno - API de resultado
{ "continuationToken": null, "data": [ { "id": "1f4232dd-330c-4c49-bebf-bc5b1f649602", "id_nfe": 1, "id_item": 1, "id_lote": 78536, "lote_nome": "Outros", "id_config": 203002, ...