Skip to content

Commit 2d3a30a

Browse files
rodrigocananearodrigocananea
committed
Adicionado mkdocs + github pages
1 parent 4ac03eb commit 2d3a30a

21 files changed

+2243
-0
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
name: Publish docs via GitHub Pages
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- master
8+
9+
jobs:
10+
build:
11+
name: Deploy docs
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout main
15+
uses: actions/checkout@v2
16+
17+
- name: Deploy docs
18+
uses: mhausenblas/mkdocs-deploy-gh-pages@master
19+
# Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
20+
env:
21+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22+
CONFIG_FILE: docs/mkdocs.yml
23+
EXTRA_PACKAGES: build-base
24+
REQUIREMENTS: docs/requirements.txt

‎docs/.idea/.gitignore‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/.idea/dbnavigator.xml‎

Lines changed: 461 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/.idea/docs.iml‎

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/.idea/modules.xml‎

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/.idea/vcs.xml‎

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/Makefile‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.PHONY: docs
2+
3+
default: install
4+
5+
all: install build
6+
7+
8+
h help:
9+
@grep '^[a-z]' Makefile
10+
11+
12+
install:
13+
pip install pip --upgrade
14+
pip install -r requirements.txt
15+
16+
upgrade:
17+
pip install pip --upgrade
18+
pip install -r requirements.txt --upgrade
19+
20+
21+
s serve:
22+
mkdocs serve --strict
23+
24+
25+
b build:
26+
mkdocs build --strict
27+
28+
d deploy:
29+
mkdocs gh-deploy --strict --force

