fiscalisto 0.1.0 → 0.1.1

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.
@@ -9,6 +9,10 @@ export interface Account {
9
9
  object: "account";
10
10
  /** El nombre de la cuenta API. */
11
11
  name: string;
12
+ /** La versión de la API de la cuenta (la de sus solicitudes sin Fiscalisto-Version). Ver Versiones. */
13
+ api_version: string;
14
+ /** La versión más reciente de la API. */
15
+ latest_api_version: string;
12
16
  /** La llave con que se hizo la solicitud: id, nombre y emisores a los que se limita. */
13
17
  key: {
14
18
  /** Id de la llave. */
@@ -524,6 +528,8 @@ export interface Customer {
524
528
  } | null;
525
529
  /** true si el cliente es contribuyente de IEPS: el IEPS va desglosado en vez de sumado al precio. */
526
530
  ieps_taxpayer: boolean;
531
+ /** Cuándo se creó, ISO 8601 con la hora de la Ciudad de México (-06:00). */
532
+ created_at: string;
527
533
  /** Cuándo cambió por última vez, ISO 8601 (-06:00). */
528
534
  updated_at: string | null;
529
535
  }
@@ -551,6 +557,8 @@ export interface Product {
551
557
  sku: string | null;
552
558
  /** Precio unitario antes de impuestos (ValorUnitario). */
553
559
  unit_price: number;
560
+ /** Precio abierto: el producto no tiene precio fijo y cada concepto con él manda su unit_price. */
561
+ open_price: boolean;
554
562
  /** Objeto de impuesto (ObjetoImp), c_ObjetoImp: 01 no objeto, 02 sí objeto (por omisión), 03 sin desglose, 04 no causa… */
555
563
  taxability: string;
556
564
  /** Tasa de IVA trasladado: 0.16 (por omisión), 0.08 (región fronteriza), 0 o exento. */
@@ -563,6 +571,17 @@ export interface Product {
563
571
  iva_retention: number;
564
572
  /** Tasa de ISR retenido (por ejemplo 0.10 honorarios, 0.0125 RESICO). */
565
573
  isr_retention: number;
574
+ /** Impuestos locales (complemento implocal): traslados y retenciones estatales. */
575
+ local_taxes: {
576
+ /** true si es una retención local; false si es un traslado. */
577
+ retention: boolean;
578
+ /** Nombre del impuesto local (ImpLocTrasladado o ImpLocRetenido), como ISH. */
579
+ name: string;
580
+ /** Tasa en por ciento (TasadeTraslado o TasadeRetencion). */
581
+ rate: number;
582
+ }[];
583
+ /** Cuándo se creó, ISO 8601 con la hora de la Ciudad de México (-06:00). */
584
+ created_at: string;
566
585
  /** Cuándo cambió por última vez, ISO 8601 (-06:00). */
567
586
  updated_at: string | null;
568
587
  }
@@ -620,6 +639,8 @@ export interface Employee {
620
639
  position: string | null;
621
640
  /** Lo que el SAT podría observar de sus datos, antes de timbrar. */
622
641
  warnings: string[];
642
+ /** Cuándo se creó, ISO 8601 con la hora de la Ciudad de México (-06:00). */
643
+ created_at: string;
623
644
  }
624
645
  /** El recibo como se timbraría: percepciones, deducciones (ISR, IMSS), otros pagos (subsidio) y el neto. */
625
646
  export interface PayrollReceiptPreview {
@@ -1108,6 +1129,113 @@ export interface SatInvoice {
1108
1129
  /** Cuándo llegó. */
1109
1130
  downloaded_at: string | null;
1110
1131
  }
1132
+ /** Una declaración que el emisor presentó ante el SAT (provisional o definitiva, anual o del servicio anterior Declaraciones y pagos), con sus cifras y sus archivos. */
1133
+ export interface SatDeclaration {
1134
+ /** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
1135
+ id: string;
1136
+ /** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
1137
+ livemode: boolean;
1138
+ /** Qué tipo de objeto es («invoice», «customer»…). */
1139
+ object: "sat_declaration";
1140
+ /** El emisor que la presentó. */
1141
+ issuer: string;
1142
+ /** monthly (provisional o definitiva, desde 2022), annual (la anual de persona moral) o dyp (el servicio anterior Declaraciones y pagos, 2021 y antes). */
1143
+ source: "monthly" | "annual" | "dyp";
1144
+ /** El ejercicio. */
1145
+ year: number;
1146
+ /** El mes (1 a 12), o null en la anual y otros periodos. */
1147
+ month: number | null;
1148
+ /** El periodo como lo nombra el SAT: «Enero», «Del Ejercicio»… */
1149
+ period: string;
1150
+ /** normal o complementary (complementaria). */
1151
+ type: "normal" | "complementary";
1152
+ /** El tipo de complementaria como lo dice el SAT («Modificación de obligaciones»…), o null. */
1153
+ complementary_type: string | null;
1154
+ /** El número de operación que le dio el SAT. */
1155
+ operation_number: string;
1156
+ /** La línea de captura, si hubo algo a pagar. */
1157
+ payment_line: string | null;
1158
+ /** Cuándo se presentó (AAAA-MM-DD). */
1159
+ filed_on: string | null;
1160
+ /** El coeficiente de utilidad que aplicó (ISR de personas morales), o null. */
1161
+ profit_coefficient: number | null;
1162
+ /** El ISR a cargo, según el acuse. */
1163
+ isr_due: number | null;
1164
+ /** El IVA a cargo, según el acuse. */
1165
+ vat_due: number | null;
1166
+ /** El total a pagar, según el acuse. */
1167
+ total_due: number | null;
1168
+ /** Las cifras de la declaración por impuesto (tax), cada una con su texto como lo imprime el SAT (label) y su valor. Vacío en las de Declaraciones y pagos (su PDF trae dos columnas que no se leen con certeza) o si el PDF aún no llega. */
1169
+ sections: {
1170
+ /** Impuesto: isr, iva o ieps (ImpuestoRet 001, 002, 003). */
1171
+ tax: string;
1172
+ /** Los renglones del impuesto, en el orden del PDF. */
1173
+ fields: {
1174
+ /** El renglón como lo imprime el SAT. */
1175
+ label: string;
1176
+ /** Valor de la mercancía (ValorMercancia); obligatorio en transporte aéreo. */
1177
+ value: number | string;
1178
+ }[];
1179
+ }[];
1180
+ /** Lo que dice el acuse: cada concepto con su cantidad a cargo y a pagar, el total, la línea de captura y su vigencia. null si el acuse aún no llega. */
1181
+ receipt: {
1182
+ /** Cada impuesto del acuse. */
1183
+ concepts: {
1184
+ /** Concepto del pago (ConceptoPago), c_TipoContribuyenteSujetoRetencion. */
1185
+ concept: string;
1186
+ /** Lo que resultó a cargo. */
1187
+ due: number | null;
1188
+ /** La cantidad a cargo. */
1189
+ amount_due: number | null;
1190
+ /** La cantidad a pagar. */
1191
+ amount_to_pay: number | null;
1192
+ }[];
1193
+ /** Total en la moneda del comprobante (Total). */
1194
+ total: number | null;
1195
+ /** La línea de captura del acuse. */
1196
+ payment_line: string | null;
1197
+ /** Hasta cuándo sirve la línea de captura (AAAA-MM-DD). */
1198
+ valid_until: string | null;
1199
+ } | null;
1200
+ /** Qué archivos ya tiene: pdf (GET …/pdf), receipt (GET …/receipt) y financial_statements (GET …/financial_statements, solo en la anual de persona moral). */
1201
+ files: {
1202
+ /** Si ya tiene la declaración en PDF (GET …/pdf). */
1203
+ pdf: boolean;
1204
+ /** Si ya tiene el acuse (GET …/receipt). */
1205
+ receipt: boolean;
1206
+ /** Si ya tiene el Excel de estados financieros (GET …/financial_statements), solo en la anual de persona moral. */
1207
+ financial_statements: boolean;
1208
+ };
1209
+ /** Por qué falta un archivo, como lo dijo el SAT (por ejemplo «No se puede generar el archivo»). Se vuelve a pedir en la siguiente consulta. */
1210
+ files_error: string | null;
1211
+ /** Cuándo se trajo por primera vez. */
1212
+ created_at: string | null;
1213
+ /** Cuándo cambió por última vez. */
1214
+ updated_at: string | null;
1215
+ }
1216
+ /** Lo que trajo una consulta de las declaraciones del emisor en el SAT. */
1217
+ export interface SatDeclarationsRefresh {
1218
+ /** Qué tipo de objeto es («invoice», «customer»…). */
1219
+ object: "sat_declarations_refresh";
1220
+ /** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
1221
+ livemode: boolean;
1222
+ /** El emisor consultado. */
1223
+ issuer: string;
1224
+ /** completed (ya bajó todo) o processing (queda algo por bajar: sigue solo en la siguiente hora, sin otro timbre). */
1225
+ status: "completed" | "processing";
1226
+ /** Cuántas declaraciones listó el SAT en los años consultados. */
1227
+ found: number;
1228
+ /** Cuántos archivos bajó en esta consulta. */
1229
+ downloaded: number;
1230
+ /** Cuántas declaraciones quedan con archivos por bajar. */
1231
+ pending: number;
1232
+ /** Si una parte del SAT falló (por ejemplo, la anual), lo que dijo; lo demás sí se trajo. null si todo salió. */
1233
+ warning: string | null;
1234
+ /** Cuándo se consultó. */
1235
+ refreshed_at: string;
1236
+ /** Desde cuándo se puede volver a consultar este emisor (10 minutos después). */
1237
+ next_refresh_at: string;
1238
+ }
1111
1239
  /** Una venta que su comprador puede facturar él mismo en el portal del emisor (autofactura). */
1112
1240
  export interface Ticket {
1113
1241
  /** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
@@ -1664,6 +1792,8 @@ export interface WebhookEndpoint {
1664
1792
  failing_since?: string | null;
1665
1793
  /** Hasta cuándo el secreto anterior también firma (después de cambiarlo), o null. */
1666
1794
  previous_secret_expires_at: string | null;
1795
+ /** La versión de la API de sus eventos; null: la de la cuenta. */
1796
+ api_version: string | null;
1667
1797
  /** Cuándo se creó, ISO 8601 con la hora de la Ciudad de México (-06:00). */
1668
1798
  created_at: string | null;
1669
1799
  /** Secreto de firma (whsec_…). Solo viene al crearlo o al cambiarlo: guárdelo para verificar las firmas. */
@@ -1735,6 +1865,8 @@ export interface ApiError {
1735
1865
  param?: string;
1736
1866
  /** Código del SAT o del PAC (CFDI40xxx). */
1737
1867
  sat_code?: string;
1868
+ /** Con Accept-Language: en, el mensaje original en español cuando message solo dice en inglés qué significa el código. */
1869
+ message_es?: string;
1738
1870
  /** La explicación de este código en la documentación. */
1739
1871
  doc_url: string;
1740
1872
  /** El id de la solicitud (req_…). Inclúyalo si nos escribe. */
@@ -1901,6 +2033,16 @@ export interface SatInvoiceList {
1901
2033
  /** La ruta de esta lista. */
1902
2034
  url: string;
1903
2035
  }
2036
+ export interface SatDeclarationList {
2037
+ /** Qué tipo de objeto es («invoice», «customer»…). */
2038
+ object: "list";
2039
+ /** Los objetos de esta página. */
2040
+ data: SatDeclaration[];
2041
+ /** true si hay más: pida la siguiente con starting_after igual al id del último. */
2042
+ has_more: boolean;
2043
+ /** La ruta de esta lista. */
2044
+ url: string;
2045
+ }
1904
2046
  export interface TicketList {
1905
2047
  /** Qué tipo de objeto es («invoice», «customer»…). */
1906
2048
  object: "list";
@@ -2785,6 +2927,10 @@ export interface InvoiceCreate {
2785
2927
  /** Sus propios datos: hasta 50 llaves de 40 caracteres con valores de texto de hasta 500. No van al CFDI; vuelven en el objeto y en los webhooks. */
2786
2928
  metadata?: Record<string, string>;
2787
2929
  }
2930
+ export interface UpdateAccountParams {
2931
+ /** La versión de la API de la cuenta: la que reciben sus solicitudes sin Fiscalisto-Version y sus webhooks sin api_version propio. Pruebe antes la nueva con el encabezado. */
2932
+ api_version: string;
2933
+ }
2788
2934
  export interface ResetTestDataParams {
2789
2935
  /** true (por omisión) para dejarle a cada emisor de pruebas 3 clientes y 3 productos de ejemplo. false para dejarlo vacío. */
2790
2936
  seed?: boolean;
@@ -2878,7 +3024,7 @@ export interface ListInvoicesParams {
2878
3024
  status?: "valid" | "pending" | "canceled" | "rejected" | "processing";
2879
3025
  /** I, E, P, T o N. */
2880
3026
  type?: "I" | "E" | "P" | "T" | "N";
2881
- /** RFC del cliente. */
3027
+ /** RFC del cliente o su id (cus_…). */
2882
3028
  customer?: string;
2883
3029
  /** Facturas de ingreso por lo que deben: unpaid, partial, open (unpaid o partial) o paid. */
2884
3030
  payment_status?: "unpaid" | "partial" | "open" | "paid";
@@ -2924,7 +3070,7 @@ export interface ListReceivablesParams {
2924
3070
  starting_after?: string;
2925
3071
  /** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
2926
3072
  issuer?: string;
2927
- /** Solo este RFC. */
3073
+ /** Solo este cliente: su RFC o su id (cus_…). */
2928
3074
  customer?: string;
2929
3075
  }
2930
3076
  export interface CreateBankTransactionsParams {
@@ -3074,7 +3220,7 @@ export interface CreateAdvanceParams {
3074
3220
  export interface ListAdvancesParams {
3075
3221
  /** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
3076
3222
  issuer?: string;
3077
- /** RFC del cliente. */
3223
+ /** RFC del cliente o su id (cus_…). */
3078
3224
  customer?: string;
3079
3225
  }
3080
3226
  /** El cuerpo de POST /v1/invoices (la factura de lo vendido) con method y remainder. */
@@ -3501,7 +3647,9 @@ export interface CreateProductParams {
3501
3647
  /** Número de identificación o SKU (NoIdentificacion). */
3502
3648
  sku?: string | null;
3503
3649
  /** Precio unitario antes de impuestos (ValorUnitario). */
3504
- unit_price: number;
3650
+ unit_price?: number;
3651
+ /** Precio abierto: sin precio fijo (una noche de hotel que cambia cada día); cada factura manda su unit_price. */
3652
+ open_price?: boolean;
3505
3653
  /** Objeto de impuesto (ObjetoImp), c_ObjetoImp: 01 no objeto, 02 sí objeto (por omisión), 03 sin desglose, 04 no causa… */
3506
3654
  taxability?: "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08";
3507
3655
  /** Tasa de IVA trasladado: 0.16 (por omisión), 0.08 (región fronteriza), 0 o exento. */
@@ -3514,6 +3662,15 @@ export interface CreateProductParams {
3514
3662
  iva_retention?: number;
3515
3663
  /** Tasa de ISR retenido (por ejemplo 0.10 honorarios, 0.0125 RESICO). */
3516
3664
  isr_retention?: number;
3665
+ /** Impuestos locales que lleva, como el ISH 3% de hospedaje: van en cada factura con él, sobre sus conceptos. */
3666
+ local_taxes?: {
3667
+ /** true si es una retención local; false si es un traslado. */
3668
+ retention: boolean;
3669
+ /** Nombre del impuesto local (ImpLocTrasladado o ImpLocRetenido), como ISH. */
3670
+ name: string;
3671
+ /** Tasa en por ciento (TasadeTraslado o TasadeRetencion). */
3672
+ rate: number;
3673
+ }[];
3517
3674
  }
3518
3675
  /** Los parámetros de GET /v1/products. */
3519
3676
  export interface ListProductsParams {
@@ -3543,6 +3700,8 @@ export interface UpdateProductParams {
3543
3700
  sku?: string | null;
3544
3701
  /** Precio unitario antes de impuestos (ValorUnitario). */
3545
3702
  unit_price?: number;
3703
+ /** Precio abierto: sin precio fijo (una noche de hotel que cambia cada día); cada factura manda su unit_price. */
3704
+ open_price?: boolean;
3546
3705
  /** Objeto de impuesto (ObjetoImp), c_ObjetoImp: 01 no objeto, 02 sí objeto (por omisión), 03 sin desglose, 04 no causa… */
3547
3706
  taxability?: "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08";
3548
3707
  /** Tasa de IVA trasladado: 0.16 (por omisión), 0.08 (región fronteriza), 0 o exento. */
@@ -3555,6 +3714,15 @@ export interface UpdateProductParams {
3555
3714
  iva_retention?: number;
3556
3715
  /** Tasa de ISR retenido (por ejemplo 0.10 honorarios, 0.0125 RESICO). */
3557
3716
  isr_retention?: number;
3717
+ /** Impuestos locales que lleva, como el ISH 3% de hospedaje: van en cada factura con él, sobre sus conceptos. */
3718
+ local_taxes?: {
3719
+ /** true si es una retención local; false si es un traslado. */
3720
+ retention: boolean;
3721
+ /** Nombre del impuesto local (ImpLocTrasladado o ImpLocRetenido), como ISH. */
3722
+ name: string;
3723
+ /** Tasa en por ciento (TasadeTraslado o TasadeRetencion). */
3724
+ rate: number;
3725
+ }[];
3558
3726
  }
3559
3727
  /** Los parámetros de GET /v1/sat_catalogs/{name}. */
3560
3728
  export interface GetSatCatalogParams {
@@ -3611,6 +3779,23 @@ export interface ListSatInvoicesParams {
3611
3779
  /** Con fecha hasta este día (AAAA-MM-DD), incluido. */
3612
3780
  date_lte?: string;
3613
3781
  }
3782
+ export interface RefreshSatDeclarationsParams {
3783
+ /** El emisor (iss_…). Por omisión, su único emisor. */
3784
+ issuer?: string;
3785
+ }
3786
+ /** Los parámetros de GET /v1/sat_declarations. */
3787
+ export interface ListSatDeclarationsParams {
3788
+ /** Cuántos por página, de 1 a 100. Por omisión 10. */
3789
+ limit?: number;
3790
+ /** El id del último de la página anterior, para la siguiente. */
3791
+ starting_after?: string;
3792
+ /** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
3793
+ issuer?: string;
3794
+ /** Solo las de un ejercicio, como 2025. */
3795
+ year?: number;
3796
+ /** monthly (provisionales o definitivas), annual (la anual) o dyp (Declaraciones y pagos). */
3797
+ source?: "monthly" | "annual" | "dyp";
3798
+ }
3614
3799
  export interface CreateTicketParams {
3615
3800
  /** El emisor (iss_…) que vendió. Por omisión, su único emisor. */
3616
3801
  issuer?: string;
@@ -4164,6 +4349,8 @@ export interface CreateWebhookEndpointParams {
4164
4349
  events?: string[] | null;
4165
4350
  /** Para qué es, para usted (no se manda en los eventos). */
4166
4351
  description?: string | null;
4352
+ /** La versión de la API en que llegan sus eventos (por ejemplo 2026-10-24); null o sin mandar: la de la cuenta. Así actualiza un endpoint a la vez. */
4353
+ api_version?: string | null;
4167
4354
  }
4168
4355
  /** Los parámetros de GET /v1/webhook_endpoints. */
4169
4356
  export interface ListWebhookEndpointsParams {
@@ -4181,6 +4368,8 @@ export interface UpdateWebhookEndpointParams {
4181
4368
  description?: string | null;
4182
4369
  /** true para apagarlo sin borrarlo. */
4183
4370
  disabled?: boolean;
4371
+ /** La versión de la API en que llegan sus eventos (por ejemplo 2026-10-24); null o sin mandar: la de la cuenta. Así actualiza un endpoint a la vez. */
4372
+ api_version?: string | null;
4184
4373
  }
4185
4374
  export interface RollWebhookSecretParams {
4186
4375
  /** Segundos que el secreto anterior sigue firmando, de 0 (deja de firmar ya: úselo si se filtró) a 86400. Por omisión 86400 (24 horas). */
@@ -4214,6 +4403,15 @@ export declare class AccountResource {
4214
4403
  * @see https://fiscalisto.com/docs/api/referencia/cuenta/get-account
4215
4404
  */
4216
4405
  get(options?: RequestOptions): Promise<Account>;
4406
+ /**
4407
+ * Cambiar la versión de la API
4408
+ *
4409
+ * Mueve la versión de la API de la cuenta: la que reciben sus solicitudes sin el encabezado Fiscalisto-Version y sus webhooks sin api_version propio. Antes, pruebe la nueva mandando Fiscalisto-Version en sus solicitudes. Con una llave de la cuenta con todos los permisos (no de un entorno de prueba). Queda en Desarrolladores › Actividad.
4410
+ *
4411
+ * POST /v1/account
4412
+ * @see https://fiscalisto.com/docs/api/referencia/cuenta/update-account
4413
+ */
4414
+ update(params: UpdateAccountParams, options?: RequestOptions): Promise<Account>;
4217
4415
  }
4218
4416
  /** Cuenta: fiscalisto.testData. */
4219
4417
  export declare class TestDataResource {
@@ -4476,7 +4674,7 @@ export declare class InvoicesResource {
4476
4674
  /**
4477
4675
  * Cancelar una factura
4478
4676
  *
4479
- * Pide la cancelación al SAT. Si el cliente debe aceptarla queda en pending (escuche invoice.canceled o invoice.cancellation_rejected). Usa un timbre la primera vez que el SAT acepta la solicitud; repetirla, o pedirla otra vez después de un rechazo, no. Nunca se niega por falta de timbres.
4677
+ * Pide la cancelación al SAT. Si el cliente debe aceptarla queda en pending (escuche invoice.canceled o invoice.cancellation_rejected). No usa timbres.
4480
4678
  *
4481
4679
  * POST /v1/invoices/{id}/cancel
4482
4680
  * @see https://fiscalisto.com/docs/api/referencia/facturas/cancel-invoice
@@ -4688,7 +4886,7 @@ export declare class RetentionsResource {
4688
4886
  /**
4689
4887
  * Cancelar una constancia
4690
4888
  *
4691
- * Se cancela en el momento (no espera aceptación). Usa un timbre.
4889
+ * Se cancela en el momento (no espera aceptación). No usa timbres.
4692
4890
  *
4693
4891
  * POST /v1/retentions/{id}/cancel
4694
4892
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/cancel-retention
@@ -4963,7 +5161,7 @@ export declare class SatDownloadsResource {
4963
5161
  /**
4964
5162
  * Pedirle al SAT las facturas de un emisor
4965
5163
  *
4966
- * La descarga masiva del SAT: las facturas que el emisor recibió (o emitió) en un periodo de hasta un año, con su XML. Contesta 202 de inmediato; el SAT tarda de minutos a horas y al terminar llega sat_download.completed (o sat_download.failed) y las facturas quedan en GET /v1/sat_invoices. En producción necesita la e.firma guardada del emisor; en pruebas no se le pregunta al SAT: la descarga trae facturas de ejemplo al instante. No usa timbres.
5164
+ * La descarga masiva del SAT: las facturas que el emisor recibió (o emitió) en un periodo de hasta un año, con su XML. Contesta 202 de inmediato; el SAT tarda de minutos a horas y al terminar llega sat_download.completed (o sat_download.failed) y las facturas quedan en GET /v1/sat_invoices. En producción necesita la e.firma guardada del emisor; en pruebas no se le pregunta al SAT: la descarga trae facturas de ejemplo al instante. En producción usa 1 timbre por cada 100 CFDI que trae (al menos 1).
4967
5165
  *
4968
5166
  * POST /v1/sat_downloads
4969
5167
  * @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/create-sat-download
@@ -5014,6 +5212,63 @@ export declare class SatInvoicesResource {
5014
5212
  */
5015
5213
  xml(id: string, options?: RequestOptions): Promise<string>;
5016
5214
  }
5215
+ /** Declaraciones del SAT: fiscalisto.satDeclarations. */
5216
+ export declare class SatDeclarationsResource {
5217
+ #private;
5218
+ constructor(client: Client);
5219
+ /**
5220
+ * Consultar las declaraciones de un emisor en el SAT
5221
+ *
5222
+ * Entra al SAT con la e.firma guardada del emisor y trae las declaraciones que presentó: provisionales o definitivas (desde 2022), la anual de persona moral (desde 2019) y las del servicio anterior Declaraciones y pagos, con su PDF, su acuse y sus cifras. La primera consulta trae todos los años que el SAT conserva; las siguientes, este año y el anterior. Solo consulta: nunca presenta ni firma nada. En producción usa 1 timbre por consulta (regresa si el SAT no contesta) y se puede hacer una vez cada 10 minutos por emisor. Contesta en menos de un minuto; si queda algo por bajar (status processing), sigue solo en la siguiente hora sin otro timbre. En pruebas no se le pregunta al SAT: trae declaraciones de ejemplo al instante.
5223
+ *
5224
+ * POST /v1/sat_declarations/refresh
5225
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/refresh-sat-declarations
5226
+ */
5227
+ refresh(params?: RefreshSatDeclarationsParams, options?: RequestOptions): Promise<SatDeclarationsRefresh>;
5228
+ /**
5229
+ * Listar declaraciones del SAT
5230
+ *
5231
+ * Las declaraciones que trajeron sus consultas, del ejercicio y mes más recientes a los más antiguos (la anual antes de los meses de su año). No usa timbres.
5232
+ *
5233
+ * GET /v1/sat_declarations
5234
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/list-sat-declarations
5235
+ */
5236
+ list(params?: ListSatDeclarationsParams, options?: RequestOptions): List<SatDeclaration>;
5237
+ /**
5238
+ * Ver una declaración del SAT
5239
+ *
5240
+ * GET /v1/sat_declarations/{id}
5241
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/get-sat-declaration
5242
+ */
5243
+ get(id: string, options?: RequestOptions): Promise<SatDeclaration>;
5244
+ /**
5245
+ * Descargar el PDF de una declaración
5246
+ *
5247
+ * La declaración como la da el SAT. No usa timbres.
5248
+ *
5249
+ * GET /v1/sat_declarations/{id}/pdf
5250
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/get-sat-declaration-pdf
5251
+ */
5252
+ pdf(id: string, options?: RequestOptions): Promise<Uint8Array>;
5253
+ /**
5254
+ * Descargar el acuse de una declaración
5255
+ *
5256
+ * El acuse de recibo, con la línea de captura si hay algo a pagar. No usa timbres.
5257
+ *
5258
+ * GET /v1/sat_declarations/{id}/receipt
5259
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/get-sat-declaration-receipt
5260
+ */
5261
+ receipt(id: string, options?: RequestOptions): Promise<Uint8Array>;
5262
+ /**
5263
+ * Descargar los estados financieros de una anual
5264
+ *
5265
+ * El Excel de estados financieros de la anual de persona moral, como lo da el SAT. No usa timbres.
5266
+ *
5267
+ * GET /v1/sat_declarations/{id}/financial_statements
5268
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/get-sat-declaration-financial-statements
5269
+ */
5270
+ financialStatements(id: string, options?: RequestOptions): Promise<string>;
5271
+ }
5017
5272
  /** Autofactura: fiscalisto.tickets. */
5018
5273
  export declare class TicketsResource {
5019
5274
  #private;
@@ -5428,6 +5683,7 @@ export declare class FiscalistoApi extends Core {
5428
5683
  readonly satLists: SatListsResource;
5429
5684
  readonly satDownloads: SatDownloadsResource;
5430
5685
  readonly satInvoices: SatInvoicesResource;
5686
+ readonly satDeclarations: SatDeclarationsResource;
5431
5687
  readonly tickets: TicketsResource;
5432
5688
  readonly accounting: AccountingResource;
5433
5689
  readonly storeConnections: StoreConnectionsResource;
package/dist/generated.js CHANGED
@@ -17,6 +17,17 @@ export class AccountResource {
17
17
  get(options) {
18
18
  return this.#client.request({ method: "GET", path: "/v1/account" }, options);
19
19
  }
20
+ /**
21
+ * Cambiar la versión de la API
22
+ *
23
+ * Mueve la versión de la API de la cuenta: la que reciben sus solicitudes sin el encabezado Fiscalisto-Version y sus webhooks sin api_version propio. Antes, pruebe la nueva mandando Fiscalisto-Version en sus solicitudes. Con una llave de la cuenta con todos los permisos (no de un entorno de prueba). Queda en Desarrolladores › Actividad.
24
+ *
25
+ * POST /v1/account
26
+ * @see https://fiscalisto.com/docs/api/referencia/cuenta/update-account
27
+ */
28
+ update(params, options) {
29
+ return this.#client.request({ method: "POST", path: "/v1/account", body: params, idempotent: true }, options);
30
+ }
20
31
  }
21
32
  /** Cuenta: fiscalisto.testData. */
22
33
  export class TestDataResource {
@@ -345,7 +356,7 @@ export class InvoicesResource {
345
356
  /**
346
357
  * Cancelar una factura
347
358
  *
348
- * Pide la cancelación al SAT. Si el cliente debe aceptarla queda en pending (escuche invoice.canceled o invoice.cancellation_rejected). Usa un timbre la primera vez que el SAT acepta la solicitud; repetirla, o pedirla otra vez después de un rechazo, no. Nunca se niega por falta de timbres.
359
+ * Pide la cancelación al SAT. Si el cliente debe aceptarla queda en pending (escuche invoice.canceled o invoice.cancellation_rejected). No usa timbres.
349
360
  *
350
361
  * POST /v1/invoices/{id}/cancel
351
362
  * @see https://fiscalisto.com/docs/api/referencia/facturas/cancel-invoice
@@ -613,7 +624,7 @@ export class RetentionsResource {
613
624
  /**
614
625
  * Cancelar una constancia
615
626
  *
616
- * Se cancela en el momento (no espera aceptación). Usa un timbre.
627
+ * Se cancela en el momento (no espera aceptación). No usa timbres.
617
628
  *
618
629
  * POST /v1/retentions/{id}/cancel
619
630
  * @see https://fiscalisto.com/docs/api/referencia/retenciones/cancel-retention
@@ -966,7 +977,7 @@ export class SatDownloadsResource {
966
977
  /**
967
978
  * Pedirle al SAT las facturas de un emisor
968
979
  *
969
- * La descarga masiva del SAT: las facturas que el emisor recibió (o emitió) en un periodo de hasta un año, con su XML. Contesta 202 de inmediato; el SAT tarda de minutos a horas y al terminar llega sat_download.completed (o sat_download.failed) y las facturas quedan en GET /v1/sat_invoices. En producción necesita la e.firma guardada del emisor; en pruebas no se le pregunta al SAT: la descarga trae facturas de ejemplo al instante. No usa timbres.
980
+ * La descarga masiva del SAT: las facturas que el emisor recibió (o emitió) en un periodo de hasta un año, con su XML. Contesta 202 de inmediato; el SAT tarda de minutos a horas y al terminar llega sat_download.completed (o sat_download.failed) y las facturas quedan en GET /v1/sat_invoices. En producción necesita la e.firma guardada del emisor; en pruebas no se le pregunta al SAT: la descarga trae facturas de ejemplo al instante. En producción usa 1 timbre por cada 100 CFDI que trae (al menos 1).
970
981
  *
971
982
  * POST /v1/sat_downloads
972
983
  * @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/create-sat-download
@@ -1031,6 +1042,77 @@ export class SatInvoicesResource {
1031
1042
  return this.#client.request({ method: "GET", path: `/v1/sat_invoices/${encodeURIComponent(id)}/xml`, as: "text" }, options);
1032
1043
  }
1033
1044
  }
1045
+ /** Declaraciones del SAT: fiscalisto.satDeclarations. */
1046
+ export class SatDeclarationsResource {
1047
+ #client;
1048
+ constructor(client) {
1049
+ this.#client = client;
1050
+ }
1051
+ /**
1052
+ * Consultar las declaraciones de un emisor en el SAT
1053
+ *
1054
+ * Entra al SAT con la e.firma guardada del emisor y trae las declaraciones que presentó: provisionales o definitivas (desde 2022), la anual de persona moral (desde 2019) y las del servicio anterior Declaraciones y pagos, con su PDF, su acuse y sus cifras. La primera consulta trae todos los años que el SAT conserva; las siguientes, este año y el anterior. Solo consulta: nunca presenta ni firma nada. En producción usa 1 timbre por consulta (regresa si el SAT no contesta) y se puede hacer una vez cada 10 minutos por emisor. Contesta en menos de un minuto; si queda algo por bajar (status processing), sigue solo en la siguiente hora sin otro timbre. En pruebas no se le pregunta al SAT: trae declaraciones de ejemplo al instante.
1055
+ *
1056
+ * POST /v1/sat_declarations/refresh
1057
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/refresh-sat-declarations
1058
+ */
1059
+ refresh(params, options) {
1060
+ return this.#client.request({ method: "POST", path: "/v1/sat_declarations/refresh", body: params, idempotent: true }, options);
1061
+ }
1062
+ /**
1063
+ * Listar declaraciones del SAT
1064
+ *
1065
+ * Las declaraciones que trajeron sus consultas, del ejercicio y mes más recientes a los más antiguos (la anual antes de los meses de su año). No usa timbres.
1066
+ *
1067
+ * GET /v1/sat_declarations
1068
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/list-sat-declarations
1069
+ */
1070
+ list(params, options) {
1071
+ return this.#client.list({ path: "/v1/sat_declarations", query: params }, options);
1072
+ }
1073
+ /**
1074
+ * Ver una declaración del SAT
1075
+ *
1076
+ * GET /v1/sat_declarations/{id}
1077
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/get-sat-declaration
1078
+ */
1079
+ get(id, options) {
1080
+ return this.#client.request({ method: "GET", path: `/v1/sat_declarations/${encodeURIComponent(id)}` }, options);
1081
+ }
1082
+ /**
1083
+ * Descargar el PDF de una declaración
1084
+ *
1085
+ * La declaración como la da el SAT. No usa timbres.
1086
+ *
1087
+ * GET /v1/sat_declarations/{id}/pdf
1088
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/get-sat-declaration-pdf
1089
+ */
1090
+ pdf(id, options) {
1091
+ return this.#client.request({ method: "GET", path: `/v1/sat_declarations/${encodeURIComponent(id)}/pdf`, as: "bytes" }, options);
1092
+ }
1093
+ /**
1094
+ * Descargar el acuse de una declaración
1095
+ *
1096
+ * El acuse de recibo, con la línea de captura si hay algo a pagar. No usa timbres.
1097
+ *
1098
+ * GET /v1/sat_declarations/{id}/receipt
1099
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/get-sat-declaration-receipt
1100
+ */
1101
+ receipt(id, options) {
1102
+ return this.#client.request({ method: "GET", path: `/v1/sat_declarations/${encodeURIComponent(id)}/receipt`, as: "bytes" }, options);
1103
+ }
1104
+ /**
1105
+ * Descargar los estados financieros de una anual
1106
+ *
1107
+ * El Excel de estados financieros de la anual de persona moral, como lo da el SAT. No usa timbres.
1108
+ *
1109
+ * GET /v1/sat_declarations/{id}/financial_statements
1110
+ * @see https://fiscalisto.com/docs/api/referencia/declaraciones-del-sat/get-sat-declaration-financial-statements
1111
+ */
1112
+ financialStatements(id, options) {
1113
+ return this.#client.request({ method: "GET", path: `/v1/sat_declarations/${encodeURIComponent(id)}/financial_statements`, as: "text" }, options);
1114
+ }
1115
+ }
1034
1116
  /** Autofactura: fiscalisto.tickets. */
1035
1117
  export class TicketsResource {
1036
1118
  #client;
@@ -1541,6 +1623,7 @@ export class FiscalistoApi extends Core {
1541
1623
  satLists = new SatListsResource(this);
1542
1624
  satDownloads = new SatDownloadsResource(this);
1543
1625
  satInvoices = new SatInvoicesResource(this);
1626
+ satDeclarations = new SatDeclarationsResource(this);
1544
1627
  tickets = new TicketsResource(this);
1545
1628
  accounting = new AccountingResource(this);
1546
1629
  storeConnections = new StoreConnectionsResource(this);
package/dist/index.d.ts CHANGED
@@ -20,7 +20,7 @@ export declare class Fiscalisto extends FiscalistoApi {
20
20
  readonly webhooks: Webhooks;
21
21
  }
22
22
  export default Fiscalisto;
23
- export { type ErrorType, type Fetch, FiscalistoError, type FiscalistoOptions, List, type Page, type RequestOptions, VERSION, } from "./core.js";
23
+ export { API_VERSION, type ErrorType, type Fetch, FiscalistoError, type FiscalistoOptions, List, type Page, type RequestOptions, VERSION, } from "./core.js";
24
24
  export { ErrorCode } from "./error-codes.js";
25
25
  export type * from "./generated.js";
26
26
  export { FiscalistoWebhookError, type VerifyOptions, verifyWebhook, type WebhookHeaders, } from "./webhooks.js";
package/dist/index.js CHANGED
@@ -20,6 +20,6 @@ export class Fiscalisto extends FiscalistoApi {
20
20
  webhooks = new Webhooks();
21
21
  }
22
22
  export default Fiscalisto;
23
- export { FiscalistoError, List, VERSION, } from "./core.js";
23
+ export { API_VERSION, FiscalistoError, List, VERSION, } from "./core.js";
24
24
  export { ErrorCode } from "./error-codes.js";
25
25
  export { FiscalistoWebhookError, verifyWebhook, } from "./webhooks.js";
@@ -0,0 +1,2 @@
1
+ /** [método, ruta, estado, tipo de contenido, ejemplo] de cada ruta de la API. */
2
+ export declare const MOCK_ROUTES: [string, string, number, string, unknown][];