Changes for page Nota Fiscal - Obter XML ou Danfe

Last modified by WBS Tecnologia on 2021/10/04 12:05

From version < 14.1 >

edited by WBS Tecnologia
on 2021/05/21 19:56

To version < 19.1 >

edited by WBS Tecnologia
on 2021/09/27 19:37

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Pedidos - Enviar um Pedido
++Nota Fiscal - Obter XML ou Danfe

Content

@@ -2,9 +2,9 @@
  (((
  (% class="container" %)
  (((
--= Inserir um Pedido na Plataforma =
++= Obter o Danfe/XML da Nota Fiscal =
--Neste Método vamos descrever como Inserir um Pedido na Plataforma.
++Este método possibilidade que o cliente obtenha o XML ou o PDF (DANFE) da Nota Fiscal Elatronica.
  )))
  )))
@@ -16,17 +16,17 @@
  (% class="box infomessage" %)
  (((
--Rota:/BDIApi/Pedido/Salvar
++Rota:/BDIApi/NotaFiscalAsset/Obter?id={CHAVE_DE_ACESSO}&tipo={TIPO}
  )))
  * Parâmetros:
  * Requer Autenticação: **Sim **
  * Método: **POST**
--* Tipo de Retorno**:  Void | Pedido**
++* Tipo de Retorno**:  OK | Erro**
  * Headers:
  ** API_TOKEN: Token de Autenticação
  * Corpo/Payload
--** JSON do Pedido
++** Conteudo do PDF ou Danfe da Nota Fiscal Eletrônica
  == Códigos de Status ==
@@ -37,8 +37,16 @@
  = Detalhes da Ação =
--Insere um Pedido na Plataforma
++Recupera o Danfe ou o XML da Nota Fiscal Eletronica
++**Esta rota somente suporta o envios de PDFs**
++
++=== Query String / Parametros ===
++
++|=Header|=Descrição / Validação|=Valores
++|{CHAVE_DE_ACESSO}|Chave de Acesso da Nota, pode ser obtido no campo "ChaveNFE" do Pedido.|
++|{TIPO}|Tipo do Arquivo|Danfe ou XML
++
  === (% style="font-size:26px" %)Headers(%%) ===
  Abaixo segue os headers que devem ou podem ser passados para a ação:
@@ -46,124 +46,31 @@
  |=Header|=Descrição / Validação|=Valor Padrão
  |API_TOKEN|[Obrigatório] Token da Autenticação|
