Skip to content

Commit 2c30ef9

Browse files
add docs
1 parent 594cad6 commit 2c30ef9

29 files changed

+354
-591
lines changed

docusaurus/docs/bcs_getstatus.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
id: bcs_getstatus
3+
title: BillConsultService:getStatus
4+
---
5+
6+
Use for sending:
7+
8+
- Checking the status of a file in SUNAT
9+
10+
## Check status
11+
12+
```java
13+
ServiceConfig config = new ServiceConfig.Builder()
14+
.url(URL_CONSULTA)
15+
.username(USERNAME)
16+
.passwod(PASSWORD)
17+
.build();
18+
19+
BillConsultBean consult = new BillConsultBean.Builder()
20+
.ruc("1234567894")
21+
.tipo("01")
22+
.serie("F001")
23+
.numero(102)
24+
.build();
25+
26+
StatusResponse response = BillConsultServiceManager.getStatus(consult, config);
27+
```

docusaurus/docs/bcs_getstatuscdr.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
id: bcs_getstatuscdr
3+
title: BillConsultService:getStatusCdr
4+
---
5+
6+
Use for:
7+
8+
- Get the CDR from SUNAT.
9+
10+
## Check status
11+
12+
```java
13+
ServiceConfig config = new ServiceConfig.Builder()
14+
.url(URL_CONSULTA)
15+
.username(USERNAME)
16+
.passwod(PASSWORD)
17+
.build();
18+
19+
BillConsultBean consult = new BillConsultBean.Builder()
20+
.ruc("1234567894")
21+
.tipo("01")
22+
.serie("F001")
23+
.numero(102)
24+
.build();
25+
26+
StatusResponse response = BillConsultServiceManager.getStatusCdr(config, consult);
27+
```

docusaurus/docs/bs_getstatus.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
id: bs_getstatus
3+
title: BillService:getStatus
4+
---
5+
6+
Use for check _Tickets_:
7+
8+
## Check _ticket_
9+
10+
```java
11+
ServiceConfig config = new ServiceConfig.Builder()
12+
.url("https://e-beta.sunat.gob.pe/ol-ti-itcpfegem-beta/billService")
13+
.username("12345678959MODDATOS")
14+
.password("MODDATOS")
15+
.build();
16+
17+
BillServiceModel result = BillServiceManager.getStatus("miTicket", config);
18+
```

docusaurus/docs/bs_sendbill.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
id: bs_sendbill
3+
title: BillService:sendBill
4+
---
5+
6+
Use for sending:
7+
8+
- Invoices (boleta/factura).
9+
- Credit notes (notas de crédito).
10+
- Debit notes (notas de débito).
11+
- Despatch documents (guias de remisión).
12+
- Perceptions (percepciones).
13+
- Retentions (retenciones).
14+
15+
## Send File
16+
17+
Define your URL you want yo send your file to, and then send your file:
18+
19+
```java
20+
ServiceConfig config = new ServiceConfig.Builder()
21+
.url("https://e-beta.sunat.gob.pe/ol-ti-itcpfegem-beta/billService")
22+
.username("12345678959MODDATOS")
23+
.password("MODDATOS")
24+
.build();
25+
26+
File file = new File("12345678959-01-F001-00000001.xml");
27+
BillServiceModel result = BillServiceManager.sendBill(file, config);
28+
```
29+
30+
> Remember that your filename must follow the pattern expected by the SOAP endpoint. E.g. for SUNAT it is expected to have the pattern `ruc-codigoComprobante-serie-numero.xml`
31+
32+
## Send byte[]
33+
34+
Define your URL you want yo send your file to, and then send your file:
35+
36+
```java
37+
ServiceConfig config = new ServiceConfig.Builder()
38+
.url("https://e-beta.sunat.gob.pe/ol-ti-itcpfegem-beta/billService")
39+
.username("12345678959MODDATOS")
40+
.password("MODDATOS")
41+
.build();
42+
43+
byte[] file; // define your file here;
44+
String fileName = "12345678959-01-F001-00000001.xml";
45+
BillServiceModel result = BillServiceManager.sendBill(fileName, file, config);
46+
```
47+
48+
> Remember that your filename must follow the pattern expected by the SOAP endpoint. E.g. for SUNAT it is expected to have the pattern `ruc-codigoComprobante-serie-numero.xml`

