fiscalisto 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/generated.js CHANGED
@@ -67,6 +67,8 @@ export class SandboxesResource {
67
67
  /**
68
68
  * Listar entornos de prueba
69
69
  *
70
+ * Los entornos de prueba de la cuenta, cada uno con su emisor de prueba y su llave fk_test_. Hasta 25 por cuenta.
71
+ *
70
72
  * GET /v1/sandboxes
71
73
  * @see https://fiscalisto.com/docs/api/referencia/entornos-de-prueba/list-sandboxes
72
74
  */
@@ -76,6 +78,8 @@ export class SandboxesResource {
76
78
  /**
77
79
  * Ver un entorno de prueba
78
80
  *
81
+ * Un entorno de prueba: su nombre, su emisor y lo que lleva usado hoy de sus reinicios.
82
+ *
79
83
  * GET /v1/sandboxes/{id}
80
84
  * @see https://fiscalisto.com/docs/api/referencia/entornos-de-prueba/get-sandbox
81
85
  */
@@ -114,6 +118,8 @@ export class TestClocksResource {
114
118
  /**
115
119
  * Ver el reloj de prueba
116
120
  *
121
+ * La hora que es «hoy» para un emisor de prueba y hasta dónde se ha adelantado. Solo emisores de prueba.
122
+ *
117
123
  * GET /v1/issuers/{id}/test_clock
118
124
  * @see https://fiscalisto.com/docs/api/referencia/entornos-de-prueba/get-test-clock
119
125
  */
@@ -181,6 +187,8 @@ export class IssuersResource {
181
187
  /**
182
188
  * Listar emisores
183
189
  *
190
+ * Los emisores de la cuenta en el modo de la llave, los más recientes primero. Una llave limitada a algunos emisores solo ve los suyos.
191
+ *
184
192
  * GET /v1/issuers
185
193
  * @see https://fiscalisto.com/docs/api/referencia/emisores/list-issuers
186
194
  */
@@ -190,6 +198,8 @@ export class IssuersResource {
190
198
  /**
191
199
  * Ver un emisor
192
200
  *
201
+ * Un emisor: sus datos fiscales, si ya puede timbrar (status, CSD y contrato con el PAC) y su registro patronal.
202
+ *
193
203
  * GET /v1/issuers/{id}
194
204
  * @see https://fiscalisto.com/docs/api/referencia/emisores/get-issuer
195
205
  */
@@ -265,6 +275,8 @@ export class IssuersResource {
265
275
  /**
266
276
  * Ver el portal de autofactura de un emisor
267
277
  *
278
+ * El portal de autofactura del emisor: su dirección, hasta cuándo se puede facturar un ticket y cómo se arma la factura global.
279
+ *
268
280
  * GET /v1/issuers/{id}/self_invoicing
269
281
  * @see https://fiscalisto.com/docs/api/referencia/autofactura/get-self-invoicing
270
282
  */
@@ -325,6 +337,8 @@ export class InvoicesResource {
325
337
  /**
326
338
  * Descargar el PDF
327
339
  *
340
+ * La representación impresa del CFDI, como la recibe su cliente. En vez del id puede usar el UUID (con issuer si la cuenta tiene varios emisores).
341
+ *
328
342
  * GET /v1/invoices/{id}/pdf
329
343
  * @see https://fiscalisto.com/docs/api/referencia/facturas/get-invoice-pdf
330
344
  */
@@ -447,6 +461,8 @@ export class BankTransactionsResource {
447
461
  /**
448
462
  * Ver un depósito
449
463
  *
464
+ * Un depósito mandado a conciliación, con las facturas que se le encontraron o el pago que se registró con él.
465
+ *
450
466
  * GET /v1/bank_transactions/{id}
451
467
  * @see https://fiscalisto.com/docs/api/referencia/conciliacion-bancaria/get-bank-transaction
452
468
  */
@@ -543,6 +559,8 @@ export class AdvancesResource {
543
559
  /**
544
560
  * Listar anticipos sin aplicar
545
561
  *
562
+ * Los anticipos timbrados que todavía no se aplican a una factura, con lo que queda de cada uno. Filtre por customer para los de un cliente.
563
+ *
546
564
  * GET /v1/advances
547
565
  * @see https://fiscalisto.com/docs/api/referencia/anticipos/list-advances
548
566
  */
@@ -570,6 +588,8 @@ export class RetentionsResource {
570
588
  /**
571
589
  * Timbrar una constancia de retenciones
572
590
  *
591
+ * Timbra una constancia de retenciones e información de pagos (Retenciones 2.0) con los folios RET1, RET2… del emisor. Una vez por Idempotency-Key; con send_email y email la manda al receptor al timbrarla.
592
+ *
573
593
  * POST /v1/retentions
574
594
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/create-retention
575
595
  */
@@ -579,6 +599,8 @@ export class RetentionsResource {
579
599
  /**
580
600
  * Listar constancias
581
601
  *
602
+ * Las constancias del emisor, las más recientes primero.
603
+ *
582
604
  * GET /v1/retentions
583
605
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/list-retentions
584
606
  */
@@ -588,6 +610,8 @@ export class RetentionsResource {
588
610
  /**
589
611
  * Ver una constancia
590
612
  *
613
+ * Una constancia de retenciones con su estado, sus impuestos retenidos y, si se mandó, a quién.
614
+ *
591
615
  * GET /v1/retentions/{id}
592
616
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/get-retention
593
617
  */
@@ -597,6 +621,8 @@ export class RetentionsResource {
597
621
  /**
598
622
  * Descargar el PDF
599
623
  *
624
+ * La representación impresa de la constancia.
625
+ *
600
626
  * GET /v1/retentions/{id}/pdf
601
627
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/get-retention-pdf
602
628
  */
@@ -606,6 +632,8 @@ export class RetentionsResource {
606
632
  /**
607
633
  * Descargar el XML
608
634
  *
635
+ * El XML timbrado de la constancia, tal como lo tiene el SAT.
636
+ *
609
637
  * GET /v1/retentions/{id}/xml
610
638
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/get-retention-xml
611
639
  */
@@ -615,6 +643,8 @@ export class RetentionsResource {
615
643
  /**
616
644
  * Enviar por correo
617
645
  *
646
+ * Manda el PDF y el XML de la constancia a los correos de to (o al que se dio al timbrarla). Dos envíos a la vez de la misma constancia: el segundo contesta email_failed.
647
+ *
618
648
  * POST /v1/retentions/{id}/send
619
649
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/send-retention
620
650
  */
@@ -642,6 +672,8 @@ export class EmployeesResource {
642
672
  /**
643
673
  * Crear un empleado
644
674
  *
675
+ * Un empleado del emisor para sus recibos de nómina: RFC, CURP, NSS, salario diario, salario diario integrado y periodicidad. Lo que no mande tiene el valor usual (contrato indefinido, jornada diurna, quincenal, riesgo clase I). warnings dice lo que el SAT podría rechazar.
676
+ *
645
677
  * POST /v1/employees
646
678
  * @see https://fiscalisto.com/docs/api/referencia/nomina/create-employee
647
679
  */
@@ -651,6 +683,8 @@ export class EmployeesResource {
651
683
  /**
652
684
  * Listar empleados
653
685
  *
686
+ * Los empleados del emisor, los más recientes primero.
687
+ *
654
688
  * GET /v1/employees
655
689
  * @see https://fiscalisto.com/docs/api/referencia/nomina/list-employees
656
690
  */
@@ -660,6 +694,8 @@ export class EmployeesResource {
660
694
  /**
661
695
  * Ver un empleado
662
696
  *
697
+ * Un empleado con sus datos y lo que el SAT podría rechazar en warnings.
698
+ *
663
699
  * GET /v1/employees/{id}
664
700
  * @see https://fiscalisto.com/docs/api/referencia/nomina/get-employee
665
701
  */
@@ -669,6 +705,8 @@ export class EmployeesResource {
669
705
  /**
670
706
  * Actualizar un empleado
671
707
  *
708
+ * Cambia solo los campos que manda; los recibos ya timbrados no cambian.
709
+ *
672
710
  * POST /v1/employees/{id}
673
711
  * @see https://fiscalisto.com/docs/api/referencia/nomina/update-employee
674
712
  */
@@ -707,6 +745,8 @@ export class PayrollReceiptsResource {
707
745
  /**
708
746
  * Calcular un recibo sin timbrar
709
747
  *
748
+ * El recibo como se timbraría (percepciones, ISR con el subsidio para el empleo, cuotas IMSS y el neto), sin timbrar ni usar timbres.
749
+ *
710
750
  * POST /v1/payroll_receipts/preview
711
751
  * @see https://fiscalisto.com/docs/api/referencia/nomina/preview-payroll-receipt
712
752
  */
@@ -734,6 +774,8 @@ export class InvoiceBatchesResource {
734
774
  /**
735
775
  * Listar lotes
736
776
  *
777
+ * Los lotes de facturas, los más recientes primero, con cuántas se timbraron y cuántas fallaron.
778
+ *
737
779
  * GET /v1/invoice_batches
738
780
  * @see https://fiscalisto.com/docs/api/referencia/lotes/list-invoice-batches
739
781
  */
@@ -779,6 +821,8 @@ export class CustomersResource {
779
821
  /**
780
822
  * Crear un cliente
781
823
  *
824
+ * Un cliente del catálogo del emisor, con sus datos fiscales como vienen en su constancia. Un RFC que ya está en el catálogo contesta customer_exists.
825
+ *
782
826
  * POST /v1/customers
783
827
  * @see https://fiscalisto.com/docs/api/referencia/clientes/create-customer
784
828
  */
@@ -788,6 +832,8 @@ export class CustomersResource {
788
832
  /**
789
833
  * Listar clientes
790
834
  *
835
+ * Los clientes del emisor, los más recientes primero. Con tax_id, el de ese RFC.
836
+ *
791
837
  * GET /v1/customers
792
838
  * @see https://fiscalisto.com/docs/api/referencia/clientes/list-customers
793
839
  */
@@ -797,6 +843,8 @@ export class CustomersResource {
797
843
  /**
798
844
  * Ver un cliente
799
845
  *
846
+ * Un cliente del catálogo.
847
+ *
800
848
  * GET /v1/customers/{id}
801
849
  * @see https://fiscalisto.com/docs/api/referencia/clientes/get-customer
802
850
  */
@@ -806,6 +854,8 @@ export class CustomersResource {
806
854
  /**
807
855
  * Actualizar un cliente
808
856
  *
857
+ * Cambia solo los campos que manda. Las facturas ya timbradas no cambian.
858
+ *
809
859
  * POST /v1/customers/{id}
810
860
  * @see https://fiscalisto.com/docs/api/referencia/clientes/update-customer
811
861
  */
@@ -815,6 +865,8 @@ export class CustomersResource {
815
865
  /**
816
866
  * Borrar un cliente
817
867
  *
868
+ * Lo quita del catálogo. Sus facturas timbradas siguen igual.
869
+ *
818
870
  * DELETE /v1/customers/{id}
819
871
  * @see https://fiscalisto.com/docs/api/referencia/clientes/delete-customer
820
872
  */
@@ -842,6 +894,8 @@ export class CustomerDataRequestsResource {
842
894
  /**
843
895
  * Listar solicitudes de datos
844
896
  *
897
+ * Las ligas para pedir datos fiscales, las más recientes primero, con su estado.
898
+ *
845
899
  * GET /v1/customer_data_requests
846
900
  * @see https://fiscalisto.com/docs/api/referencia/clientes/list-customer-data-requests
847
901
  */
@@ -851,6 +905,8 @@ export class CustomerDataRequestsResource {
851
905
  /**
852
906
  * Ver una solicitud de datos
853
907
  *
908
+ * Una solicitud de datos: su liga y, si el cliente ya contestó, sus datos fiscales y el cliente que se guardó.
909
+ *
854
910
  * GET /v1/customer_data_requests/{id}
855
911
  * @see https://fiscalisto.com/docs/api/referencia/clientes/get-customer-data-request
856
912
  */
@@ -878,6 +934,8 @@ export class ProductsResource {
878
934
  /**
879
935
  * Crear un producto
880
936
  *
937
+ * Un producto o servicio del catálogo del emisor, con su clave del SAT, su unidad, su precio y sus impuestos, para usarlo en items con product.
938
+ *
881
939
  * POST /v1/products
882
940
  * @see https://fiscalisto.com/docs/api/referencia/productos/create-product
883
941
  */
@@ -887,6 +945,8 @@ export class ProductsResource {
887
945
  /**
888
946
  * Listar productos
889
947
  *
948
+ * Los productos del emisor, los más recientes primero. Filtre por sku o product_key.
949
+ *
890
950
  * GET /v1/products
891
951
  * @see https://fiscalisto.com/docs/api/referencia/productos/list-products
892
952
  */
@@ -896,6 +956,8 @@ export class ProductsResource {
896
956
  /**
897
957
  * Ver un producto
898
958
  *
959
+ * Un producto del catálogo.
960
+ *
899
961
  * GET /v1/products/{id}
900
962
  * @see https://fiscalisto.com/docs/api/referencia/productos/get-product
901
963
  */
@@ -905,6 +967,8 @@ export class ProductsResource {
905
967
  /**
906
968
  * Actualizar un producto
907
969
  *
970
+ * Cambia solo los campos que manda. Las facturas ya timbradas no cambian.
971
+ *
908
972
  * POST /v1/products/{id}
909
973
  * @see https://fiscalisto.com/docs/api/referencia/productos/update-product
910
974
  */
@@ -914,6 +978,8 @@ export class ProductsResource {
914
978
  /**
915
979
  * Borrar un producto
916
980
  *
981
+ * Lo quita del catálogo. Las facturas que lo usaron siguen igual.
982
+ *
917
983
  * DELETE /v1/products/{id}
918
984
  * @see https://fiscalisto.com/docs/api/referencia/productos/delete-product
919
985
  */
@@ -988,6 +1054,8 @@ export class SatDownloadsResource {
988
1054
  /**
989
1055
  * Listar descargas del SAT
990
1056
  *
1057
+ * Las descargas pedidas al SAT, las más recientes primero, con su estado.
1058
+ *
991
1059
  * GET /v1/sat_downloads
992
1060
  * @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/list-sat-downloads
993
1061
  */
@@ -997,6 +1065,8 @@ export class SatDownloadsResource {
997
1065
  /**
998
1066
  * Ver una descarga del SAT
999
1067
  *
1068
+ * Una descarga del SAT: su periodo, su estado y cuántos CFDI trajo. Al terminar llega sat_download.completed.
1069
+ *
1000
1070
  * GET /v1/sat_downloads/{id}
1001
1071
  * @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/get-sat-download
1002
1072
  */
@@ -1024,6 +1094,8 @@ export class SatInvoicesResource {
1024
1094
  /**
1025
1095
  * Ver una factura del SAT
1026
1096
  *
1097
+ * Un CFDI que trajo una descarga del SAT, con sus importes y su estado ante el SAT.
1098
+ *
1027
1099
  * GET /v1/sat_invoices/{id}
1028
1100
  * @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/get-sat-invoice
1029
1101
  */
@@ -1070,9 +1142,22 @@ export class SatDeclarationsResource {
1070
1142
  list(params, options) {
1071
1143
  return this.#client.list({ path: "/v1/sat_declarations", query: params }, options);
1072
1144
  }
1145
+ /**
1146
+ * Ver el año mes por mes
1147
+ *
1148
+ * Cada mes del ejercicio con sus obligaciones: presentada (con sus declaraciones), falta (venció y no la encontramos) o por presentar, con el día en que vence (el 17 del mes siguiente, o el día hábil siguiente, más los días por el sexto dígito del RFC). Se arma con lo que trajeron sus consultas; no usa timbres.
1149
+ *
1150
+ * GET /v1/sat_declarations/calendar
1151
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/get-sat-declaration-calendar
1152
+ */
1153
+ calendar(params, options) {
1154
+ return this.#client.request({ method: "GET", path: "/v1/sat_declarations/calendar", query: params }, options);
1155
+ }
1073
1156
  /**
1074
1157
  * Ver una declaración del SAT
1075
1158
  *
1159
+ * Una declaración presentada al SAT, con sus cifras en summary y si ya están su PDF y su acuse.
1160
+ *
1076
1161
  * GET /v1/sat_declarations/{id}
1077
1162
  * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/get-sat-declaration
1078
1163
  */
@@ -1144,6 +1229,8 @@ export class TicketsResource {
1144
1229
  /**
1145
1230
  * Ver un ticket
1146
1231
  *
1232
+ * Un ticket de autofactura: si ya se facturó (invoice) o entró en la factura global (global_invoice).
1233
+ *
1147
1234
  * GET /v1/tickets/{id}
1148
1235
  * @see https://fiscalisto.com/docs/api/referencia/autofactura/get-ticket
1149
1236
  */
@@ -1212,6 +1299,17 @@ export class AccountingResource {
1212
1299
  crossChecks(params, options) {
1213
1300
  return this.#client.request({ method: "GET", path: "/v1/accounting/cross_checks", query: params }, options);
1214
1301
  }
1302
+ /**
1303
+ * Ver los CFDI de una cifra del cruce
1304
+ *
1305
+ * Los CFDI que forman lo facturado (invoiced) de una cifra del cruce de un mes, con los mismos cálculos de Impuestos: cada factura PUE o nota de crédito en su mes y cada factura PPD por lo que se pagó en el mes, con lo que aporta. La suma de cfdi más adjustment es invoiced. Sirve para ver por qué una cifra differs. Gratis: no consulta al SAT.
1306
+ *
1307
+ * GET /v1/accounting/cross_checks/cfdi
1308
+ * @see https://fiscalisto.com/docs/api/referencia/contabilidad/get-cross-check-cfdi
1309
+ */
1310
+ crossCheckCfdi(params, options) {
1311
+ return this.#client.request({ method: "GET", path: "/v1/accounting/cross_checks/cfdi", query: params }, options);
1312
+ }
1215
1313
  /**
1216
1314
  * Ver el catálogo de cuentas
1217
1315
  *
@@ -1288,6 +1386,8 @@ export class StoreConnectionsResource {
1288
1386
  /**
1289
1387
  * Ver una tienda
1290
1388
  *
1389
+ * Una tienda conectada (Shopify, Mercado Libre o WooCommerce), su estado y lo último que importó.
1390
+ *
1291
1391
  * GET /v1/store_connections/{id}
1292
1392
  * @see https://fiscalisto.com/docs/api/referencia/tiendas-en-linea/get-store-connection
1293
1393
  */
@@ -1359,6 +1459,8 @@ export class RecurringInvoicesResource {
1359
1459
  /**
1360
1460
  * Ver una factura recurrente
1361
1461
  *
1462
+ * Una factura recurrente: su calendario, la próxima fecha, la última factura que timbró y, si falló, por qué en last_error.
1463
+ *
1362
1464
  * GET /v1/recurring_invoices/{id}
1363
1465
  * @see https://fiscalisto.com/docs/api/referencia/facturas-recurrentes/get-recurring-invoice
1364
1466
  */
@@ -1536,6 +1638,8 @@ export class WebhookEndpointsResource {
1536
1638
  /**
1537
1639
  * Listar webhooks
1538
1640
  *
1641
+ * Los webhooks del modo de la llave. Hasta 16 por modo.
1642
+ *
1539
1643
  * GET /v1/webhook_endpoints
1540
1644
  * @see https://fiscalisto.com/docs/api/referencia/webhooks/list-webhook-endpoints
1541
1645
  */
@@ -1545,6 +1649,8 @@ export class WebhookEndpointsResource {
1545
1649
  /**
1546
1650
  * Ver un webhook
1547
1651
  *
1652
+ * Un webhook: su dirección, los eventos que recibe y si sus entregas fallan. El secreto solo viene al crearlo.
1653
+ *
1548
1654
  * GET /v1/webhook_endpoints/{id}
1549
1655
  * @see https://fiscalisto.com/docs/api/referencia/webhooks/get-webhook-endpoint
1550
1656
  */
@@ -1554,6 +1660,8 @@ export class WebhookEndpointsResource {
1554
1660
  /**
1555
1661
  * Actualizar un webhook
1556
1662
  *
1663
+ * Cambia su dirección, sus eventos, su descripción o su versión de la API; con disabled: false vuelve a encender uno que se apagó.
1664
+ *
1557
1665
  * POST /v1/webhook_endpoints/{id}
1558
1666
  * @see https://fiscalisto.com/docs/api/referencia/webhooks/update-webhook-endpoint
1559
1667
  */
@@ -1563,6 +1671,8 @@ export class WebhookEndpointsResource {
1563
1671
  /**
1564
1672
  * Borrar un webhook
1565
1673
  *
1674
+ * Deja de mandar eventos a esa dirección. Los eventos siguen en GET /v1/events.
1675
+ *
1566
1676
  * DELETE /v1/webhook_endpoints/{id}
1567
1677
  * @see https://fiscalisto.com/docs/api/referencia/webhooks/delete-webhook-endpoint
1568
1678
  */
@@ -1612,6 +1722,8 @@ export class EventsResource {
1612
1722
  /**
1613
1723
  * Ver un evento
1614
1724
  *
1725
+ * Un evento de los últimos 30 días, con el objeto como estaba cuando pasó.
1726
+ *
1615
1727
  * GET /v1/events/{id}
1616
1728
  * @see https://fiscalisto.com/docs/api/referencia/eventos/get-event
1617
1729
  */