fiscalisto 0.1.2 → 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_). */
@@ -1644,9 +1693,9 @@ export interface CrossChecks {
1644
1693
  status: "matches" | "differs" | "not_filed" | "unreadable";
1645
1694
  /** Un cruce por cifra. */
1646
1695
  checks: {
1647
- /** Qué cifra: vat_charged (IVA trasladado), vat_creditable (IVA acreditable), vat_withheld (IVA que le retuvieron) o isr_income (ingresos para ISR: nominales en persona moral, cobrados en los demás). */
1648
- key: "vat_charged" | "vat_creditable" | "vat_withheld" | "isr_income";
1649
- /** matches (hasta $2 de diferencia), differs, not_filed (no hay declaración del mes) o unreadable (la declaración no trae la cifra en un renglón reconocible). */
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). */
1650
1699
  status: "matches" | "differs" | "not_filed" | "unreadable";
1651
1700
  /** Lo declarado, en pesos; null si no hay declaración o no se pudo leer. */
1652
1701
  declared: number | null;
@@ -2053,14 +2102,14 @@ export interface WebhookTest {
2053
2102
  };
2054
2103
  }
2055
2104
  /** Lo que puede pasar: el tipo de cada evento. */
2056
- 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";
2057
2106
  /** Algo que pasó en su cuenta: el objeto completo como quedó. Se manda a sus webhooks firmado (Standard Webhooks). */
2058
2107
  export interface EventBase<T extends EventType = EventType, O = unknown> {
2059
2108
  /** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
2060
2109
  id: string;
2061
2110
  /** Qué tipo de objeto es («invoice», «customer»…). */
2062
2111
  object: "event";
2063
- /** 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. */
2064
2113
  type: T;
2065
2114
  /** Versión de la API con que se armó el objeto. */
2066
2115
  api_version: string;
@@ -2074,7 +2123,7 @@ export interface EventBase<T extends EventType = EventType, O = unknown> {
2074
2123
  };
2075
2124
  }
2076
2125
  /** Un evento: según su type, data.object es la factura, la constancia o el lote. */
2077
- 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>;
2078
2127
  /** Confirmación de que se borró. */
