Objetivo
Este documento tem como objetivo explicar o funcionamento da integração das Notas Fiscais.
Pré-Requisitos e Restrições
- Necessário a instalação do serviço winthor-fiscal. (Versão >= 1.0.32.2 )
Integração
A integração consiste em enviar o XML da nota fiscal referente ao número do pedido e/ou da transação informados.
Os dados integrados são:
INVOICEDOCUMENT | PCDOCELETRONICO | |
---|---|
API | Referência Winthor |
orderId | pcpedc.numped |
transactionId | pcnfsaid.numtransvenda |
invoiceXml | pcdoceletronico.xmlnfe |
Exemplo do envio da requisição:
URI
method: 'GET', url: '/winthor/fiscal/v1/documentosfiscais/nfe/invoiceDocument'
Header
Content-Type : application/json Accept : application/json
Params
orderId : 0 - Número do pedido referente a nota fiscal a que se deseja consultar o xml. (Caso não preenchido deve-se preencher o transactionId); transactionId : 0 - Parâmetro Opcional uso interno - Número da transação referente a nota fiscal a que se deseja consultar o xml. (Caso não preenchido deve-se preencher o orderId); returnBase64 : true/false - Refere-se a solicitar que o retorno esteja codificado no padrão "Base 64". (Não é um parâmetro obrigatório e o padrão é "false");
Exemplo JSON da resposta:
Body Response
{ "invoiceXml": "string" }
Caso informado o parâmetro returnBase64 : true
Body Response
{ "invoiceXml": "<XML referente a nota fiscal codificado em Base64>" }
Tratamento de Exceção ao realizar a requisição
1) Parâmetros não informados
- Caso nenhum dos parâmetros (orderId e/ou transactionId) tenham sido informados, deve-se retornar o json abaixo;
Parâmetros não informados
{ "mensagem": "Não foi possível obter o XML. Número do pedido ou da transação não informados.", "erros": [] }
2) Parâmetros informados, porém inválidos ou não relacionados:
- Caso o número do pedido não exista na base de dados do Winthor;
- Caso o número da transação não exista na base de dados do Winthor;
- Caso o número do pedido e o número da transação tenham sido informados como parâmetro, sejam válidos, mas não estão relacionados a mesma nota fiscal;
- Caso a nota fiscal não esteja com o status 100 ou 150;
Parâmetros informados, porém inválidos ou não relacionados
{ "mensagem": "Não foi possível encontrar uma nota fiscal vinculada ao pedido e/ou transação informados. Número do pedido: <orderId>; Número da transação: <transactionId>; ", "erros": [] }
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas