Skip to content

Commit ccf431f

Browse files
Add docs (#72)
1 parent 3cca08a commit ccf431f

File tree

6 files changed

+90
-0
lines changed

6 files changed

+90
-0
lines changed

src/main/java/io/github/project/openubl/xbuilder/content/models/common/Contacto.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,22 @@
1919
import lombok.Builder;
2020
import lombok.Data;
2121

22+
/**
23+
* Datos de contacto
24+
*
25+
* @author <a href="mailto:carlosthe19916@gmail.com">Carlos Feria</a>
26+
*/
2227
@Data
2328
@Builder
2429
public class Contacto {
2530

31+
/**
32+
* Número telefónico
33+
*/
2634
private String telefono;
35+
36+
/**
37+
* Correo electrónico
38+
*/
2739
private String email;
2840
}

src/main/java/io/github/project/openubl/xbuilder/content/models/common/Direccion.java

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,55 @@
1919
import lombok.Builder;
2020
import lombok.Data;
2121

22+
/**
23+
* Dirección
24+
*
25+
* @author <a href="mailto:carlosthe19916@gmail.com">Carlos Feria</a>
26+
*/
2227
@Data
2328
@Builder
2429
public class Direccion {
2530

31+
/**
32+
* Código de 6 dígitos que corresponden al Departamento, Provincia, y Distrito
33+
*/
2634
private String ubigeo;
2735

36+
/**
37+
* Código de cuatro dígitos asignado por SUNAT, que identifica al
38+
* establecimiento anexo. Dicho código se genera al momento la respectiva comunicación del
39+
* establecimiento. Tratándose del domicilio fiscal y en el caso de no poder determinar el lugar
40+
* de la venta, informar “0000”.
41+
*/
2842
private String codigoLocal;
43+
44+
/**
45+
* Nombre de la urbanización.
46+
*/
2947
private String urbanizacion;
3048

49+
/**
50+
* Nombre del Departamento o Región. Ejemplo: Ayacucho
51+
*/
3152
private String departamento;
53+
54+
/**
55+
* Nombre de la Provincia. Ejemplo: Huamanga
56+
*/
3257
private String provincia;
58+
59+
/**
60+
* Nombre del Distrito. Ejemplo: Quinua
61+
*/
3362
private String distrito;
3463

64+
/**
65+
* Dirección. Ejemplo: Jirón las piedras 123
66+
*/
3567
private String direccion;
68+
69+
/**
70+
* Código de 2 dígitos que corresponde al país a la que pertenece la dirección. Ejemplo: PE
71+
*/
3672
private String codigoPais;
3773
}

src/main/java/io/github/project/openubl/xbuilder/content/models/common/Firmante.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,22 @@
1919
import lombok.Builder;
2020
import lombok.Data;
2121

22+
/**
23+
* Persona que firma electrónicamente el documento
24+
*
25+
* @author <a href="mailto:carlosthe19916@gmail.com">Carlos Feria</a>
26+
*/
2227
@Data
2328
@Builder
2429
public class Firmante {
2530

31+
/**
32+
* Número de RUC de la persona
33+
*/
2634
private String ruc;
35+
36+
/**
37+
* Razón social de la persona
38+
*/
2739
private String razonSocial;
2840
}

src/main/java/io/github/project/openubl/xbuilder/content/models/common/Proveedor.java

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,37 @@
1919
import lombok.Builder;
2020
import lombok.Data;
2121

22+
/**
23+
* Persona que vende o presta un servicio
24+
*
25+
* @author <a href="mailto:carlosthe19916@gmail.com">Carlos Feria</a>
26+
*/
2227
@Data
2328
@Builder
2429
public class Proveedor {
2530

31+
/**
32+
* Número de RUC de la persona jurídica
33+
*/
2634
private String ruc;
35+
36+
/**
37+
* Nombre comercial de la persona jurídica
38+
*/
2739
private String nombreComercial;
40+
41+
/**
42+
* Razón social de la persona jurídica
43+
*/
2844
private String razonSocial;
2945

46+
/**
47+
* Dirección de la persona jurídica
48+
*/
3049
private Direccion direccion;
50+
51+
/**
52+
* Contacto de la persona jurídica
53+
*/
3154
private Contacto contacto;
3255
}

src/main/java/io/github/project/openubl/xbuilder/enricher/kie/rules/enrich/header/ProveedorDireccionRule.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,15 @@
2020
import static io.github.project.openubl.xbuilder.enricher.kie.rules.utils.Helpers.whenBaseDocumento;
2121

2222
import io.github.project.openubl.xbuilder.content.models.common.Direccion;
23+
import io.github.project.openubl.xbuilder.content.models.common.Proveedor;
2324
import io.github.project.openubl.xbuilder.content.models.standard.general.Document;
2425
import io.github.project.openubl.xbuilder.enricher.kie.AbstractHeaderRule;
2526
import io.github.project.openubl.xbuilder.enricher.kie.RulePhase;
2627
import java.util.function.Consumer;
2728

29+
/**
30+
* Rule for {@link Proveedor#direccion}
31+
*/
2832
@RulePhase(type = RulePhase.PhaseType.ENRICH)
2933
public class ProveedorDireccionRule extends AbstractHeaderRule {
3034

src/main/java/io/github/project/openubl/xbuilder/enricher/kie/rules/enrich/header/invoice/DireccionDeEntregaRule.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
import java.util.Map;
2828
import java.util.function.Consumer;
2929

30+
/**
31+
* Rule for {@link Invoice#direccionEntrega}
32+
*/
3033
@RulePhase(type = RulePhase.PhaseType.ENRICH)
3134
public class DireccionDeEntregaRule extends AbstractHeaderRule {
3235

0 commit comments

Comments
 (0)