fiscalisto 0.1.1 → 0.1.3

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.
@@ -329,7 +329,7 @@ export interface Invoice {
329
329
  cancellation: {
330
330
  /** pending (espera la respuesta del cliente), accepted (cancelada), rejected (el cliente la rechazó) o lapsed (venció; puede pedirla otra vez). */
331
331
  status: string | null;
332
- /** Motivo de cancelación (c_MotivoCancelacion): 01 con errores con relación (lleva substitution), 02 con errores sin relación (por omisión), 03 no se llevó a cabo, 04 nominativa en una global. */
332
+ /** Motivo de cancelación (c_MotivoCancelacion): 01 con errores con relación (lleva substitution), 02 con errores sin relación (por omisión), 03 no se llevó a cabo, 04 solo en una factura global, cuando una venta incluida se facturó a nombre del cliente. */
333
333
  motive: string | null;
334
334
  /** El comprobante que sustituye a este (su id o su UUID), con el motivo 01. */
335
335
  substitution: string | null;
@@ -467,7 +467,7 @@ export interface Retention {
467
467
  cancellation: {
468
468
  /** pending (espera la respuesta del cliente), accepted (cancelada), rejected (el cliente la rechazó) o lapsed (venció; puede pedirla otra vez). */
469
469
  status: string;
470
- /** Motivo de cancelación (c_MotivoCancelacion): 01 con errores con relación (lleva substitution), 02 con errores sin relación (por omisión), 03 no se llevó a cabo, 04 nominativa en una global. */
470
+ /** Motivo de cancelación (c_MotivoCancelacion): 01 con errores con relación (lleva substitution), 02 con errores sin relación (por omisión), 03 no se llevó a cabo, 04 solo en una factura global, cuando una venta incluida se facturó a nombre del cliente. */
471
471
  motive: string | null;
472
472
  /** Cuándo se canceló. */
473
473
  canceled_at: string | null;
@@ -1197,6 +1197,26 @@ export interface SatDeclaration {
1197
1197
  /** Hasta cuándo sirve la línea de captura (AAAA-MM-DD). */
1198
1198
  valid_until: string | null;
1199
1199
  } | null;
1200
+ /** Las mismas cifras con nombres fijos, por obligación (ISR, IVA, cada retención), para leerlas igual cada mes sin conocer el formato del SAT. Una cifra que no viene en la declaración o no se pudo leer es null, nunca 0. En Declaraciones y pagos solo trae lo del acuse. */
1201
+ summary: {
1202
+ /** Cada obligación de la declaración: isr, vat, ieps, isr_salaries, isr_assimilated_salaries, isr_professional_services, isr_rent, vat_withholdings u other. */
1203
+ obligations: {
1204
+ /** Qué obligación es. */
1205
+ obligation: "isr" | "vat" | "ieps" | "isr_salaries" | "isr_assimilated_salaries" | "isr_professional_services" | "isr_rent" | "vat_withholdings" | "other";
1206
+ /** Su nombre como lo imprime el SAT. */
1207
+ name: string;
1208
+ /** true si sus cifras se leyeron de la declaración; false si solo vienen del acuse. */
1209
+ read: boolean;
1210
+ /** La cantidad a cargo. */
1211
+ amount_due: number | null;
1212
+ /** La cantidad a pagar. */
1213
+ amount_to_pay: number | null;
1214
+ /** Sus cifras con nombres fijos. ISR: income, invoiced_income, income_ytd, deductions, profit_coefficient, taxable_profit, losses_applied, tax_base, tax_caused, prior_payments, withheld. IVA: taxable_16, taxable_0, exempt, charged, paid_16, creditable, withheld, balance_applied. Salarios: workers, payments, exempt, withheld. Todas: surcharges, inflation, paid_before, due, in_favor, to_pay. null si no viene o no se pudo leer. */
1215
+ figures: Record<string, number | null>;
1216
+ }[];
1217
+ /** El total a pagar del acuse; si no hay acuse, la suma de las obligaciones cuando todas se conocen. */
1218
+ total_to_pay: number | null;
1219
+ };
1200
1220
  /** Qué archivos ya tiene: pdf (GET …/pdf), receipt (GET …/receipt) y financial_statements (GET …/financial_statements, solo en la anual de persona moral). */
1201
1221
  files: {
1202
1222
  /** Si ya tiene la declaración en PDF (GET …/pdf). */
@@ -1236,6 +1256,35 @@ export interface SatDeclarationsRefresh {
1236
1256
  /** Desde cuándo se puede volver a consultar este emisor (10 minutos después). */
1237
1257
  next_refresh_at: string;
1238
1258
  }
1259
+ /** El ejercicio del emisor mes por mes: qué obligaciones presentó, cuáles parecen faltar y cuáles aún no vencen. */
1260
+ export interface SatDeclarationCalendar {
1261
+ /** Qué tipo de objeto es («invoice», «customer»…). */
1262
+ object: "sat_declaration_calendar";
1263
+ /** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
1264
+ livemode: boolean;
1265
+ /** El emisor. */
1266
+ issuer: string;
1267
+ /** El ejercicio. */
1268
+ year: number;
1269
+ /** Cuántas obligaciones ya vencidas no encontramos presentadas en el SAT. */
1270
+ missing: number;
1271
+ /** Los 12 meses y, en persona moral, la anual (month null). Las obligaciones se deducen de lo que el emisor presenta: ISR e IVA cada mes desde el primero que presentó; una retención si la presentó en 2 de los 3 meses anteriores o antes y después. La opinión de cumplimiento del SAT es la que manda. */
1272
+ months: {
1273
+ /** El mes (1 a 12), o null para la anual. */
1274
+ month: number | null;
1275
+ /** El último día para presentarla (AAAA-MM-DD). */
1276
+ due_on: string;
1277
+ /** Las obligaciones del mes. */
1278
+ obligations: {
1279
+ /** Qué obligación es (las de summary.obligations), o annual_return para la anual. */
1280
+ obligation: "isr" | "vat" | "ieps" | "isr_salaries" | "isr_assimilated_salaries" | "isr_professional_services" | "isr_rent" | "vat_withholdings" | "other" | "annual_return";
1281
+ /** filed (presentada), missing (venció y no la encontramos) o due (aún no vence). */
1282
+ status: "filed" | "missing" | "due";
1283
+ /** Las declaraciones (dcl_…) que la presentaron, la normal y sus complementarias. */
1284
+ declarations: string[];
1285
+ }[];
1286
+ }[];
1287
+ }
1239
1288
  /** Una venta que su comprador puede facturar él mismo en el portal del emisor (autofactura). */
1240
1289
  export interface Ticket {
1241
1290
  /** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
@@ -1368,7 +1417,7 @@ export interface RecurringInvoice {
1368
1417
  /** Cuándo se creó. */
1369
1418
  created_at: string | null;
1370
1419
  }
1371
- /** La póliza de diario de un CFDI: sus cargos y abonos, que siempre cuadran. */
1420
+ /** Una póliza de diario (de un CFDI, un pago, un recibo de nómina o la depreciación del mes): sus cargos y abonos, que siempre cuadran. */
1372
1421
  export interface JournalEntry {
1373
1422
  /** El número de la póliza: D-AAAAMM-NNNNN, en orden de fecha dentro del mes. */
1374
1423
  id: string;
@@ -1378,19 +1427,21 @@ export interface JournalEntry {
1378
1427
  object: "journal_entry";
1379
1428
  /** El emisor. */
1380
1429
  issuer: string;
1381
- /** La fecha del CFDI. */
1430
+ /** De qué es: invoice (un CFDI de ingreso o egreso), payment_received o payment_made (un pago de un complemento), payroll (un recibo de nómina) o depreciation (la depreciación del mes de los activos fijos). */
1431
+ type: "invoice" | "payment_received" | "payment_made" | "payroll" | "depreciation";
1432
+ /** La fecha del CFDI o del pago; en la depreciación, el último día del mes. */
1382
1433
  date: string;
1383
- /** Factura o nota de crédito, su folio y la contraparte. */
1434
+ /** El documento, su folio y la contraparte. */
1384
1435
  description: string;
1385
- /** La factura (inv_…) si la timbró este emisor; null si la recibió. */
1436
+ /** La factura (inv_…) si es la póliza de un CFDI que timbró este emisor; null en los demás casos. */
1386
1437
  invoice: string | null;
1387
- /** El folio fiscal del CFDI. */
1388
- uuid: string;
1389
- /** El RFC de la contraparte (cliente o proveedor). */
1390
- tax_id: string;
1391
- /** El total del CFDI, en su moneda. */
1438
+ /** El folio fiscal del CFDI (o del complemento de pago); null en la depreciación. */
1439
+ uuid: string | null;
1440
+ /** El RFC de la contraparte (cliente, proveedor o empleado); null en la depreciación. */
1441
+ tax_id: string | null;
1442
+ /** El total del documento, en su moneda. */
1392
1443
  total: number;
1393
- /** La moneda del CFDI. */
1444
+ /** La moneda del documento. */
1394
1445
  currency: string;
1395
1446
  /** El tipo de cambio, si no es en pesos; null si es en pesos. */
1396
1447
  exchange_rate: number | null;
@@ -1462,6 +1513,237 @@ export interface TrialBalance {
1462
1513
  credit: number;
1463
1514
  };
1464
1515
  }
1516
+ /** El estado de resultados y el balance general de un mes, leídos de su balanza. */
1517
+ export interface FinancialStatements {
1518
+ /** Qué tipo de objeto es («invoice», «customer»…). */
1519
+ object: "financial_statements";
1520
+ /** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
1521
+ livemode: boolean;
1522
+ /** El emisor. */
1523
+ issuer: string;
1524
+ /** El mes (AAAA-MM). */
1525
+ month: string;
1526
+ /** El estado de resultados del mes (month) y del año hasta ese mes (year_to_date). Cada sección suma en positivo lo que aumenta la utilidad (ingresos) y en negativo lo que la reduce (costos y gastos). */
1527
+ income_statement: {
1528
+ /** El estado de resultados del mes. */
1529
+ month: {
1530
+ /** Ingresos, costos, gastos, financiamiento y otros, cada uno con su total. */
1531
+ sections: {
1532
+ /** El archivo .key en base64 (puede traer el prefijo data:). */
1533
+ key: "ingresos" | "costos" | "gastos" | "financiamiento" | "otros";
1534
+ /** Nombre. */
1535
+ name: string;
1536
+ /** Total en la moneda del comprobante (Total). */
1537
+ total: number;
1538
+ /** Su monto por el primer nivel del código agrupador. */
1539
+ groups: {
1540
+ /** El primer nivel del código agrupador (401, 601…). */
1541
+ grouping_code: string;
1542
+ /** Nombre. */
1543
+ name: string;
1544
+ /** Importe. */
1545
+ amount: number;
1546
+ /** Las cuentas del grupo con su monto. */
1547
+ accounts: {
1548
+ /** Número de empleado (NumEmpleado). */
1549
+ number: string;
1550
+ /** Nombre. */
1551
+ name: string;
1552
+ /** Importe. */
1553
+ amount: number;
1554
+ }[];
1555
+ }[];
1556
+ }[];
1557
+ /** La utilidad (o pérdida, negativa) antes de impuestos del mes. */
1558
+ net_income: number;
1559
+ };
1560
+ /** El estado de resultados de enero al mes. */
1561
+ year_to_date: {
1562
+ /** Ingresos, costos, gastos, financiamiento y otros, cada uno con su total. */
1563
+ sections: {
1564
+ /** El archivo .key en base64 (puede traer el prefijo data:). */
1565
+ key: "ingresos" | "costos" | "gastos" | "financiamiento" | "otros";
1566
+ /** Nombre. */
1567
+ name: string;
1568
+ /** Total en la moneda del comprobante (Total). */
1569
+ total: number;
1570
+ /** Su monto por el primer nivel del código agrupador. */
1571
+ groups: {
1572
+ /** El primer nivel del código agrupador (401, 601…). */
1573
+ grouping_code: string;
1574
+ /** Nombre. */
1575
+ name: string;
1576
+ /** Importe. */
1577
+ amount: number;
1578
+ /** Las cuentas del grupo con su monto. */
1579
+ accounts: {
1580
+ /** Número de empleado (NumEmpleado). */
1581
+ number: string;
1582
+ /** Nombre. */
1583
+ name: string;
1584
+ /** Importe. */
1585
+ amount: number;
1586
+ }[];
1587
+ }[];
1588
+ }[];
1589
+ /** La utilidad (o pérdida, negativa) antes de impuestos de enero al mes. */
1590
+ net_income: number;
1591
+ };
1592
+ };
1593
+ /** El balance general al cierre del mes, agrupado por el primer nivel del código agrupador. difference es activo menos pasivo y capital: 0 cuando los libros cuadran. */
1594
+ balance_sheet: {
1595
+ /** El activo: su total y sus grupos. */
1596
+ assets: {
1597
+ /** Total en la moneda del comprobante (Total). */
1598
+ total: number;
1599
+ /** Su monto por el primer nivel del código agrupador. */
1600
+ groups: {
1601
+ /** El primer nivel del código agrupador (401, 601…). */
1602
+ grouping_code: string;
1603
+ /** Nombre. */
1604
+ name: string;
1605
+ /** Importe. */
1606
+ amount: number;
1607
+ /** Las cuentas del grupo con su monto. */
1608
+ accounts: {
1609
+ /** Número de empleado (NumEmpleado). */
1610
+ number: string;
1611
+ /** Nombre. */
1612
+ name: string;
1613
+ /** Importe. */
1614
+ amount: number;
1615
+ }[];
1616
+ }[];
1617
+ };
1618
+ /** El pasivo: su total y sus grupos. */
1619
+ liabilities: {
1620
+ /** Total en la moneda del comprobante (Total). */
1621
+ total: number;
1622
+ /** Su monto por el primer nivel del código agrupador. */
1623
+ groups: {
1624
+ /** El primer nivel del código agrupador (401, 601…). */
1625
+ grouping_code: string;
1626
+ /** Nombre. */
1627
+ name: string;
1628
+ /** Importe. */
1629
+ amount: number;
1630
+ /** Las cuentas del grupo con su monto. */
1631
+ accounts: {
1632
+ /** Número de empleado (NumEmpleado). */
1633
+ number: string;
1634
+ /** Nombre. */
1635
+ name: string;
1636
+ /** Importe. */
1637
+ amount: number;
1638
+ }[];
1639
+ }[];
1640
+ };
1641
+ /** El capital contable sin el resultado del ejercicio: su total y sus grupos. */
1642
+ equity: {
1643
+ /** Total en la moneda del comprobante (Total). */
1644
+ total: number;
1645
+ /** Su monto por el primer nivel del código agrupador. */
1646
+ groups: {
1647
+ /** El primer nivel del código agrupador (401, 601…). */
1648
+ grouping_code: string;
1649
+ /** Nombre. */
1650
+ name: string;
1651
+ /** Importe. */
1652
+ amount: number;
1653
+ /** Las cuentas del grupo con su monto. */
1654
+ accounts: {
1655
+ /** Número de empleado (NumEmpleado). */
1656
+ number: string;
1657
+ /** Nombre. */
1658
+ name: string;
1659
+ /** Importe. */
1660
+ amount: number;
1661
+ }[];
1662
+ }[];
1663
+ };
1664
+ /** El resultado del ejercicio hasta el mes, parte del capital. */
1665
+ net_income_year_to_date: number;
1666
+ /** Pasivo más capital más el resultado del ejercicio. */
1667
+ liabilities_and_equity: number;
1668
+ /** Activo menos pasivo y capital: 0 cuando los libros cuadran. */
1669
+ difference: number;
1670
+ };
1671
+ /** Cuántas pólizas tuvo el mes. */
1672
+ journal_entries: number;
1673
+ /** Desde qué fecha cuentan los saldos iniciales capturados en la app; null si no hay. */
1674
+ opening_balances_date: string | null;
1675
+ /** Pagos que se refieren a facturas que no están en Fiscalisto y no se registraron. */
1676
+ missing_invoices: number;
1677
+ }
1678
+ /** Lo que el emisor declaró cada mes contra lo que dicen sus CFDI, el IVA a favor y el régimen con que factura. */
1679
+ export interface CrossChecks {
1680
+ /** Qué tipo de objeto es («invoice», «customer»…). */
1681
+ object: "cross_checks";
1682
+ /** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
1683
+ livemode: boolean;
1684
+ /** El emisor. */
1685
+ issuer: string;
1686
+ /** El ejercicio. */
1687
+ year: number;
1688
+ /** Cada mes cuya declaración mensual ya venció (el día 17 del mes siguiente), con sus cruces. Un mes con complementaria toma, por impuesto, la más reciente que lo trae. */
1689
+ months: {
1690
+ /** El mes (AAAA-MM). */
1691
+ month: string;
1692
+ /** El peor de sus cruces: differs (no coincide), unreadable (una cifra no se pudo leer), not_filed (sin declaración mensual) o matches. */
1693
+ status: "matches" | "differs" | "not_filed" | "unreadable";
1694
+ /** Un cruce por cifra. */
1695
+ checks: {
1696
+ /** Qué cifra: vat_charged (IVA trasladado), vat_creditable (IVA acreditable), vat_withheld (IVA que le retuvieron), isr_income (ingresos para ISR: nominales en persona moral, cobrados en los demás) y, solo en los meses en que retuvo, isr_withheld_salaries (ISR retenido por salarios y asimilados, contra sus recibos de nómina), isr_withheld_suppliers (ISR retenido por honorarios y arrendamiento, contra las facturas recibidas que pagó) o vat_withheld_suppliers (IVA retenido a proveedores). */
1697
+ key: "vat_charged" | "vat_creditable" | "vat_withheld" | "isr_income" | "isr_withheld_salaries" | "isr_withheld_suppliers" | "vat_withheld_suppliers";
1698
+ /** matches (hasta $2 de diferencia), differs, not_filed (no hay declaración del mes, o en una retención ninguna declaración del mes la trae) o unreadable (la declaración no trae la cifra en un renglón reconocible). */
1699
+ status: "matches" | "differs" | "not_filed" | "unreadable";
1700
+ /** Lo declarado, en pesos; null si no hay declaración o no se pudo leer. */
1701
+ declared: number | null;
1702
+ /** Lo que dicen los CFDI del mes, con los mismos cálculos de Impuestos. */
1703
+ invoiced: number;
1704
+ /** declared menos invoiced; null si declared es null. */
1705
+ difference: number | null;
1706
+ /** El número de operación de la declaración de donde salió la cifra. */
1707
+ operation_number: string | null;
1708
+ }[];
1709
+ }[];
1710
+ /** El IVA a favor que muestran las declaraciones del año y lo que meses posteriores acreditaron. Una estimación con las declaraciones leídas, no la cuenta del SAT. */
1711
+ vat_balance_in_favor: {
1712
+ /** Cada mes con IVA a favor. */
1713
+ periods: {
1714
+ /** El mes cuya declaración muestra el IVA a favor. */
1715
+ month: string;
1716
+ /** El IVA a favor de ese mes. */
1717
+ amount: number;
1718
+ /** El número de operación de esa declaración. */
1719
+ operation_number: string;
1720
+ }[];
1721
+ /** La suma del IVA a favor del año. */
1722
+ total: number;
1723
+ /** Lo que las declaraciones del año acreditaron de saldos a favor de periodos anteriores. */
1724
+ credited: number;
1725
+ /** total menos credited, nunca menos de 0: lo que quedaría por acreditar o pedir en devolución. */
1726
+ remaining: number;
1727
+ };
1728
+ /** Los regímenes del emisor (registered, de su constancia) y con cuáles facturó en el año. */
1729
+ tax_regimes: {
1730
+ /** Los regímenes de su constancia (c_RegimenFiscal), capturados en la app. */
1731
+ registered: string[];
1732
+ /** Cada régimen con que facturó en el año (RegimenFiscal del emisor). */
1733
+ invoiced: {
1734
+ /** El régimen (c_RegimenFiscal). */
1735
+ tax_regime: string;
1736
+ /** Cuántos CFDI lo llevan (ingreso, egreso y pago, sin cancelados). */
1737
+ invoices: number;
1738
+ /** La fecha del primero (AAAA-MM-DD). */
1739
+ first_date: string;
1740
+ /** La fecha del último (AAAA-MM-DD). */
1741
+ last_date: string;
1742
+ /** Si el régimen está en su constancia; null si no se capturaron los regímenes de la constancia. */
1743
+ registered: boolean | null;
1744
+ }[];
1745
+ };
1746
+ }
1465
1747
  /** La DIOT de un mes: lo pagado a cada proveedor, por tipo de operación. */
1466
1748
  export interface Diot {
1467
1749
  /** Qué tipo de objeto es («invoice», «customer»…). */
@@ -1820,14 +2102,14 @@ export interface WebhookTest {
1820
2102
  };
1821
2103
  }
1822
2104
  /** Lo que puede pasar: el tipo de cada evento. */
1823
- export type EventType = "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "customer_data_request.completed" | "sat_download.completed" | "sat_download.failed" | "ticket.invoiced" | "ticket.included_in_global" | "recurring_invoice.failed" | "quote.viewed" | "quote.accepted" | "quote.changes_requested" | "quote.rejected" | "issuer.ready" | "balance.low" | "test_clock.ready";
2105
+ export type EventType = "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "customer_data_request.completed" | "sat_download.completed" | "sat_download.failed" | "sat_declaration.created" | "sat_declaration.updated" | "ticket.invoiced" | "ticket.included_in_global" | "recurring_invoice.failed" | "quote.viewed" | "quote.accepted" | "quote.changes_requested" | "quote.rejected" | "issuer.ready" | "balance.low" | "test_clock.ready";
1824
2106
  /** Algo que pasó en su cuenta: el objeto completo como quedó. Se manda a sus webhooks firmado (Standard Webhooks). */
1825
2107
  export interface EventBase<T extends EventType = EventType, O = unknown> {
1826
2108
  /** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
1827
2109
  id: string;
1828
2110
  /** Qué tipo de objeto es («invoice», «customer»…). */
1829
2111
  object: "event";
1830
- /** Qué pasó: invoice.stamped, invoice.failed, invoice.canceled, invoice.cancellation_pending, invoice.cancellation_rejected, invoice.paid, invoice.partially_paid, retention.stamped, retention.failed, retention.canceled, invoice_batch.completed, customer_data_request.completed, sat_download.completed, sat_download.failed, ticket.invoiced, ticket.included_in_global, recurring_invoice.failed, quote.viewed, quote.accepted, quote.changes_requested, quote.rejected, issuer.ready, balance.low o test_clock.ready. */
2112
+ /** Qué pasó: invoice.stamped, invoice.failed, invoice.canceled, invoice.cancellation_pending, invoice.cancellation_rejected, invoice.paid, invoice.partially_paid, retention.stamped, retention.failed, retention.canceled, invoice_batch.completed, customer_data_request.completed, sat_download.completed, sat_download.failed, sat_declaration.created, sat_declaration.updated, ticket.invoiced, ticket.included_in_global, recurring_invoice.failed, quote.viewed, quote.accepted, quote.changes_requested, quote.rejected, issuer.ready, balance.low o test_clock.ready. */
1831
2113
  type: T;
1832
2114
  /** Versión de la API con que se armó el objeto. */
1833
2115
  api_version: string;
@@ -1841,7 +2123,7 @@ export interface EventBase<T extends EventType = EventType, O = unknown> {
1841
2123
  };
1842
2124
  }
1843
2125
  /** Un evento: según su type, data.object es la factura, la constancia o el lote. */
1844
- export type Event = EventBase<"invoice.stamped", Invoice> | EventBase<"invoice.failed", Invoice> | EventBase<"invoice.canceled", Invoice> | EventBase<"invoice.cancellation_pending", Invoice> | EventBase<"invoice.cancellation_rejected", Invoice> | EventBase<"invoice.paid", Invoice> | EventBase<"invoice.partially_paid", Invoice> | EventBase<"retention.stamped", Retention> | EventBase<"retention.failed", Retention> | EventBase<"retention.canceled", Retention> | EventBase<"invoice_batch.completed", InvoiceBatch> | EventBase<"customer_data_request.completed", CustomerDataRequest> | EventBase<"sat_download.completed", SatDownload> | EventBase<"sat_download.failed", SatDownload> | EventBase<"ticket.invoiced", Ticket> | EventBase<"ticket.included_in_global", Ticket> | EventBase<"recurring_invoice.failed", RecurringInvoice> | EventBase<"quote.viewed", Quote> | EventBase<"quote.accepted", Quote> | EventBase<"quote.changes_requested", Quote> | EventBase<"quote.rejected", Quote> | EventBase<"issuer.ready", Issuer> | EventBase<"balance.low", Balance> | EventBase<"test_clock.ready", TestClock>;
2126
+ export type Event = EventBase<"invoice.stamped", Invoice> | EventBase<"invoice.failed", Invoice> | EventBase<"invoice.canceled", Invoice> | EventBase<"invoice.cancellation_pending", Invoice> | EventBase<"invoice.cancellation_rejected", Invoice> | EventBase<"invoice.paid", Invoice> | EventBase<"invoice.partially_paid", Invoice> | EventBase<"retention.stamped", Retention> | EventBase<"retention.failed", Retention> | EventBase<"retention.canceled", Retention> | EventBase<"invoice_batch.completed", InvoiceBatch> | EventBase<"customer_data_request.completed", CustomerDataRequest> | EventBase<"sat_download.completed", SatDownload> | EventBase<"sat_download.failed", SatDownload> | EventBase<"sat_declaration.created", SatDeclaration> | EventBase<"sat_declaration.updated", SatDeclaration> | EventBase<"ticket.invoiced", Ticket> | EventBase<"ticket.included_in_global", Ticket> | EventBase<"recurring_invoice.failed", RecurringInvoice> | EventBase<"quote.viewed", Quote> | EventBase<"quote.accepted", Quote> | EventBase<"quote.changes_requested", Quote> | EventBase<"quote.rejected", Quote> | EventBase<"issuer.ready", Issuer> | EventBase<"balance.low", Balance> | EventBase<"test_clock.ready", TestClock>;
1845
2127
  /** Confirmación de que se borró. */
1846
2128
  export interface Deleted {
1847
2129
  /** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
@@ -3057,7 +3339,7 @@ export interface SendInvoiceParams {
3057
3339
  cc?: string | null;
3058
3340
  }
3059
3341
  export interface CancelInvoiceParams {
3060
- /** Motivo de cancelación (c_MotivoCancelacion): 01 con errores con relación (lleva substitution), 02 con errores sin relación (por omisión), 03 no se llevó a cabo, 04 nominativa en una global. */
3342
+ /** Motivo de cancelación (c_MotivoCancelacion): 01 con errores con relación (lleva substitution), 02 con errores sin relación (por omisión), 03 no se llevó a cabo, 04 solo en una factura global, cuando una venta incluida se facturó a nombre del cliente. */
3061
3343
  motive?: "01" | "02" | "03" | "04";
3062
3344
  /** El comprobante que sustituye a este (su id o su UUID), con el motivo 01. */
3063
3345
  substitution?: string;
@@ -3381,7 +3663,7 @@ export interface SendRetentionParams {
3381
3663
  to?: string;
3382
3664
  }
3383
3665
  export interface CancelRetentionParams {
3384
- /** Motivo de cancelación (c_MotivoCancelacion): 01 con errores con relación (lleva substitution), 02 con errores sin relación (por omisión), 03 no se llevó a cabo, 04 nominativa en una global. */
3666
+ /** Motivo de cancelación (c_MotivoCancelacion): 01 con errores con relación (lleva substitution), 02 con errores sin relación (por omisión), 03 no se llevó a cabo, 04 solo en una factura global, cuando una venta incluida se facturó a nombre del cliente. */
3385
3667
  motive?: "01" | "02" | "03" | "04";
3386
3668
  /** El comprobante que sustituye a este (su id o su UUID), con el motivo 01. */
3387
3669
  substitution?: string;
@@ -3795,6 +4077,17 @@ export interface ListSatDeclarationsParams {
3795
4077
  year?: number;
3796
4078
  /** monthly (provisionales o definitivas), annual (la anual) o dyp (Declaraciones y pagos). */
3797
4079
  source?: "monthly" | "annual" | "dyp";
4080
+ /** Solo las de un mes (1 a 12). */
4081
+ month?: number;
4082
+ /** normal o complementary (complementarias). */
4083
+ type?: "normal" | "complementary";
4084
+ }
4085
+ /** Los parámetros de GET /v1/sat_declarations/calendar. */
4086
+ export interface GetSatDeclarationCalendarParams {
4087
+ /** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
4088
+ issuer?: string;
4089
+ /** El ejercicio, como 2026. Por omisión, el actual. */
4090
+ year?: number;
3798
4091
  }
3799
4092
  export interface CreateTicketParams {
3800
4093
  /** El emisor (iss_…) que vendió. Por omisión, su único emisor. */
@@ -3861,6 +4154,20 @@ export interface GetTrialBalanceParams {
3861
4154
  /** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
3862
4155
  issuer?: string;
3863
4156
  }
4157
+ /** Los parámetros de GET /v1/accounting/financial_statements. */
4158
+ export interface GetFinancialStatementsParams {
4159
+ /** El mes (AAAA-MM). */
4160
+ month: string;
4161
+ /** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
4162
+ issuer?: string;
4163
+ }
4164
+ /** Los parámetros de GET /v1/accounting/cross_checks. */
4165
+ export interface GetCrossChecksParams {
4166
+ /** El ejercicio. Por omisión, el actual. */
4167
+ year?: number;
4168
+ /** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
4169
+ issuer?: string;
4170
+ }
3864
4171
  /** Los parámetros de GET /v1/accounting/accounts. */
3865
4172
  export interface ListLedgerAccountsParams {
3866
4173
  /** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
@@ -4377,7 +4684,7 @@ export interface RollWebhookSecretParams {
4377
4684
  }
4378
4685
  export interface TestWebhookEndpointParams {
4379
4686
  /** El evento a mandar. Por omisión invoice.stamped. */
4380
- type?: "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "customer_data_request.completed" | "sat_download.completed" | "sat_download.failed" | "ticket.invoiced" | "ticket.included_in_global" | "recurring_invoice.failed" | "quote.viewed" | "quote.accepted" | "quote.changes_requested" | "quote.rejected" | "issuer.ready" | "balance.low" | "test_clock.ready";
4687
+ type?: "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "customer_data_request.completed" | "sat_download.completed" | "sat_download.failed" | "sat_declaration.created" | "sat_declaration.updated" | "ticket.invoiced" | "ticket.included_in_global" | "recurring_invoice.failed" | "quote.viewed" | "quote.accepted" | "quote.changes_requested" | "quote.rejected" | "issuer.ready" | "balance.low" | "test_clock.ready";
4381
4688
  }
4382
4689
  /** Los parámetros de GET /v1/events. */
4383
4690
  export interface ListEventsParams {
@@ -4386,7 +4693,7 @@ export interface ListEventsParams {
4386
4693
  /** El id del último de la página anterior, para la siguiente. */
4387
4694
  starting_after?: string;
4388
4695
  /** Solo de este tipo. */
4389
- type?: "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "customer_data_request.completed" | "sat_download.completed" | "sat_download.failed" | "ticket.invoiced" | "ticket.included_in_global" | "recurring_invoice.failed" | "quote.viewed" | "quote.accepted" | "quote.changes_requested" | "quote.rejected" | "issuer.ready" | "balance.low" | "test_clock.ready";
4696
+ type?: "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "customer_data_request.completed" | "sat_download.completed" | "sat_download.failed" | "sat_declaration.created" | "sat_declaration.updated" | "ticket.invoiced" | "ticket.included_in_global" | "recurring_invoice.failed" | "quote.viewed" | "quote.accepted" | "quote.changes_requested" | "quote.rejected" | "issuer.ready" | "balance.low" | "test_clock.ready";
4390
4697
  /** Solo los de este objeto (inv_…, ret_…, bat_…). */
4391
4698
  object?: string;
4392
4699
  }
@@ -4443,6 +4750,8 @@ export declare class SandboxesResource {
4443
4750
  /**
4444
4751
  * Listar entornos de prueba
4445
4752
  *
4753
+ * Los entornos de prueba de la cuenta, cada uno con su emisor de prueba y su llave fk_test_. Hasta 25 por cuenta.
4754
+ *
4446
4755
  * GET /v1/sandboxes
4447
4756
  * @see https://fiscalisto.com/docs/api/referencia/entornos-de-prueba/list-sandboxes
4448
4757
  */
@@ -4450,6 +4759,8 @@ export declare class SandboxesResource {
4450
4759
  /**
4451
4760
  * Ver un entorno de prueba
4452
4761
  *
4762
+ * Un entorno de prueba: su nombre, su emisor y lo que lleva usado hoy de sus reinicios.
4763
+ *
4453
4764
  * GET /v1/sandboxes/{id}
4454
4765
  * @see https://fiscalisto.com/docs/api/referencia/entornos-de-prueba/get-sandbox
4455
4766
  */
@@ -4480,6 +4791,8 @@ export declare class TestClocksResource {
4480
4791
  /**
4481
4792
  * Ver el reloj de prueba
4482
4793
  *
4794
+ * La hora que es «hoy» para un emisor de prueba y hasta dónde se ha adelantado. Solo emisores de prueba.
4795
+ *
4483
4796
  * GET /v1/issuers/{id}/test_clock
4484
4797
  * @see https://fiscalisto.com/docs/api/referencia/entornos-de-prueba/get-test-clock
4485
4798
  */
@@ -4533,6 +4846,8 @@ export declare class IssuersResource {
4533
4846
  /**
4534
4847
  * Listar emisores
4535
4848
  *
4849
+ * 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.
4850
+ *
4536
4851
  * GET /v1/issuers
4537
4852
  * @see https://fiscalisto.com/docs/api/referencia/emisores/list-issuers
4538
4853
  */
@@ -4540,6 +4855,8 @@ export declare class IssuersResource {
4540
4855
  /**
4541
4856
  * Ver un emisor
4542
4857
  *
4858
+ * Un emisor: sus datos fiscales, si ya puede timbrar (status, CSD y contrato con el PAC) y su registro patronal.
4859
+ *
4543
4860
  * GET /v1/issuers/{id}
4544
4861
  * @see https://fiscalisto.com/docs/api/referencia/emisores/get-issuer
4545
4862
  */
@@ -4601,6 +4918,8 @@ export declare class IssuersResource {
4601
4918
  /**
4602
4919
  * Ver el portal de autofactura de un emisor
4603
4920
  *
4921
+ * 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.
4922
+ *
4604
4923
  * GET /v1/issuers/{id}/self_invoicing
4605
4924
  * @see https://fiscalisto.com/docs/api/referencia/autofactura/get-self-invoicing
4606
4925
  */
@@ -4649,6 +4968,8 @@ export declare class InvoicesResource {
4649
4968
  /**
4650
4969
  * Descargar el PDF
4651
4970
  *
4971
+ * 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).
4972
+ *
4652
4973
  * GET /v1/invoices/{id}/pdf
4653
4974
  * @see https://fiscalisto.com/docs/api/referencia/facturas/get-invoice-pdf
4654
4975
  */
@@ -4747,6 +5068,8 @@ export declare class BankTransactionsResource {
4747
5068
  /**
4748
5069
  * Ver un depósito
4749
5070
  *
5071
+ * Un depósito mandado a conciliación, con las facturas que se le encontraron o el pago que se registró con él.
5072
+ *
4750
5073
  * GET /v1/bank_transactions/{id}
4751
5074
  * @see https://fiscalisto.com/docs/api/referencia/conciliacion-bancaria/get-bank-transaction
4752
5075
  */
@@ -4823,6 +5146,8 @@ export declare class AdvancesResource {
4823
5146
  /**
4824
5147
  * Listar anticipos sin aplicar
4825
5148
  *
5149
+ * 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.
5150
+ *
4826
5151
  * GET /v1/advances
4827
5152
  * @see https://fiscalisto.com/docs/api/referencia/anticipos/list-advances
4828
5153
  */
@@ -4844,6 +5169,8 @@ export declare class RetentionsResource {
4844
5169
  /**
4845
5170
  * Timbrar una constancia de retenciones
4846
5171
  *
5172
+ * 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.
5173
+ *
4847
5174
  * POST /v1/retentions
4848
5175
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/create-retention
4849
5176
  */
@@ -4851,6 +5178,8 @@ export declare class RetentionsResource {
4851
5178
  /**
4852
5179
  * Listar constancias
4853
5180
  *
5181
+ * Las constancias del emisor, las más recientes primero.
5182
+ *
4854
5183
  * GET /v1/retentions
4855
5184
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/list-retentions
4856
5185
  */
@@ -4858,6 +5187,8 @@ export declare class RetentionsResource {
4858
5187
  /**
4859
5188
  * Ver una constancia
4860
5189
  *
5190
+ * Una constancia de retenciones con su estado, sus impuestos retenidos y, si se mandó, a quién.
5191
+ *
4861
5192
  * GET /v1/retentions/{id}
4862
5193
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/get-retention
4863
5194
  */
@@ -4865,6 +5196,8 @@ export declare class RetentionsResource {
4865
5196
  /**
4866
5197
  * Descargar el PDF
4867
5198
  *
5199
+ * La representación impresa de la constancia.
5200
+ *
4868
5201
  * GET /v1/retentions/{id}/pdf
4869
5202
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/get-retention-pdf
4870
5203
  */
@@ -4872,6 +5205,8 @@ export declare class RetentionsResource {
4872
5205
  /**
4873
5206
  * Descargar el XML
4874
5207
  *
5208
+ * El XML timbrado de la constancia, tal como lo tiene el SAT.
5209
+ *
4875
5210
  * GET /v1/retentions/{id}/xml
4876
5211
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/get-retention-xml
4877
5212
  */
@@ -4879,6 +5214,8 @@ export declare class RetentionsResource {
4879
5214
  /**
4880
5215
  * Enviar por correo
4881
5216
  *
5217
+ * 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.
5218
+ *
4882
5219
  * POST /v1/retentions/{id}/send
4883
5220
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/send-retention
4884
5221
  */
@@ -4900,6 +5237,8 @@ export declare class EmployeesResource {
4900
5237
  /**
4901
5238
  * Crear un empleado
4902
5239
  *
5240
+ * 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.
5241
+ *
4903
5242
  * POST /v1/employees
4904
5243
  * @see https://fiscalisto.com/docs/api/referencia/nomina/create-employee
4905
5244
  */
@@ -4907,6 +5246,8 @@ export declare class EmployeesResource {
4907
5246
  /**
4908
5247
  * Listar empleados
4909
5248
  *
5249
+ * Los empleados del emisor, los más recientes primero.
5250
+ *
4910
5251
  * GET /v1/employees
4911
5252
  * @see https://fiscalisto.com/docs/api/referencia/nomina/list-employees
4912
5253
  */
@@ -4914,6 +5255,8 @@ export declare class EmployeesResource {
4914
5255
  /**
4915
5256
  * Ver un empleado
4916
5257
  *
5258
+ * Un empleado con sus datos y lo que el SAT podría rechazar en warnings.
5259
+ *
4917
5260
  * GET /v1/employees/{id}
4918
5261
  * @see https://fiscalisto.com/docs/api/referencia/nomina/get-employee
4919
5262
  */
@@ -4921,6 +5264,8 @@ export declare class EmployeesResource {
4921
5264
  /**
4922
5265
  * Actualizar un empleado
4923
5266
  *
5267
+ * Cambia solo los campos que manda; los recibos ya timbrados no cambian.
5268
+ *
4924
5269
  * POST /v1/employees/{id}
4925
5270
  * @see https://fiscalisto.com/docs/api/referencia/nomina/update-employee
4926
5271
  */
@@ -4951,6 +5296,8 @@ export declare class PayrollReceiptsResource {
4951
5296
  /**
4952
5297
  * Calcular un recibo sin timbrar
4953
5298
  *
5299
+ * El recibo como se timbraría (percepciones, ISR con el subsidio para el empleo, cuotas IMSS y el neto), sin timbrar ni usar timbres.
5300
+ *
4954
5301
  * POST /v1/payroll_receipts/preview
4955
5302
  * @see https://fiscalisto.com/docs/api/referencia/nomina/preview-payroll-receipt
4956
5303
  */
@@ -4972,6 +5319,8 @@ export declare class InvoiceBatchesResource {
4972
5319
  /**
4973
5320
  * Listar lotes
4974
5321
  *
5322
+ * Los lotes de facturas, los más recientes primero, con cuántas se timbraron y cuántas fallaron.
5323
+ *
4975
5324
  * GET /v1/invoice_batches
4976
5325
  * @see https://fiscalisto.com/docs/api/referencia/lotes/list-invoice-batches
4977
5326
  */
@@ -5007,6 +5356,8 @@ export declare class CustomersResource {
5007
5356
  /**
5008
5357
  * Crear un cliente
5009
5358
  *
5359
+ * 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.
5360
+ *
5010
5361
  * POST /v1/customers
5011
5362
  * @see https://fiscalisto.com/docs/api/referencia/clientes/create-customer
5012
5363
  */
@@ -5014,6 +5365,8 @@ export declare class CustomersResource {
5014
5365
  /**
5015
5366
  * Listar clientes
5016
5367
  *
5368
+ * Los clientes del emisor, los más recientes primero. Con tax_id, el de ese RFC.
5369
+ *
5017
5370
  * GET /v1/customers
5018
5371
  * @see https://fiscalisto.com/docs/api/referencia/clientes/list-customers
5019
5372
  */
@@ -5021,6 +5374,8 @@ export declare class CustomersResource {
5021
5374
  /**
5022
5375
  * Ver un cliente
5023
5376
  *
5377
+ * Un cliente del catálogo.
5378
+ *
5024
5379
  * GET /v1/customers/{id}
5025
5380
  * @see https://fiscalisto.com/docs/api/referencia/clientes/get-customer
5026
5381
  */
@@ -5028,6 +5383,8 @@ export declare class CustomersResource {
5028
5383
  /**
5029
5384
  * Actualizar un cliente
5030
5385
  *
5386
+ * Cambia solo los campos que manda. Las facturas ya timbradas no cambian.
5387
+ *
5031
5388
  * POST /v1/customers/{id}
5032
5389
  * @see https://fiscalisto.com/docs/api/referencia/clientes/update-customer
5033
5390
  */
@@ -5035,6 +5392,8 @@ export declare class CustomersResource {
5035
5392
  /**
5036
5393
  * Borrar un cliente
5037
5394
  *
5395
+ * Lo quita del catálogo. Sus facturas timbradas siguen igual.
5396
+ *
5038
5397
  * DELETE /v1/customers/{id}
5039
5398
  * @see https://fiscalisto.com/docs/api/referencia/clientes/delete-customer
5040
5399
  */
@@ -5056,6 +5415,8 @@ export declare class CustomerDataRequestsResource {
5056
5415
  /**
5057
5416
  * Listar solicitudes de datos
5058
5417
  *
5418
+ * Las ligas para pedir datos fiscales, las más recientes primero, con su estado.
5419
+ *
5059
5420
  * GET /v1/customer_data_requests
5060
5421
  * @see https://fiscalisto.com/docs/api/referencia/clientes/list-customer-data-requests
5061
5422
  */
@@ -5063,6 +5424,8 @@ export declare class CustomerDataRequestsResource {
5063
5424
  /**
5064
5425
  * Ver una solicitud de datos
5065
5426
  *
5427
+ * Una solicitud de datos: su liga y, si el cliente ya contestó, sus datos fiscales y el cliente que se guardó.
5428
+ *
5066
5429
  * GET /v1/customer_data_requests/{id}
5067
5430
  * @see https://fiscalisto.com/docs/api/referencia/clientes/get-customer-data-request
5068
5431
  */
@@ -5084,6 +5447,8 @@ export declare class ProductsResource {
5084
5447
  /**
5085
5448
  * Crear un producto
5086
5449
  *
5450
+ * 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.
5451
+ *
5087
5452
  * POST /v1/products
5088
5453
  * @see https://fiscalisto.com/docs/api/referencia/productos/create-product
5089
5454
  */
@@ -5091,6 +5456,8 @@ export declare class ProductsResource {
5091
5456
  /**
5092
5457
  * Listar productos
5093
5458
  *
5459
+ * Los productos del emisor, los más recientes primero. Filtre por sku o product_key.
5460
+ *
5094
5461
  * GET /v1/products
5095
5462
  * @see https://fiscalisto.com/docs/api/referencia/productos/list-products
5096
5463
  */
@@ -5098,6 +5465,8 @@ export declare class ProductsResource {
5098
5465
  /**
5099
5466
  * Ver un producto
5100
5467
  *
5468
+ * Un producto del catálogo.
5469
+ *
5101
5470
  * GET /v1/products/{id}
5102
5471
  * @see https://fiscalisto.com/docs/api/referencia/productos/get-product
5103
5472
  */
@@ -5105,6 +5474,8 @@ export declare class ProductsResource {
5105
5474
  /**
5106
5475
  * Actualizar un producto
5107
5476
  *
5477
+ * Cambia solo los campos que manda. Las facturas ya timbradas no cambian.
5478
+ *
5108
5479
  * POST /v1/products/{id}
5109
5480
  * @see https://fiscalisto.com/docs/api/referencia/productos/update-product
5110
5481
  */
@@ -5112,6 +5483,8 @@ export declare class ProductsResource {
5112
5483
  /**
5113
5484
  * Borrar un producto
5114
5485
  *
5486
+ * Lo quita del catálogo. Las facturas que lo usaron siguen igual.
5487
+ *
5115
5488
  * DELETE /v1/products/{id}
5116
5489
  * @see https://fiscalisto.com/docs/api/referencia/productos/delete-product
5117
5490
  */
@@ -5170,6 +5543,8 @@ export declare class SatDownloadsResource {
5170
5543
  /**
5171
5544
  * Listar descargas del SAT
5172
5545
  *
5546
+ * Las descargas pedidas al SAT, las más recientes primero, con su estado.
5547
+ *
5173
5548
  * GET /v1/sat_downloads
5174
5549
  * @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/list-sat-downloads
5175
5550
  */
@@ -5177,6 +5552,8 @@ export declare class SatDownloadsResource {
5177
5552
  /**
5178
5553
  * Ver una descarga del SAT
5179
5554
  *
5555
+ * Una descarga del SAT: su periodo, su estado y cuántos CFDI trajo. Al terminar llega sat_download.completed.
5556
+ *
5180
5557
  * GET /v1/sat_downloads/{id}
5181
5558
  * @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/get-sat-download
5182
5559
  */
@@ -5198,6 +5575,8 @@ export declare class SatInvoicesResource {
5198
5575
  /**
5199
5576
  * Ver una factura del SAT
5200
5577
  *
5578
+ * Un CFDI que trajo una descarga del SAT, con sus importes y su estado ante el SAT.
5579
+ *
5201
5580
  * GET /v1/sat_invoices/{id}
5202
5581
  * @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/get-sat-invoice
5203
5582
  */
@@ -5234,9 +5613,20 @@ export declare class SatDeclarationsResource {
5234
5613
  * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/list-sat-declarations
5235
5614
  */
5236
5615
  list(params?: ListSatDeclarationsParams, options?: RequestOptions): List<SatDeclaration>;
5616
+ /**
5617
+ * Ver el año mes por mes
5618
+ *
5619
+ * 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.
5620
+ *
5621
+ * GET /v1/sat_declarations/calendar
5622
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/get-sat-declaration-calendar
5623
+ */
5624
+ calendar(params?: GetSatDeclarationCalendarParams, options?: RequestOptions): Promise<SatDeclarationCalendar>;
5237
5625
  /**
5238
5626
  * Ver una declaración del SAT
5239
5627
  *
5628
+ * Una declaración presentada al SAT, con sus cifras en summary y si ya están su PDF y su acuse.
5629
+ *
5240
5630
  * GET /v1/sat_declarations/{id}
5241
5631
  * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/get-sat-declaration
5242
5632
  */
@@ -5294,6 +5684,8 @@ export declare class TicketsResource {
5294
5684
  /**
5295
5685
  * Ver un ticket
5296
5686
  *
5687
+ * Un ticket de autofactura: si ya se facturó (invoice) o entró en la factura global (global_invoice).
5688
+ *
5297
5689
  * GET /v1/tickets/{id}
5298
5690
  * @see https://fiscalisto.com/docs/api/referencia/autofactura/get-ticket
5299
5691
  */
@@ -5315,7 +5707,7 @@ export declare class AccountingResource {
5315
5707
  /**
5316
5708
  * Listar las pólizas de un mes
5317
5709
  *
5318
- * Una póliza de diario por cada CFDI de ingreso o egreso vigente del mes, emitido o recibido (los recibidos con la categoría de su gasto), con sus cuentas y código agrupador del SAT. En pesos; un CFDI en otra moneda sin tipo de cambio no se registra. Es un punto de partida para su contador: no incluye bancos, nómina ni depreciaciones.
5710
+ * Las pólizas de diario del mes, con sus cuentas y código agrupador del SAT: una por cada CFDI de ingreso o egreso vigente, emitido o recibido (los recibidos con la categoría de su gasto); una por cada pago de un complemento; una por cada recibo de nómina, y una con la depreciación de los activos fijos. Un PUE se registra cobrado o pagado según su forma de pago. En pesos; un CFDI en otra moneda sin tipo de cambio no se registra. No incluye movimientos de banco sin CFDI ni provisiones.
5319
5711
  *
5320
5712
  * GET /v1/accounting/journal_entries
5321
5713
  * @see https://fiscalisto.com/docs/api/referencia/contabilidad/list-journal-entries
@@ -5324,12 +5716,30 @@ export declare class AccountingResource {
5324
5716
  /**
5325
5717
  * Ver la balanza de comprobación
5326
5718
  *
5327
- * Saldo inicial, cargos, abonos y saldo final de cada cuenta en el mes. Los saldos iniciales se acumulan desde el primer CFDI (las de resultados, desde enero), y los resultados de cada año anterior se cierran a capital.
5719
+ * Saldo inicial, cargos, abonos y saldo final de cada cuenta en el mes. Los saldos iniciales se acumulan desde el primer CFDI, o desde los saldos iniciales capturados en la app (las de resultados, desde enero), y los resultados de cada año anterior se cierran a capital.
5328
5720
  *
5329
5721
  * GET /v1/accounting/trial_balance
5330
5722
  * @see https://fiscalisto.com/docs/api/referencia/contabilidad/get-trial-balance
5331
5723
  */
5332
5724
  trialBalance(params: GetTrialBalanceParams, options?: RequestOptions): Promise<TrialBalance>;
5725
+ /**
5726
+ * Ver los estados financieros
5727
+ *
5728
+ * El estado de resultados (del mes y del año hasta ese mes) y el balance general al cierre del mes, leídos de la misma balanza, así que siempre suman las mismas pólizas.
5729
+ *
5730
+ * GET /v1/accounting/financial_statements
5731
+ * @see https://fiscalisto.com/docs/api/referencia/contabilidad/get-financial-statements
5732
+ */
5733
+ financialStatements(params: GetFinancialStatementsParams, options?: RequestOptions): Promise<FinancialStatements>;
5734
+ /**
5735
+ * Cruzar lo declarado con lo facturado
5736
+ *
5737
+ * Cada mes ya vencido del año: el IVA trasladado, acreditable y retenido y los ingresos para ISR que el emisor declaró (de GET /v1/sat_declarations, después de POST /v1/sat_declarations/refresh) contra lo que dicen sus CFDI. Hasta $2 de diferencia es redondeo (las declaraciones van en pesos enteros). Una cifra que la declaración no trae en un renglón reconocible es unreadable con declared null, nunca 0. También el IVA a favor y el régimen con que factura. Gratis: no consulta al SAT.
5738
+ *
5739
+ * GET /v1/accounting/cross_checks
5740
+ * @see https://fiscalisto.com/docs/api/referencia/contabilidad/get-cross-checks
5741
+ */
5742
+ crossChecks(params?: GetCrossChecksParams, options?: RequestOptions): Promise<CrossChecks>;
5333
5743
  /**
5334
5744
  * Ver el catálogo de cuentas
5335
5745
  *
@@ -5392,6 +5802,8 @@ export declare class StoreConnectionsResource {
5392
5802
  /**
5393
5803
  * Ver una tienda
5394
5804
  *
5805
+ * Una tienda conectada (Shopify, Mercado Libre o WooCommerce), su estado y lo último que importó.
5806
+ *
5395
5807
  * GET /v1/store_connections/{id}
5396
5808
  * @see https://fiscalisto.com/docs/api/referencia/tiendas-en-linea/get-store-connection
5397
5809
  */
@@ -5449,6 +5861,8 @@ export declare class RecurringInvoicesResource {
5449
5861
  /**
5450
5862
  * Ver una factura recurrente
5451
5863
  *
5864
+ * Una factura recurrente: su calendario, la próxima fecha, la última factura que timbró y, si falló, por qué en last_error.
5865
+ *
5452
5866
  * GET /v1/recurring_invoices/{id}
5453
5867
  * @see https://fiscalisto.com/docs/api/referencia/facturas-recurrentes/get-recurring-invoice
5454
5868
  */
@@ -5592,6 +6006,8 @@ export declare class WebhookEndpointsResource {
5592
6006
  /**
5593
6007
  * Listar webhooks
5594
6008
  *
6009
+ * Los webhooks del modo de la llave. Hasta 16 por modo.
6010
+ *
5595
6011
  * GET /v1/webhook_endpoints
5596
6012
  * @see https://fiscalisto.com/docs/api/referencia/webhooks/list-webhook-endpoints
5597
6013
  */
@@ -5599,6 +6015,8 @@ export declare class WebhookEndpointsResource {
5599
6015
  /**
5600
6016
  * Ver un webhook
5601
6017
  *
6018
+ * Un webhook: su dirección, los eventos que recibe y si sus entregas fallan. El secreto solo viene al crearlo.
6019
+ *
5602
6020
  * GET /v1/webhook_endpoints/{id}
5603
6021
  * @see https://fiscalisto.com/docs/api/referencia/webhooks/get-webhook-endpoint
5604
6022
  */
@@ -5606,6 +6024,8 @@ export declare class WebhookEndpointsResource {
5606
6024
  /**
5607
6025
  * Actualizar un webhook
5608
6026
  *
6027
+ * 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ó.
6028
+ *
5609
6029
  * POST /v1/webhook_endpoints/{id}
5610
6030
  * @see https://fiscalisto.com/docs/api/referencia/webhooks/update-webhook-endpoint
5611
6031
  */
@@ -5613,6 +6033,8 @@ export declare class WebhookEndpointsResource {
5613
6033
  /**
5614
6034
  * Borrar un webhook
5615
6035
  *
6036
+ * Deja de mandar eventos a esa dirección. Los eventos siguen en GET /v1/events.
6037
+ *
5616
6038
  * DELETE /v1/webhook_endpoints/{id}
5617
6039
  * @see https://fiscalisto.com/docs/api/referencia/webhooks/delete-webhook-endpoint
5618
6040
  */
@@ -5652,6 +6074,8 @@ export declare class EventsResource {
5652
6074
  /**
5653
6075
  * Ver un evento
5654
6076
  *
6077
+ * Un evento de los últimos 30 días, con el objeto como estaba cuando pasó.
6078
+ *
5655
6079
  * GET /v1/events/{id}
5656
6080
  * @see https://fiscalisto.com/docs/api/referencia/eventos/get-event
5657
6081
  */