docusaurus/docs/bs_sendsummary.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
id: bs_sendsummary
3+
title: BillService:sendSummary
4+
---
5+
6+
Use for sending:
7+
8+
- Voided documents (Baja).
9+
- Summary documents (Resumen diario).
10+
11+
## Send File
12+
13+
Define your URL you want yo send your file to, and then send your file:
14+
15+
```java
16+
ServiceConfig config = new ServiceConfig.Builder()
17+
.url("https://e-beta.sunat.gob.pe/ol-ti-itcpfegem-beta/billService")
18+
.username("12345678959MODDATOS")
19+
.password("MODDATOS")
20+
.build();
21+
22+
File file = new File("12345678959-RA-20180316-00001.xml");
23+
BillServiceModel result = BillServiceManager.sendSummary(file, config);
24+
```
25+
26+
> Remember that your filename must follow the pattern expected by the SOAP endpoint. E.g. for SUNAT it is expected to have the pattern `ruc-codigoComprobante-serie-numero.xml`
27+
28+
## Send byte[]
29+
30+
Define your URL you want yo send your file to, and then send your file:
31+
32+
```java
33+
ServiceConfig config = new ServiceConfig.Builder()
34+
.url("https://e-beta.sunat.gob.pe/ol-ti-itcpfegem-beta/billService")
35+
.username("12345678959MODDATOS")
36+
.password("MODDATOS")
37+
.build();
38+
39+
byte[] file // Define tu array de bytes acá;
40+
String fileName = "12345678959-RA-20180316-00001.xml";
41+
BillServiceModel result = BillServiceManager.sendSummary(fileName, file, config);
42+
```
43+
44+
> Remember that your filename must follow the pattern expected by the SOAP endpoint. E.g. for SUNAT it is expected to have the pattern `ruc-codigoComprobante-serie-numero.xml`

docusaurus/docs/bvs_getstatus.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
id: bvs_getstatus
3+
title: BillValidService:getStatus
4+
---
5+
6+
Use for:
7+
8+
- Check the authenticity of a file.
9+
10+
## Check status
11+
12+
```java
13+
File file = new File("../folder/F001-00005954.xml");
14+
15+
ServiceConfig config = new ServiceConfig.Builder()
16+
.url("https://e-factura.sunat.gob.pe/ol-it-wsconsvalidcpe/billValidService")
17+
.username(USERNAME)
18+
.passwod(PASSWORD)
19+
.build();
20+
21+
StatusResponse status = BillValidServiceManager.getStatus(file, config);
22+
```

docusaurus/docs/concepts.md

Lines changed: 0 additions & 88 deletions
This file was deleted.

docusaurus/docs/contributing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: contributing
33
title: Contributing
44
---
55

6-
XBuilder is helping others to be more efficient, you can contribute XBuilder in many ways. We are now welcoming contributors to collaborate.
6+
XSender is helping others to be more efficient, you can contribute XSender in many ways. We are now welcoming contributors to collaborate.
77

88
The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:
99

@@ -14,8 +14,8 @@ The [Open Source Guides](https://opensource.guide/) website has a collection of
1414

1515
There are many ways to contribute to Docusaurus, and many of them do not involve writing any code. Here's a few ideas to get started:
1616

17-
- Start using XBuilder! Go through the Getting Started guides. Does everything work as expected? If not, we're always looking for improvements. Let us know by opening an issue.
18-
- Look through [the issues](https://github.com/project-openubl/xbuilder-server/issues). If you find an issue you would like to fix, open a pull request. Issues tagged as [Good first issue](https://github.com/project-openubl/xbuilder-server/labels/Good%20first%20issue) are a good place to get started.
17+
- Start using XSender! Go through the Getting Started guides. Does everything work as expected? If not, we're always looking for improvements. Let us know by opening an issue.
18+
- Look through [the issues](https://github.com/project-openubl/XSender/issues). If you find an issue you would like to fix, open a pull request. Issues tagged as [Good first issue](https://github.com/project-openubl/XSender/labels/Good%20first%20issue) are a good place to get started.
1919
- Help us making the docs better. File an issue if you find anything that is confusing or can be improved.
2020

2121
Contributions are very welcome. If you think you need help planning your contribution, please ping us on Twitter at [@openubl](https://twitter.com/openubl) and let us know you are looking for a bit of help.

docusaurus/docs/create_xml.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)