--== (% style="font-size:29px" %)Corpo(%%) ==
++== (% style="font-size:29px" %)Resposta(%%) ==
--Este é o Payload do corpo, este JSON representa o pedido a ser inserido na plataforma:
++A Resposta será o conteudo do arquivo XML ou PDF da Danfe da Nota Fiscal Eletrônica ou **404 se o arquivo não existir**.
--{{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
--{
-- "Cabecalho": {
--  "Codigo": 13555,
--  "CriadoEm": "2020-12-19T13:25",
--  "ValorDoFrete": 5.00,
--  "TipoDeFrete": 1,
--  "ValorTotal": 215.00,
--  "Situacao": 0,
--  "TipoDeConsumidor": 1,
--  "TipoDeImportacao": 0,
--  "Classificacao": "testes",
--  "Observacoes": "Teste de Observação",
--  "ValorDeDesconto": 0,
--  "TipoDeEnvio": 100
-- },
-- "Itens": [
--  {
--   "Quantidade": 10,
--   "ValorUnitario": 21.00,
--   "Desconto": 0,
--   "CodigoDeBarras": "9788522480432"
--  }
-- ],
-- "Faturas": [
--  {
--   "NumeroDeParcelas": 1,
--   "Valor": 215.00,
--   "AprovadoEm": "2020-12-19T13:35",
--   "NSU": "TESTE",
--   "Autorizacao": "0983aisadafs90",
--   "Resumo": "Teste de Fatura",
--   "NumeroDoCartao": "XXXXXXXXXXXX5423",
--   "FormaDePagamentoId": 17
--  }
-- ],
-- "EnderecoDeCobranca": {
--  "Nome": "Marcelo Junior",
--  "Apelido": "Marcelo Junior",
--  "Email": "teste@wbstecn.com.br",
--  "CnpjCpf": "12345678900",
--  "RgIE": "123456780",
--  "Tipo": 1,
--  "Bairro" : "Jd. Nova IP",
--  "CEP" : "13000056",
--  "Cidade" : "Minha Cidade",
--  "Complemento" : "",
--  "Destinatario" : "Marcelo Junior",
--  "LinhaDeEndereco" : "Rua dos Opalas",
--  "Pais" :"Brasil",
--  "TelefoneFixo" : "19998885664",
--  "UF" : "SP"
-- },
-- "EnderecoDeEntrega": {
--  "Nome": "Marcelo Junior",
--  "Apelido": "Marcelo Junior",
--  "Email": "teste@wbstecn.com.br",
--  "CnpjCpf": "12345678900",
--  "RgIE": "123456780",
--  "Tipo": 1,
--  "Bairro" : "Jd. Nova IP",
--  "CEP" : "13000056",
--  "Cidade" : "Minha Cidade",
--  "Complemento" : "",
--  "Destinatario" : "Marcelo Junior",
--  "LinhaDeEndereco" : "Rua dos Opalas",
--  "Pais" :"Brasil",
--  "TelefoneFixo" : "19998885664",
--  "UF" : "SP"
-- }
--}
--{{/code}}
--== Campos Obrigatórios e Validações: ==
++=== Observações ===
--|**Nome**|**Descrição**
--|EnderecoDeCobranca|O Pedido deve ter pelo menos o endereço de Cobrança.
--|EnderecoDeCobranca.Complemento|Não deve conter mais de 80 caracteres.
--|EnderecoDeCobranca.LinhaDeEntrega|Não deve conter mais de 100 caracteres.
--|EnderecoDeCobranca.Nome|Não deve conter mais de 50 caracteres
--|EnderecoDeCobranca.Apelido|Não deve conter mais de 50 caracteres
--|EnderecoDeCobranca.Tipo|(((
--* 1 - Para pessoa física (PF);
--* 2- Para pessoa jurídica (PJ).
--)))
--|EnderecoDeCobranca.RegTributario|(((
--* 1 - Simples Nacional;
--* 2 - Simples Nacional-excesso de sublimite da receita bruta;
--* 3 - Regime Normal (Essa informação é para a emissão da Nota Fiscal. Para pessoa física gravar 0 e para pessoa jurídica informar, se possível, o regime tributário correto. Caso essa informação esteja indisponível, gravar 3)
--)))
--|EnderecoDeEntrega|Se informado respeita as mesmas regras do Endereço de Cobrança, se não informado o Endereço de Cobrança será utilizado no lugar.
--| |
--|Itens[*].ProdutoId|Deve ser informado, caso o código de barras não for informado.
--|Itens[*].CodigoDeBarras|Deve ser informado, caso o Id do produto não for informado.
--|Itens[*].ValorUnitario|Deve ser maior que 0
--|Itens[*].Quantidade|Deve ser maior que 0
--|Itens[*].Desconto|Deve ser maior ou igual há 0
--| |
--|Cabecalho.Codigo|Não pode estar em branco
--|Cabecalho.CriadoEm|Obrigatório informar
--|Cabecalho.ValorDoFrete|Tem que ser 0 ou maior.
--|Cabecalho.ValorTotal|Tem que ser 0 ou maior
--|Cabecalho.TipoDeFrete|Tem que ser informado corretamente!
--|Cabecalho.TipoDeEnvio|Tem que ser informado o ID recuperado pela API de Tipos de Envio.
--|Cabecalho.TipoDeImportacao|0 - Importar e Reservar (Todos os pedidos serão importados, independentemente da confirmação de pagamento do cliente por parte do EC. Nessa situação, os produtos ficarão como Reservados para atender esse pedido, aguardando o EC mudar o status para 1);  1 - Importar e/ou Liberar (Serão importados apenas os pedidos que estão com pagamento do cliente confirmado por parte do EC. Nessa situação, os produtos ficarão com a situação de Liberados para atender o pedido); 2 - Cancelar (Após o pedido ter sido importado, ele será cancelado se o EC colocar a situação como 2, desde que não tenha sido emitida nota fiscal).
--|Para mais campos |[[Consulte>>doc:Web Rest API.BDI API.Pedidos.WebHome]]
++1. A Disponibilidade da DANFE (PDF) da Nota Fiscal não é obrigatória, portanto, pode haver pedidos sem o PDF.
++1. Ambos os arquivos ficam disponiveis temporariamente, o prazo de disponibilidade é de 15 dias. Caso não encontre arquivo, é necessário a consulta no Sefaz.
--
++== Testes ==
++
++Chaves de Acesso para Teste
++
++* 35181007293372000100550010001796141001910870
++* 35180307293372000100550010000689621000737718
++* 35180307293372000100550010000689661000738209
++
++
  )))
  (% class="col-xs-12 col-sm-4" %)
  (((
--{{box title="**Índice**"}}
++{{box title="**TÍndice**"}}
  {{toc/}}
  {{/box}}