Descrição dos campos da chamada e retorno
Filtros que poderão ser utilizados na chamada
|
Campo |
Tipo |
Formato |
Descrição |
Observação |
|
dt |
string |
($date-time) |
Data de início |
Formato yyyy-MM-dd |
|
tipoDocumento |
String |
|
tipoDocumento |
Vide tabela Código de descrição dos tipos de documento abaixo |
|
formatarFilePadrao |
boolean |
lista |
Opções: |
Quando vazio e True envia em formato XML e quando False apresenta o binario/base64. |
|
idDocs |
String |
|
Id do Documento |
Busca específica de documento. |
|
nsuDfe |
string |
|
nsuDfe |
Campo utilizado para paginar. Informar o último NSU entregue na pagina anterior. |
|
IdCliente |
integer |
($int64) |
IdCliente |
Busca por cliente. |
Código e descrição dos tipos de documento
|
Campo |
Descrição |
|
0 - Original |
Documento original da Nota de Serviço. Podendo ser um PDF, um XML ou até mesmo um JPEG |
|
1 - Email |
Texto que veio no e-mail junto com a nota de serviço. Guardamos o texto do e-mail, pois em alguns casos, algumas informações da nota de serviço vêm direto no corpo do e-mail. |
|
2 - Extraído |
Informações em um XML, que foram extraídas do arquivo recebido, através de um processo automático que temos |
|
3 - Padrão |
Seria o arquivo final, o mesmo que estávamos enviando na versão anterior do WS. Esse arquivo pode sofrer alterações com o tempo, através de processos manuais feitos dentro do DFe. |
Tabela de referência para o campo "success" e "message"
|
Código de retorno |
sucess |
message |
Observação |
|
200 |
True |
Ok |
|
|
400 |
False |
Bad Request |
Parâmetros |
|
da solicitação incorretos. |
|||
|
404 |
False |
Not Found |
Não foram |
|
encontrados registros |
Descrição dos campos de retorno:
|
Campo |
Tipo |
Descrição |
|
nsu |
integer($int64) |
NSU doDOCs |
|
Id_docs |
integer($int64) |
ID Systax do Documento |
|
statusDocs |
string |
Código do status do documento |
|
statusDescricao |
string |
Descrição do status do documento |
|
file |
string($byte) |
Documento requisitado |
|
fileNome |
string |
Nome do Documento + extensão |
|
fileTipo |
string |
Tipo do Documento |
|
filePadrao |
string |
Documento padrão |
|
observacao |
string |
Descrição do Documento
|
O Campo "observacao" do retorno da chamada, foram mapeados com as seguintes descrições:
|
Descrição/Mensagem |
Status |
|
XML Padrão Completo |
Quando status for 800 - Concluído |
|
Documento descartado |
Quando o status for 900 - Descartado |
|
XML Padrão em Desenvolvimento |
XML Padrão em Desenvolvimento - Para todos os outros status |
Tabela de código de status de retorno (campos "código" e "mensagem")
|
Código |
Mensagem |
|
10 |
Recebido |
|
15 |
Chamada incompleta |
|
16 |
Usuário e/ou senha inválidos |
|
17 |
Captura direta de PDF |
|
20 |
Pendente de captura |
|
25 |
Identificando tipo de documento |
|
28 |
Classificando documento |
|
30 |
Conteúdo original disponível |
|
31 |
O Arquivo não foi obtido no S3 ou no disco |
|
35 |
Arquivos na fila do OCR |
|
40 |
Convertido |
|
42 |
Fila OCR Posicional |
|
45 |
Retorno OCR Posicional |
|
50 |
Pendente de identificação do padrão |
|
100 |
Tratamento Upload |
|
120 |
Aguardando melhoria de imagem |
|
150 |
Digitar |
|
155 |
Averiguar |
|
156 |
Averiguar - Anexos Iguais |
|
160 |
Extraindo Fornecedor |
|
170 |
Fornecedor Extraído |
|
180 |
Aguardando XML |
|
200 |
Dados extraídos |
|
250 |
Dados extraídos - outros documentos |
|
300 |
Documento gerado no layout padrão |
|
400 |
Documento gerado no layout do usuário |
|
404 |
Erro processamento OCR |
|
500 |
Fluxo para revisão de cancelamentos |
|
700 |
Definindo município incidência |
|
750 |
Revisar |
|
790 |
Triagem |
|
800 |
Concluído |
|
810 |
Concluído com NF cancelada |
|
850 |
Integrado a gestão do usuário |
|
900 |
Descartado |
|
910 |
Excesso de Páginas |
|
920 |
Duplicado |
|
930 |
Desacordo |
|
940 |
Sobrescrito |
|
950 |
Documentos Iguais |
|
960 |
Registro Vazio |
Obs.: Em relação ao retorno do status, nós entregamos o 800 e qualquer outro, abaixo de 800, se ficar parado por mais de 24 horas no processamento, exceto: Descartado 900 e 920.