‎docs/docs/index.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
[![Build Status](https://travis-ci.org/Samuel-Oliveira/Java_NFe.svg?branch=master)](https://travis-ci.org/Samuel-Oliveira/Java_NFe) [![MIT License](https://img.shields.io/github/license/Samuel-Oliveira/Java_NFe.svg) ](https://github.com/Samuel-Oliveira/Java_NFe/blob/master/LICENSE) [![Maven Central](https://img.shields.io/maven-central/v/br.com.swconsultoria/java-nfe.svg?label=Maven%20Central)](https://search.maven.org/artifact/br.com.swconsultoria/java-nfe/4.00.18/jar) [![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/Samuel-Oliveira/Java_NFe.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Samuel-Oliveira/Java_NFe/context:java) [![Total alerts](https://img.shields.io/lgtm/alerts/g/Samuel-Oliveira/Java_NFe.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Samuel-Oliveira/Java_NFe/alerts/)
2+
3+
***Biblioteca Java para consumo do WebService de NFe/NFCe***
4+
5+
## Dúvidas, Sugestões ou Consultoria
6+
#### Entre no Discord do Projeto: [https://discord.gg/ZXpqnaV](https://discord.gg/ZXpqnaV)
7+
8+
## Gostou do Projeto? Dê sua colaboração pelo Pix: 01713390108
9+
<p align="center">
10+
<img src="https://swconsultoria.com.br/pix.png" width="220">
11+
</p>
12+
13+
Para Iniciar :
14+
- Caso use Libs baixe o [java-nfe-4.00.18.jar](https://github.com/Samuel-Oliveira/Java_NFe/raw/master/java-nfe-4.00.18.jar) e o adicione às bibliotecas de Seu Projeto.
15+
16+
- Baixe o [Schemas.rar](https://github.com/Samuel-Oliveira/Java_NFe/raw/master/schemas.zip) e extraia na sua Máquina.
17+
18+
- Maven :
19+
```xml
20+
<dependency>
21+
<groupId>br.com.swconsultoria</groupId>
22+
<artifactId>java-nfe</artifactId>
23+
<version>4.00.18</version>
24+
</dependency>
25+
```
26+
27+
- Gradle :
28+
```groovy
29+
repositories {
30+
maven {
31+
url = "https://oss.sonatype.org/content/repositories/snapshots"
32+
}
33+
}
34+
dependencies {
35+
implementation "br.com.swconsultoria:java-nfe:4.00.18"
36+
}
37+
```
38+

‎docs/docs/tutorial/baixar-documento.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Baixar Documento (DistDfe)
2+
3+
Função para consulta/baixa de NF-e na Sefaz.
4+
5+
### Exemplo de consulta via NSU e Chave de Acesso:
6+
```java title="DistribuicaoDFeTeste.java"
7+
import br.com.swconsultoria.nfe.Nfe;
8+
import br.com.swconsultoria.nfe.dom.ConfiguracoesNfe;
9+
import br.com.swconsultoria.nfe.dom.enuns.*;
10+
import br.com.swconsultoria.nfe.schema.retdistdfeint.RetDistDFeInt;
11+
import br.com.swconsultoria.nfe.schema.retdistdfeint.RetDistDFeInt.LoteDistDFeInt.DocZip;
12+
import br.com.swconsultoria.nfe.util.XmlNfeUtil;
13+
14+
import java.util.List;
15+
16+
/**
17+
* @author Samuel Oliveira
18+
*
19+
*/
20+
public class DistribuicaoDFeTeste {
21+
22+
public static void main(String[] args) {
23+
try {
24+
// Inicia As Configurações (1)
25+
ConfiguracoesNfe config = Config.iniciaConfiguracoes();
26+
27+
// Informe o CNPJ Do Destinatario (Deve ser o Mesmo do Certificado)
28+
String cnpj = "XXX";
29+
30+
RetDistDFeInt retorno;
31+
32+
// Para Consulta Via CHAVE
33+
// String chave = "35170843283811001202550010046314601229130549";
34+
// retorno = Nfe.distribuicaoDfe(PessoaEnum.JURIDICA, cnpj, ConsultaDFeEnum.CHAVE, chave);
35+
36+
// Para Consulta Via NSU
37+
String nsu = "000000000000000";
38+
retorno = Nfe.distribuicaoDfe(config, PessoaEnum.JURIDICA, cnpj, ConsultaDFeEnum.NSU, nsu);
39+
40+
if (StatusEnum.DOC_LOCALIZADO_PARA_DESTINATARIO.getCodigo().equals(retorno.getCStat())) {
41+
System.out.println();
42+
System.out.println("# Status: " + retorno.getCStat() + " - " + retorno.getXMotivo());
43+
System.out.println("# NSU Atual: " + retorno.getUltNSU());
44+
System.out.println("# Max NSU: " + retorno.getMaxNSU());
45+
System.out.println("# Max NSU: " + retorno.getMaxNSU());
46+
47+
//Aqui Recebe a Lista De XML (No Maximo 50 por Consulta)
48+
List<DocZip> listaDoc = retorno.getLoteDistDFeInt().getDocZip();
49+
for (DocZip docZip : listaDoc) {
50+
System.out.println();
51+
System.out.println("# Schema: " + docZip.getSchema());
52+
switch (docZip.getSchema()) {
53+
case "resNFe_v1.01.xsd":
54+
System.out.println("# Este é o XML em resumo, deve ser feito a Manifestação para o Objeter o XML Completo.");
55+
break;
56+
case "procNFe_v4.00.xsd":
57+
System.out.println("# XML Completo.");
58+
break;
59+
case "procEventoNFe_v1.00.xsd":
60+
System.out.println("# XML Evento.");
61+
break;
62+
}
63+
//Transforma o GZip em XML
64+
String xml = XmlNfeUtil.gZipToXml(docZip.getValue());
65+
System.out.println("# XML: " + xml);
66+
}
67+
} else {
68+
System.out.println();
69+
System.out.println("# Status: " + retorno.getCStat() + " - " + retorno.getXMotivo());
70+
}
71+
} catch (Exception e) {
72+
System.err.println();
73+
System.err.println("# Erro: "+e.getMessage());
74+
}
75+
}
76+
}
77+
```
78+
79+
1. Acesse o menu [Configurações (Certificado)](./configuracoes.md)

‎docs/docs/tutorial/cancelamento.md‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
# Cancelamento
2+
3+
Função para Cancelar a NFe/NFCe.
4+
5+
### Cancelar NFe/NFCe.
6+
```java title="CancelarTeste.java"
7+
import br.com.swconsultoria.nfe.Nfe;
8+
import br.com.swconsultoria.nfe.dom.ConfiguracoesNfe;
9+
import br.com.swconsultoria.nfe.dom.Evento;
10+
import br.com.swconsultoria.nfe.dom.enuns.DocumentoEnum;
11+
import br.com.swconsultoria.nfe.schema.envEventoCancNFe.TEnvEvento;
12+
import br.com.swconsultoria.nfe.schema.envEventoCancNFe.TRetEnvEvento;
13+
import br.com.swconsultoria.nfe.util.CancelamentoUtil;
14+
import br.com.swconsultoria.nfe.util.RetornoUtil;
15+
16+
import java.time.LocalDateTime;
17+
18+
/**
19+
* @author Samuel Oliveira
20+
*/
21+
public class CancelarTeste {
22+
23+
public static void main(String[] args) {
24+
try {
25+
// Inicia As Configurações (1)
26+
ConfiguracoesNfe config = Config.iniciaConfiguracoes();
27+
28+
//Agora o evento pode aceitar uma lista de cancelaemntos para envio em Lote.
29+
//Para isso Foi criado o Objeto Cancela
30+
Evento cancela = new Evento();
31+
//Informe a chave da Nota a ser Cancelada
32+
cancela.setChave("XXX");
33+
//Informe o protocolo da Nota a ser Cancelada
34+
cancela.setProtocolo("XXX");
35+
//Informe o CNPJ do emitente
36+
cancela.setCnpj("XXX");
37+
//Informe o Motivo do Cancelamento
38+
cancela.setMotivo("Teste de Cancelamento");
39+
//Informe a data do Cancelamento
40+
cancela.setDataEvento(LocalDateTime.now());
41+
42+
//Monta o Evento de Cancelamento
43+
TEnvEvento enviEvento = CancelamentoUtil.montaCancelamento(cancela, config);
44+
45+
//Envia o Evento de Cancelamento
46+
TRetEnvEvento retorno = Nfe.cancelarNfe(config, enviEvento, true, DocumentoEnum.NFE);
47+
48+
//Valida o Retorno do Cancelamento
49+
RetornoUtil.validaCancelamento(retorno);
50+
51+
//Resultado
52+
System.out.println();
53+
retorno.getRetEvento().forEach( resultado -> {
54+
System.out.println("# Chave: " + resultado.getInfEvento().getChNFe());
55+
System.out.println("# Status: " + resultado.getInfEvento().getCStat() + " - " + resultado.getInfEvento().getXMotivo());
56+
System.out.println("# Protocolo: " + resultado.getInfEvento().getNProt());
57+
});
58+
59+
//Cria ProcEvento de Cacnelamento
60+
String proc = CancelamentoUtil.criaProcEventoCancelamento(config, enviEvento, retorno.getRetEvento().get(0));
61+
System.out.println();
62+
System.out.println("# ProcEvento : " + proc);
63+
64+
} catch (Exception e) {
65+
System.err.println();
66+
System.err.println("# Erro: "+e.getMessage());
67+
}
68+
}
69+
}
70+
```
71+
72+
1. Acesse o menu [Configurações (Certificado)](./configuracoes.md)
73+
74+
75+
### Cancelamento Substituição (NFCe)
76+
```java title="CancelarTeste.java"
77+
import br.com.swconsultoria.nfe.Nfe;
78+
import br.com.swconsultoria.nfe.dom.ConfiguracoesNfe;
79+
import br.com.swconsultoria.nfe.dom.Evento;
80+
import br.com.swconsultoria.nfe.schema.envEventoCancSubst.TEnvEvento;
81+
import br.com.swconsultoria.nfe.schema.envEventoCancSubst.TRetEnvEvento;
82+
import br.com.swconsultoria.nfe.util.CancelamentoSubstituicaoUtil;
83+
import br.com.swconsultoria.nfe.util.RetornoUtil;
84+
85+
import java.time.LocalDateTime;
86+
87+
/**
88+
* @author Samuel Oliveira
89+
*/
90+
public class CancelarSubstituicaoTeste {
91+
92+
public static void main(String[] args) {
93+
try {
94+
// Inicia As Configurações (1)
95+
ConfiguracoesNfe config = Config.iniciaConfiguracoes();
96+
97+
//Agora o evento pode aceitar uma lista de cancelaemntos para envio em Lote.
98+
//Para isso Foi criado o Objeto Cancela
99+
Evento cancela = new Evento();
100+
//Informe a chave da Nota a ser Cancelada
101+
cancela.setChave("XXX");
102+
//Informe a chave da Nota a Substituta
103+
cancela.setChaveSusbstituta("XXX");
104+
//Informe o protocolo da Nota a ser Cancelada
105+
cancela.setProtocolo("XXX");
106+
//Informe o CNPJ do emitente
107+
cancela.setCnpj("XXX");
108+
//Informe o Motivo do Cancelamento
109+
cancela.setMotivo("Teste de Cancelamento");
110+
//Informe a data do Cancelamento
111+
cancela.setDataEvento(LocalDateTime.now());
112+
113+
//Monta o Evento de Cancelamento
114+
TEnvEvento enviEvento = CancelamentoSubstituicaoUtil.montaCancelamento(cancela, config);
115+
116+
//Envia o Evento de Cancelamento
117+
TRetEnvEvento retorno = Nfe.cancelarSubstituicaoNfe(config, enviEvento, true);
118+
119+
//Valida o Retorno do Cancelamento
120+
RetornoUtil.validaCancelamentoSubstituicao(retorno);
121+
122+
//Resultado
123+
System.out.println();
124+
retorno.getRetEvento().forEach( resultado -> {
125+
System.out.println("# Chave: " + resultado.getInfEvento().getChNFe());
126+
System.out.println("# Status: " + resultado.getInfEvento().getCStat() + " - " + resultado.getInfEvento().getXMotivo());
127+
System.out.println("# Protocolo: " + resultado.getInfEvento().getNProt());
128+
});
129+
130+
//Cria ProcEvento de Cacnelamento
131+
String proc = CancelamentoSubstituicaoUtil.criaProcEventoCancelamento(config, enviEvento, retorno.getRetEvento().get(0));
132+
System.out.println();
133+
System.out.println("# ProcEvento : " + proc);
134+
135+
} catch (Exception e) {
136+
System.err.println();
137+
System.err.println("# Erro: "+e.getMessage());
138+
}
139+
}
140+
}
141+
```
142+
143+
1. Acesse o menu [Configurações (Certificado)](./configuracoes.md)

0 commit comments

Comments
 (0)