2079
2128
  export interface Deleted {
2080
2129
  /** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
@@ -3290,7 +3339,7 @@ export interface SendInvoiceParams {
3290
3339
  cc?: string | null;
3291
3340
  }
3292
3341
  export interface CancelInvoiceParams {
3293
- /** 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. */
3294
3343
  motive?: "01" | "02" | "03" | "04";
3295
3344
  /** El comprobante que sustituye a este (su id o su UUID), con el motivo 01. */
3296
3345
  substitution?: string;
@@ -3614,7 +3663,7 @@ export interface SendRetentionParams {
3614
3663
  to?: string;
3615
3664
  }
3616
3665
  export interface CancelRetentionParams {
3617
- /** 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. */
3618
3667
  motive?: "01" | "02" | "03" | "04";
3619
3668
  /** El comprobante que sustituye a este (su id o su UUID), con el motivo 01. */
3620
3669
  substitution?: string;
@@ -4028,6 +4077,17 @@ export interface ListSatDeclarationsParams {
4028
4077
  year?: number;
4029
4078
  /** monthly (provisionales o definitivas), annual (la anual) o dyp (Declaraciones y pagos). */
4030
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;
4031
4091
  }
4032
4092
  export interface CreateTicketParams {
4033
4093
  /** El emisor (iss_…) que vendió. Por omisión, su único emisor. */
@@ -4624,7 +4684,7 @@ export interface RollWebhookSecretParams {
4624
4684
  }
4625
4685
  export interface TestWebhookEndpointParams {
4626
4686
  /** El evento a mandar. Por omisión invoice.stamped. */
4627
- 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";
4628
4688
  }
4629
4689
  /** Los parámetros de GET /v1/events. */
4630
4690
  export interface ListEventsParams {
@@ -4633,7 +4693,7 @@ export interface ListEventsParams {
4633
4693
  /** El id del último de la página anterior, para la siguiente. */
4634
4694
  starting_after?: string;
4635
4695
  /** Solo de este tipo. */
4636
- 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";
4637
4697
  /** Solo los de este objeto (inv_…, ret_…, bat_…). */
4638
4698
  object?: string;
4639
4699
  }
@@ -4690,6 +4750,8 @@ export declare class SandboxesResource {
4690
4750
  /**
4691
4751
  * Listar entornos de prueba
4692
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
+ *
4693
4755
  * GET /v1/sandboxes
4694
4756
  * @see https://fiscalisto.com/docs/api/referencia/entornos-de-prueba/list-sandboxes
4695
4757
  */
@@ -4697,6 +4759,8 @@ export declare class SandboxesResource {
4697
4759
  /**
4698
4760
  * Ver un entorno de prueba
4699
4761
  *
4762
+ * Un entorno de prueba: su nombre, su emisor y lo que lleva usado hoy de sus reinicios.
4763
+ *
4700
4764
  * GET /v1/sandboxes/{id}
4701
4765
  * @see https://fiscalisto.com/docs/api/referencia/entornos-de-prueba/get-sandbox
4702
4766
  */
@@ -4727,6 +4791,8 @@ export declare class TestClocksResource {
4727
4791
  /**
4728
4792
  * Ver el reloj de prueba
4729
4793
  *
4794
+ * La hora que es «hoy» para un emisor de prueba y hasta dónde se ha adelantado. Solo emisores de prueba.
4795
+ *
4730
4796
  * GET /v1/issuers/{id}/test_clock
4731
4797
  * @see https://fiscalisto.com/docs/api/referencia/entornos-de-prueba/get-test-clock
4732
4798
  */
@@ -4780,6 +4846,8 @@ export declare class IssuersResource {
4780
4846
  /**
4781
4847
  * Listar emisores
4782
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
+ *
4783
4851
  * GET /v1/issuers
4784
4852
  * @see https://fiscalisto.com/docs/api/referencia/emisores/list-issuers
4785
4853
  */
@@ -4787,6 +4855,8 @@ export declare class IssuersResource {
4787
4855
  /**
4788
4856
  * Ver un emisor
4789
4857
  *
4858
+ * Un emisor: sus datos fiscales, si ya puede timbrar (status, CSD y contrato con el PAC) y su registro patronal.
4859
+ *
4790
4860
  * GET /v1/issuers/{id}
4791
4861
  * @see https://fiscalisto.com/docs/api/referencia/emisores/get-issuer
4792
4862
  */
@@ -4848,6 +4918,8 @@ export declare class IssuersResource {
4848
4918
  /**
4849
4919
  * Ver el portal de autofactura de un emisor
4850
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
+ *
4851
4923
  * GET /v1/issuers/{id}/self_invoicing
4852
4924
  * @see https://fiscalisto.com/docs/api/referencia/autofactura/get-self-invoicing
4853
4925
  */
@@ -4896,6 +4968,8 @@ export declare class InvoicesResource {
4896
4968
  /**
4897
4969
  * Descargar el PDF
4898
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
+ *
4899
4973
  * GET /v1/invoices/{id}/pdf
4900
4974
  * @see https://fiscalisto.com/docs/api/referencia/facturas/get-invoice-pdf
4901
4975
  */
@@ -4994,6 +5068,8 @@ export declare class BankTransactionsResource {
4994
5068
  /**
4995
5069
  * Ver un depósito
4996
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
+ *
4997
5073
  * GET /v1/bank_transactions/{id}
4998
5074
  * @see https://fiscalisto.com/docs/api/referencia/conciliacion-bancaria/get-bank-transaction
4999
5075
  */
@@ -5070,6 +5146,8 @@ export declare class AdvancesResource {
5070
5146
  /**
5071
5147
  * Listar anticipos sin aplicar
5072
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
+ *
5073
5151
  * GET /v1/advances
5074
5152
  * @see https://fiscalisto.com/docs/api/referencia/anticipos/list-advances
5075
5153
  */
@@ -5091,6 +5169,8 @@ export declare class RetentionsResource {
5091
5169
  /**
5092
5170
  * Timbrar una constancia de retenciones
5093
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
+ *
5094
5174
  * POST /v1/retentions
5095
5175
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/create-retention
5096
5176
  */
@@ -5098,6 +5178,8 @@ export declare class RetentionsResource {
5098
5178
  /**
5099
5179
  * Listar constancias
5100
5180
  *
5181
+ * Las constancias del emisor, las más recientes primero.
5182
+ *
5101
5183
  * GET /v1/retentions
5102
5184
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/list-retentions
5103
5185
  */
@@ -5105,6 +5187,8 @@ export declare class RetentionsResource {
5105
5187
  /**
5106
5188
  * Ver una constancia
5107
5189
  *
5190
+ * Una constancia de retenciones con su estado, sus impuestos retenidos y, si se mandó, a quién.
5191
+ *
5108
5192
  * GET /v1/retentions/{id}
5109
5193
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/get-retention
5110
5194
  */
@@ -5112,6 +5196,8 @@ export declare class RetentionsResource {
5112
5196
  /**
5113
5197
  * Descargar el PDF
5114
5198
  *
5199
+ * La representación impresa de la constancia.
5200
+ *
5115
5201
  * GET /v1/retentions/{id}/pdf
5116
5202
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/get-retention-pdf
5117
5203
  */
@@ -5119,6 +5205,8 @@ export declare class RetentionsResource {
5119
5205
  /**
5120
5206
  * Descargar el XML
5121
5207
  *
5208
+ * El XML timbrado de la constancia, tal como lo tiene el SAT.
5209
+ *
5122
5210
  * GET /v1/retentions/{id}/xml
5123
5211
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/get-retention-xml
5124
5212
  */
@@ -5126,6 +5214,8 @@ export declare class RetentionsResource {
5126
5214
  /**
5127
5215
  * Enviar por correo
5128
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
+ *
5129
5219
  * POST /v1/retentions/{id}/send
5130
5220
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/send-retention
5131
5221
  */
@@ -5147,6 +5237,8 @@ export declare class EmployeesResource {
5147
5237
  /**
5148
5238
  * Crear un empleado
5149
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
+ *
5150
5242
  * POST /v1/employees
5151
5243
  * @see https://fiscalisto.com/docs/api/referencia/nomina/create-employee
5152
5244
  */
@@ -5154,6 +5246,8 @@ export declare class EmployeesResource {
5154
5246
  /**
5155
5247
  * Listar empleados
5156
5248
  *
5249
+ * Los empleados del emisor, los más recientes primero.
5250
+ *
5157
5251
  * GET /v1/employees
5158
5252
  * @see https://fiscalisto.com/docs/api/referencia/nomina/list-employees
5159
5253
  */
@@ -5161,6 +5255,8 @@ export declare class EmployeesResource {
5161
5255
  /**
5162
5256
  * Ver un empleado
5163
5257
  *
5258
+ * Un empleado con sus datos y lo que el SAT podría rechazar en warnings.
5259
+ *
5164
5260
  * GET /v1/employees/{id}
5165
5261
  * @see https://fiscalisto.com/docs/api/referencia/nomina/get-employee
5166
5262
  */
@@ -5168,6 +5264,8 @@ export declare class EmployeesResource {
5168
5264
  /**
5169
5265
  * Actualizar un empleado
5170
5266
  *
5267
+ * Cambia solo los campos que manda; los recibos ya timbrados no cambian.
5268
+ *
5171
5269
  * POST /v1/employees/{id}
5172
5270
  * @see https://fiscalisto.com/docs/api/referencia/nomina/update-employee
5173
5271
  */
@@ -5198,6 +5296,8 @@ export declare class PayrollReceiptsResource {
5198
5296
  /**
5199
5297
  * Calcular un recibo sin timbrar
5200
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
+ *
5201
5301
  * POST /v1/payroll_receipts/preview
5202
5302
  * @see https://fiscalisto.com/docs/api/referencia/nomina/preview-payroll-receipt
5203
5303
  */
@@ -5219,6 +5319,8 @@ export declare class InvoiceBatchesResource {
5219
5319
  /**
5220
5320
  * Listar lotes
5221
5321
  *
5322
+ * Los lotes de facturas, los más recientes primero, con cuántas se timbraron y cuántas fallaron.
5323
+ *
5222
5324
  * GET /v1/invoice_batches
5223
5325
  * @see https://fiscalisto.com/docs/api/referencia/lotes/list-invoice-batches
5224
5326
  */
@@ -5254,6 +5356,8 @@ export declare class CustomersResource {
5254
5356
  /**
5255
5357
  * Crear un cliente
5256
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
+ *
5257
5361
  * POST /v1/customers
5258
5362
  * @see https://fiscalisto.com/docs/api/referencia/clientes/create-customer
5259
5363
  */
@@ -5261,6 +5365,8 @@ export declare class CustomersResource {
5261
5365
  /**
5262
5366
  * Listar clientes
5263
5367
  *
5368
+ * Los clientes del emisor, los más recientes primero. Con tax_id, el de ese RFC.
5369
+ *
5264
5370
  * GET /v1/customers
5265
5371
  * @see https://fiscalisto.com/docs/api/referencia/clientes/list-customers
5266
5372
  */
@@ -5268,6 +5374,8 @@ export declare class CustomersResource {
5268
5374
  /**
5269
5375
  * Ver un cliente
5270
5376
  *
5377
+ * Un cliente del catálogo.
5378
+ *
5271
5379
  * GET /v1/customers/{id}
5272
5380
  * @see https://fiscalisto.com/docs/api/referencia/clientes/get-customer
5273
5381
  */
@@ -5275,6 +5383,8 @@ export declare class CustomersResource {
5275
5383
  /**
5276
5384
  * Actualizar un cliente
5277
5385
  *
5386
+ * Cambia solo los campos que manda. Las facturas ya timbradas no cambian.
5387
+ *
5278
5388
  * POST /v1/customers/{id}
5279
5389
  * @see https://fiscalisto.com/docs/api/referencia/clientes/update-customer
5280
5390
  */
@@ -5282,6 +5392,8 @@ export declare class CustomersResource {
5282
5392
  /**
5283
5393
  * Borrar un cliente
5284
5394
  *
5395
+ * Lo quita del catálogo. Sus facturas timbradas siguen igual.
5396
+ *
5285
5397
  * DELETE /v1/customers/{id}
5286
5398
  * @see https://fiscalisto.com/docs/api/referencia/clientes/delete-customer
5287
5399
  */
@@ -5303,6 +5415,8 @@ export declare class CustomerDataRequestsResource {
5303
5415
  /**
5304
5416
  * Listar solicitudes de datos
5305
5417
  *
5418
+ * Las ligas para pedir datos fiscales, las más recientes primero, con su estado.
5419
+ *
5306
5420
  * GET /v1/customer_data_requests
5307
5421
  * @see https://fiscalisto.com/docs/api/referencia/clientes/list-customer-data-requests
5308
5422
  */
@@ -5310,6 +5424,8 @@ export declare class CustomerDataRequestsResource {
5310
5424
  /**
5311
5425
  * Ver una solicitud de datos
5312
5426
  *
5427
+ * Una solicitud de datos: su liga y, si el cliente ya contestó, sus datos fiscales y el cliente que se guardó.
5428
+ *
5313
5429
  * GET /v1/customer_data_requests/{id}
5314
5430
  * @see https://fiscalisto.com/docs/api/referencia/clientes/get-customer-data-request
5315
5431
  */
@@ -5331,6 +5447,8 @@ export declare class ProductsResource {
5331
5447
  /**
5332
5448
  * Crear un producto
5333
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
+ *
5334
5452
  * POST /v1/products
5335
5453
  * @see https://fiscalisto.com/docs/api/referencia/productos/create-product
5336
5454
  */
@@ -5338,6 +5456,8 @@ export declare class ProductsResource {
5338
5456
  /**
5339
5457
  * Listar productos
5340
5458
  *
5459
+ * Los productos del emisor, los más recientes primero. Filtre por sku o product_key.
5460
+ *
5341
5461
  * GET /v1/products
5342
5462
  * @see https://fiscalisto.com/docs/api/referencia/productos/list-products
5343
5463
  */
@@ -5345,6 +5465,8 @@ export declare class ProductsResource {
5345
5465
  /**
5346
5466
  * Ver un producto
5347
5467
  *
5468
+ * Un producto del catálogo.
5469
+ *
5348
5470
  * GET /v1/products/{id}
5349
5471
  * @see https://fiscalisto.com/docs/api/referencia/productos/get-product
5350
5472
  */
@@ -5352,6 +5474,8 @@ export declare class ProductsResource {
5352
5474
  /**
5353
5475
  * Actualizar un producto
5354
5476
  *
5477
+ * Cambia solo los campos que manda. Las facturas ya timbradas no cambian.
5478
+ *
5355
5479
  * POST /v1/products/{id}
5356
5480
  * @see https://fiscalisto.com/docs/api/referencia/productos/update-product
5357
5481
  */
@@ -5359,6 +5483,8 @@ export declare class ProductsResource {
5359
5483
  /**
5360
5484
  * Borrar un producto
5361
5485
  *
5486
+ * Lo quita del catálogo. Las facturas que lo usaron siguen igual.
5487
+ *
5362
5488
  * DELETE /v1/products/{id}
5363
5489
  * @see https://fiscalisto.com/docs/api/referencia/productos/delete-product
5364
5490
  */
@@ -5417,6 +5543,8 @@ export declare class SatDownloadsResource {
5417
5543
  /**
5418
5544
  * Listar descargas del SAT
5419
5545
  *
5546
+ * Las descargas pedidas al SAT, las más recientes primero, con su estado.
5547
+ *
5420
5548
  * GET /v1/sat_downloads
5421
5549
  * @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/list-sat-downloads
5422
5550
  */
@@ -5424,6 +5552,8 @@ export declare class SatDownloadsResource {
5424
5552
  /**
5425
5553
  * Ver una descarga del SAT
5426
5554
  *
5555
+ * Una descarga del SAT: su periodo, su estado y cuántos CFDI trajo. Al terminar llega sat_download.completed.
5556
+ *
5427
5557
  * GET /v1/sat_downloads/{id}
5428
5558
  * @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/get-sat-download
5429
5559
  */
@@ -5445,6 +5575,8 @@ export declare class SatInvoicesResource {
5445
5575
  /**
5446
5576
  * Ver una factura del SAT
5447
5577
  *
5578
+ * Un CFDI que trajo una descarga del SAT, con sus importes y su estado ante el SAT.
5579
+ *
5448
5580
  * GET /v1/sat_invoices/{id}
5449
5581
  * @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/get-sat-invoice
5450
5582
  */
@@ -5481,9 +5613,20 @@ export declare class SatDeclarationsResource {
5481
5613
  * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/list-sat-declarations
5482
5614
  */
5483
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>;
5484
5625
  /**
5485
5626
  * Ver una declaración del SAT
5486
5627
  *
5628
+ * Una declaración presentada al SAT, con sus cifras en summary y si ya están su PDF y su acuse.
5629
+ *
5487
5630
  * GET /v1/sat_declarations/{id}
5488
5631
  * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/get-sat-declaration
5489
5632
  */
@@ -5541,6 +5684,8 @@ export declare class TicketsResource {
5541
5684
  /**
5542
5685
  * Ver un ticket
5543
5686
  *
5687
+ * Un ticket de autofactura: si ya se facturó (invoice) o entró en la factura global (global_invoice).
5688
+ *
5544
5689
  * GET /v1/tickets/{id}
5545
5690
  * @see https://fiscalisto.com/docs/api/referencia/autofactura/get-ticket
5546
5691
  */
@@ -5657,6 +5802,8 @@ export declare class StoreConnectionsResource {
5657
5802
  /**
5658
5803
  * Ver una tienda
5659
5804
  *
5805
+ * Una tienda conectada (Shopify, Mercado Libre o WooCommerce), su estado y lo último que importó.
5806
+ *
5660
5807
  * GET /v1/store_connections/{id}
5661
5808
  * @see https://fiscalisto.com/docs/api/referencia/tiendas-en-linea/get-store-connection
5662
5809
  */
@@ -5714,6 +5861,8 @@ export declare class RecurringInvoicesResource {
5714
5861
  /**
5715
5862
  * Ver una factura recurrente
5716
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
+ *
5717
5866
  * GET /v1/recurring_invoices/{id}
5718
5867
  * @see https://fiscalisto.com/docs/api/referencia/facturas-recurrentes/get-recurring-invoice
5719
5868
  */
@@ -5857,6 +6006,8 @@ export declare class WebhookEndpointsResource {
5857
6006
  /**
5858
6007
  * Listar webhooks
5859
6008
  *
6009
+ * Los webhooks del modo de la llave. Hasta 16 por modo.
6010
+ *
5860
6011
  * GET /v1/webhook_endpoints
5861
6012
  * @see https://fiscalisto.com/docs/api/referencia/webhooks/list-webhook-endpoints
5862
6013
  */
@@ -5864,6 +6015,8 @@ export declare class WebhookEndpointsResource {
5864
6015
  /**
5865
6016
  * Ver un webhook
5866
6017
  *
6018
+ * Un webhook: su dirección, los eventos que recibe y si sus entregas fallan. El secreto solo viene al crearlo.
6019
+ *
5867
6020
  * GET /v1/webhook_endpoints/{id}
5868
6021
  * @see https://fiscalisto.com/docs/api/referencia/webhooks/get-webhook-endpoint
5869
6022
  */
@@ -5871,6 +6024,8 @@ export declare class WebhookEndpointsResource {
5871
6024
  /**
5872
6025
  * Actualizar un webhook
5873
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
+ *
5874
6029
  * POST /v1/webhook_endpoints/{id}
5875
6030
  * @see https://fiscalisto.com/docs/api/referencia/webhooks/update-webhook-endpoint
5876
6031
  */
@@ -5878,6 +6033,8 @@ export declare class WebhookEndpointsResource {
5878
6033
  /**
5879
6034
  * Borrar un webhook
5880
6035
  *
6036
+ * Deja de mandar eventos a esa dirección. Los eventos siguen en GET /v1/events.
6037
+ *
5881
6038
  * DELETE /v1/webhook_endpoints/{id}
5882
6039
  * @see https://fiscalisto.com/docs/api/referencia/webhooks/delete-webhook-endpoint
5883
6040
  */
@@ -5917,6 +6074,8 @@ export declare class EventsResource {
5917
6074
  /**
5918
6075
  * Ver un evento
5919
6076
  *
6077
+ * Un evento de los últimos 30 días, con el objeto como estaba cuando pasó.
6078
+ *
5920
6079
  * GET /v1/events/{id}
5921
6080
  * @see https://fiscalisto.com/docs/api/referencia/eventos/get-event
5922
6081
  */