Importação e Conciliação de DFes na API Rest

A Importação e Conciliação de DF-es através da API Rest será permitido para o usuário que já possuir o x-auth-token. No artigo Autenticação na API Rest damos mais detalhes sobre o x-auth-token. Existem alguns Endpoints para o serviço de Importação e Conciliação de Documentos Fiscais e para cada um, há uma URL específica.

 

Importação de Documentos Fiscais (PUT)

A importação de DFes permite armazenar um documento no Monitor Oobj que foi emitido por outra solução. Esse documento fiscal pode ser o XML Proc de uma NFe, uma NFCe, um CTe ou um MDFe.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{codModelo}

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

  • {empresa} : CNPJ da Empresa
  • {ambiente} : hom ou prod
  • {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe) 
http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/55

 

 Importação de Eventos de Documentos Fiscais (PUT)

Assim como é possível importar um DF-e, é possível armazenar Eventos Fiscais relacionados a esses DF-es. Assim, caso um documento esteja cancelado, possua carta de correção e outros tipos como manifesto, é possível manter atualizado o status do documento.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{ano}/{serie}/{numero}/eventos

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

  • {empresa} : CNPJ da Empresa
  • {ambiente} : hom ou prod
  • {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe) 
  • {ano} : ano de emissão do evento;
  • {serie} : série do documento relacionado ao evento;
  • {numero} : numero do documento relacionado ao evento;
http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/55/2021/1/100/eventos

 

Envio de Informações de Vendas do ERP / PDV para Conciliação / Conferência (POST)

A Conciliação de Documentos Fiscais permite o envio de algumas informações do seu ERP / PDV para a nossa API. Esses dados enviados são guardados e são confrontados com os documentos fiscais que já estão na Oobj. Dessa forma é possível obter possíveis diferenças de Chave de Acesso, Valor da Venda e Data de Emissão, por exemplo.

Porém, para que essa integração funcione, é preciso, ao Emitir um DFe, informar no Grupo obsCont (Observações do Contribuinte) o Número do Pedido (que represente a venda no seu PDV). Veja um exemplo de preenchimento:

<obsCont xCampo="numeroPedido">
          <xTexto>36017</xTexto>
</obsCont>

 

O Número de Pedido deve ser informado na NF-e e também será enviado através desse Endpoint para a API.

Através desse serviço, além do Número de Pedido, deverá ser enviado a Data de Emissão, Chave de Acesso, Valor Total do DFe (NFe, NFCe e SAT CFe) e se a Venda foi Cancelada.

Essas informações deverão estar salvas em um arquivo CSV. O arquivo de conciliação a ser enviado deve estar com codificação UTF-8 e deve conter as seguintes colunas separadas por ponto-vírgula (;)

 

  • número do pedido: valor numérico inteiro longo com no máximo 5 dígitos (obrigatório)
  • data de emissão: data válida no formato DD-MM-AAAA HH:mm:ss (obrigatório)
  • chave de acesso: chave de acesso do documento fiscal (opcional)
  • valor: valor numérico fracionável com até duas casas decimais separadas por ponto (.) (obrigatório)
  • cancelado: flag booleano indicando se espera-se que o documento esteja cancelado ou não (obrigatório - valores permitidos [true, false, 1, 0, t, f])

 

Exemplo: conciliacao.csv

4447;2017-04-26 18:59:59;41170408186139000507650130000360961876097593;25.00;f
4445;2017-04-26 13:59:00;41170408186139000507650120000484781665531420;50.89;t
8429;2017-04-26 10:00:05;;2.00;f

 

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{codModelo}/conciliacao

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

  • {empresa} : CNPJ da Empresa
  • {ambiente} : hom ou prod
  • {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe)
http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/55/conciliacao

 

 

 

Obter comparação entre Vendas do ERP / PDV e DFes Emitidos (GET)

Após realizar o envio do arquivo CSV para Conciliação o usuário poderá obter o resultado da análise / confronto, realizado entre as vendas feitas no PDV / ERP e  os Documentos Fiscais que foram emitidos. Dessa forma, poderá ser identificado possíveis diferenças entre os dados do PDV e do Monitor Oobj.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/{ambiente}/{codModelo}/conciliacao/{data} 

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

  • {empresa} : CNPJ da Empresa
  • {ambiente} : hom ou prod
  • {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe)
  • {data} : Data da conciliação no formato AAAA-MM-DD
http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/hom/55/conciliacao/2018-03-26

 

Para realizar testes com a API Rest, e ter mais detalhes sobre a Importação e Conciliação de DF-es, acesse a documentação completa através dos links:

0 (0)
Avaliação do Artigo (Nenhum voto)
Avaliar esse artigo
Anexos
Não há anexos para este artigo.
Artigos Relacionados RSS Feed
Manutenção de CSC (Código de Segurança do Contribuinte) na API Rest
Visualizado 2727 vezes desde 16/03/2018
Integração API Rest
Visualizado 10810 vezes desde 09/03/2018
Consultar MDF-e não encerrado via API Rest
Visualizado 409 vezes desde 23/08/2021
Emissão de Eventos Fiscais na API Rest
Visualizado 2575 vezes desde 16/03/2018
Criar Aplicativo no Monitor Oobj
Visualizado 1683 vezes desde 12/04/2018
Gerenciamento de Empresas na API Rest
Visualizado 1248 vezes desde 16/03/2018
Configurar MDe na Api Rest
Visualizado 1399 vezes desde 27/09/2018
Inutilização de Numeração na API Rest
Visualizado 2493 vezes desde 16/03/2018
Geração de chave AC (Assinatura do Contribuinte) para SAT na API Rest
Visualizado 5634 vezes desde 26/12/2019
Emissão de DFes na API Rest
Visualizado 3835 vezes desde 13/03/2018
Comentários
Nome
Email
Código de Segurança Security Code
Não há comentários para este artigo. Seja o primeiro a postar um comentário.