feat: documentation

jpdev01 · Apr 6, 2024 · 31533f5 · 31533f5
1 parent 7e98125
commit 31533f5
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 22 deletions.
diff --git a/docs/invoice.md b/docs/invoice.md
@@ -0,0 +1,21 @@
+## Scheduling invoice
+```java
+Invoice invoice = Invoice.creator()
+                .setServiceDescription("Nota fiscal da Fatura 101940. Descrição dos Serviços: ANÁLISE E DESENVOLVIMENTO DE SISTEMAS")
+                .setObservations("Mensal referente aos trabalhos de Junho.")
+                .setValue(Money.create(300))
+                .setDeductions(Money.create(2))
+                .setEffectiveDate(new Date())
+                .setMunicipalServiceName("Análise e Desenvolvimento de Sistemas")
+                .setTaxes(
+                        new Taxes()
+                                .setRetainIss(true)
+                                .setIss(Money.create(3))
+                                .setCofins(Money.create(3))
+                                .setCsll(Money.create(1))
+                                .setInss(Money.create(3))
+                                .setIr(Money.create(1.5))
+                                .setPis(Money.create(0.65))
+                )
+                .create();
+```
diff --git a/docs/pix.md b/docs/pix.md
@@ -0,0 +1,9 @@
+## Cancelar uma transação Pix
+
+Para cancelar uma transação Pix, você deve informar o id da transação Pix que deseja cancelar.
+
+```java
+PixTransaction cancelledPixTransaction = PixTransaction
+                .canceller("35363f6e-93e2-11ec-b9d9-96f4053b1bd4")
+                .create();
+```
diff --git a/docs/readme.md b/docs/readme.md
@@ -11,25 +11,8 @@ The recommended way to use the AWS SDK for Java in your project is to consume it
 </dependency>
 ```
 
-## Scheduling invoice
-```java
-Invoice invoice = Invoice.creator()
-                .setServiceDescription("Nota fiscal da Fatura 101940. Descrição dos Serviços: ANÁLISE E DESENVOLVIMENTO DE SISTEMAS")
-                .setObservations("Mensal referente aos trabalhos de Junho.")
-                .setValue(Money.create(300))
-                .setDeductions(Money.create(2))
-                .setEffectiveDate(new Date())
-                .setMunicipalServiceName("Análise e Desenvolvimento de Sistemas")
-                .setTaxes(
-                        new Taxes()
-                                .setRetainIss(true)
-                                .setIss(Money.create(3))
-                                .setCofins(Money.create(3))
-                                .setCsll(Money.create(1))
-                                .setInss(Money.create(3))
-                                .setIr(Money.create(1.5))
-                                .setPis(Money.create(0.65))
-                )
-                .create();
-```
-== teste
+# Documentation
+
+- [Invoice](invoice.md)
+- [Pix](pix.md)
+- [How to schedule invoice](setup/readme.md)