fiscalisto 0.1.49 → 0.1.52

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/core.d.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * llamar.
5
5
  */
6
6
  import type { ErrorCode } from "./error-codes.js";
7
- export declare const VERSION = "0.1.49";
7
+ export declare const VERSION = "0.1.52";
8
8
  /**
9
9
  * La versión de la API para la que se hizo este SDK: la manda en cada solicitud
10
10
  * (Fiscalisto-Version), así actualizar la API no cambia lo que recibe hasta que actualice el SDK.
package/dist/core.js CHANGED
@@ -3,7 +3,7 @@
3
3
  * errores y las listas que se recorren solas. Los recursos (generated.ts) solo dicen qué ruta
4
4
  * llamar.
5
5
  */
6
- export const VERSION = "0.1.49";
6
+ export const VERSION = "0.1.52";
7
7
  /**
8
8
  * La versión de la API para la que se hizo este SDK: la manda en cada solicitud
9
9
  * (Fiscalisto-Version), así actualizar la API no cambia lo que recibe hasta que actualice el SDK.
@@ -51,6 +51,8 @@ export declare const ErrorCode: {
51
51
  readonly EfirmaRequired: "efirma_required";
52
52
  /** No se pudo mandar el correo; lo demás sí se hizo: el comprobante está timbrado o la cotización quedó enviada (su url funciona). Repita el envío con su ruta /send. */
53
53
  readonly EmailFailed: "email_failed";
54
+ /** Ese webhook está apagado, así que no se le puede reenviar un evento. Enciéndalo con disabled: false y reenvíe. */
55
+ readonly EndpointDisabled: "endpoint_disabled";
54
56
  /** Ya hay un webhook con esa dirección en este modo; el mensaje dice cuál. Cámbielo en vez de crear otro. */
55
57
  readonly EndpointExists: "endpoint_exists";
56
58
  /** La cuenta llegó al máximo de webhooks en este modo. */
@@ -85,7 +87,7 @@ export declare const ErrorCode: {
85
87
  readonly InvoiceNotMarkable: "invoice_not_markable";
86
88
  /** La acción es para facturas timbradas (enviar, cancelar, sustituir). */
87
89
  readonly InvoiceNotStamped: "invoice_not_stamped";
88
- /** El PAC o el SAT no la aceptaron. sat_code trae su código (CFDI40xxx) y message qué corregir. La factura queda como rejected; no se usó ningún timbre. */
90
+ /** El PAC o el SAT no la aceptaron. sat_code trae su código (CFDI40xxx), message qué corregir y doc_url su explicación en [Rechazos del SAT](/docs/api/rechazos-del-sat). La factura queda como rejected; no se usó ningún timbre. */
89
91
  readonly InvoiceRejected: "invoice_rejected";
90
92
  /** El emisor está archivado: ya no timbra. Sus comprobantes se pueden consultar y cancelar. */
91
93
  readonly IssuerArchived: "issuer_archived";
@@ -52,6 +52,8 @@ export const ErrorCode = {
52
52
  EfirmaRequired: "efirma_required",
53
53
  /** No se pudo mandar el correo; lo demás sí se hizo: el comprobante está timbrado o la cotización quedó enviada (su url funciona). Repita el envío con su ruta /send. */
54
54
  EmailFailed: "email_failed",
55
+ /** Ese webhook está apagado, así que no se le puede reenviar un evento. Enciéndalo con disabled: false y reenvíe. */
56
+ EndpointDisabled: "endpoint_disabled",
55
57
  /** Ya hay un webhook con esa dirección en este modo; el mensaje dice cuál. Cámbielo en vez de crear otro. */
56
58
  EndpointExists: "endpoint_exists",
57
59
  /** La cuenta llegó al máximo de webhooks en este modo. */
@@ -86,7 +88,7 @@ export const ErrorCode = {
86
88
  InvoiceNotMarkable: "invoice_not_markable",
87
89
  /** La acción es para facturas timbradas (enviar, cancelar, sustituir). */
88
90
  InvoiceNotStamped: "invoice_not_stamped",
89
- /** El PAC o el SAT no la aceptaron. sat_code trae su código (CFDI40xxx) y message qué corregir. La factura queda como rejected; no se usó ningún timbre. */
91
+ /** El PAC o el SAT no la aceptaron. sat_code trae su código (CFDI40xxx), message qué corregir y doc_url su explicación en [Rechazos del SAT](/docs/api/rechazos-del-sat). La factura queda como rejected; no se usó ningún timbre. */
90
92
  InvoiceRejected: "invoice_rejected",
91
93
  /** El emisor está archivado: ya no timbra. Sus comprobantes se pueden consultar y cancelar. */
92
94
  IssuerArchived: "issuer_archived",
@@ -3991,7 +3991,7 @@ export interface WebhookEndpoint {
3991
3991
  events: string[];
3992
3992
  /** enabled: entregando. failing: sus entregas fallan (se apaga tras 5 días así). disabled: apagado. */
3993
3993
  status: "enabled" | "failing" | "disabled";
3994
- /** Por qué se apagó (sus entregas fallaron 5 días seguidos, o usted lo apagó). */
3994
+ /** Por qué se apagó: failing (sus entregas fallaron 5 días seguidos), gone (su servidor contestó 410 Gone) o manual (usted lo apagó). */
3995
3995
  disabled_reason?: string | null;
3996
3996
  /** Desde cuándo fallan las entregas, o null. */
3997
3997
  failing_since?: string | null;
@@ -4024,6 +4024,76 @@ export interface WebhookTest {
4024
4024
  duration_ms: number;
4025
4025
  };
4026
4026
  }
4027
+ /** Un evento que se mandó otra vez: a cuántos webhooks salió. Cada entrega es un intento aparte, ahora; véalo en las entregas del webhook. */
4028
+ export interface EventResend {
4029
+ /** Qué tipo de objeto es («invoice», «customer»…). */
4030
+ object: "event_resend";
4031
+ /** El evento (evt_…) que se mandó otra vez. */
4032
+ event: string;
4033
+ /** A cuántos webhooks salió. 0 si ninguno encendido escucha ese tipo de evento. */
4034
+ deliveries: number;
4035
+ }
4036
+ /** Lo que dice el SAT de un CFDI: si existe, si está vigente o cancelado y si se puede cancelar, con su emisor y su receptor en las listas del SAT. */
4037
+ export interface CfdiVerification {
4038
+ /** Qué tipo de objeto es («invoice», «customer»…). */
4039
+ object: "cfdi_verification";
4040
+ /** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
4041
+ livemode: boolean;
4042
+ /** Folio fiscal que asigna el SAT (UUID del Timbre Fiscal Digital), en mayúsculas. */
4043
+ uuid: string;
4044
+ /** El RFC del emisor que se consultó. */
4045
+ issuer_tax_id: string;
4046
+ /** El RFC del receptor que se consultó. */
4047
+ receiver_tax_id: string;
4048
+ /** Total en la moneda del comprobante (Total). */
4049
+ total: number;
4050
+ /** De dónde se leyeron el UUID, los RFC y el total: xml, qr o fields. */
4051
+ source: "xml" | "qr" | "fields";
4052
+ /** Lo que dice el SAT: active (vigente), canceled (cancelado), not_found (no lo tiene: no se timbró, se timbró hace minutos o es de pruebas) o data_mismatch (el UUID existe pero los RFC o el total no coinciden). */
4053
+ sat_status: "active" | "canceled" | "not_found" | "data_mismatch";
4054
+ /** Si está vigente, cómo se cancela: without_acceptance (sin que el receptor acepte), with_acceptance (el receptor tiene 3 días hábiles para aceptar) o not_cancellable (por ejemplo, tiene documentos relacionados vigentes). null si no está vigente o el SAT no lo dijo. */
4055
+ cancellable: "without_acceptance" | "with_acceptance" | "not_cancellable" | null;
4056
+ /** Una cancelación en curso o terminada: in_process (esperando al receptor), rejected (el receptor la rechazó), deadline_passed (pasó el plazo y se canceló), accepted o without_acceptance (cancelado con o sin aceptación). null si nadie la pidió. */
4057
+ cancellation_status: "in_process" | "rejected" | "deadline_passed" | "accepted" | "without_acceptance" | null;
4058
+ /** true si el SAT dice que el emisor está en la lista 69-B como definitivo (EFOS); false si no; null si no lo dijo. */
4059
+ issuer_efos: boolean | null;
4060
+ /** La respuesta del SAT tal cual (CodigoEstatus, Estado, EsCancelable, EstatusCancelacion, ValidacionEFOS), por si la necesita igual que el SAT. */
4061
+ sat: {
4062
+ /** Clave de la retención (CveRetenc), c_CveRetenc: 01 servicios profesionales, 05 arrendamiento, 14 dividendos, 16 intereses, 18 pagos al extranjero… Las claves 14, 16, 17 y 18 a 24 llevan su complemento (dividends, interest, trust_lease, foreign_payment, share_sale, prize, trust, retirement_plan, mortgage_interest, financial_derivatives); la 26 (plataformas tecnológicas) lleva platform, y sus totals y taxes se calculan de las operaciones. */
4063
+ code: string;
4064
+ /** Entidad federativa donde trabaja (ClaveEntFed): JAL, CMX, NLE… */
4065
+ state: string;
4066
+ /** EsCancelable, tal cual lo dijo el SAT. */
4067
+ cancellable: string | null;
4068
+ /** EstatusCancelacion, tal cual lo dijo el SAT. */
4069
+ cancellation_status: string | null;
4070
+ /** ValidacionEFOS: 200 si el emisor no es EFOS, 100 si lo es. */
4071
+ efos_validation: string | null;
4072
+ };
4073
+ /** Lo que trae el XML además (versión, tipo, fechas, nombres, moneda), si mandó xml; null si no. */
4074
+ xml: {
4075
+ /** La versión del CFDI (4.0 o 3.3). */
4076
+ version: string | null;
4077
+ /** Tipo de comprobante (TipoDeComprobante): I ingreso, E egreso, P pago, T traslado, N nómina. */
4078
+ type: string | null;
4079
+ /** La fecha de emisión (Fecha), como viene en el XML. */
4080
+ issued_at: string | null;
4081
+ /** La fecha de timbrado (FechaTimbrado), como viene en el XML. */
4082
+ stamped_at: string | null;
4083
+ /** El nombre del emisor en el XML. */
4084
+ issuer_name: string | null;
4085
+ /** El nombre del receptor en el XML. */
4086
+ receiver_name: string | null;
4087
+ /** Moneda, clave ISO 4217 de c_Moneda (MXN, USD, EUR…). Por omisión MXN. */
4088
+ currency: string | null;
4089
+ } | null;
4090
+ /** El emisor en las listas del SAT (69-B, 69-B Bis y art. 69), como GET /v1/sat_lists/{tax_id}, sin costo. Solo cuando el SAT tiene el comprobante (active o canceled); null si no, o si las listas no se pudieron leer. */
4091
+ issuer_sat_lists: SatListCheck | null;
4092
+ /** El receptor en las listas del SAT, igual que el emisor. */
4093
+ receiver_sat_lists: SatListCheck | null;
4094
+ /** Cuándo se le preguntó al SAT. */
4095
+ checked_at: string;
4096
+ }
4027
4097
  /** Lo que puede pasar: el tipo de cada evento. */
4028
4098
  export type EventType = "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "invoice.email_bounced" | "invoice.email_complained" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "payroll_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" | "quote.withdrawn" | "sales_order.confirmed" | "sales_order.customer_confirmed" | "sales_order.delivered" | "sales_order.paid" | "sales_order.canceled" | "supplier_invoice.received" | "supplier_invoice.approved" | "supplier_invoice.rejected" | "supplier_invoice.scheduled" | "supplier_invoice.paid" | "portal_supplier.approved" | "issuer.ready" | "balance.low" | "usage.high" | "test_clock.ready";
4029
4099
  /** Algo que pasó en su cuenta: el objeto completo como quedó. Se manda a sus webhooks firmado (Standard Webhooks). */
@@ -5291,8 +5361,10 @@ export interface InvoiceCreate {
5291
5361
  periodicity: string;
5292
5362
  /** Meses (Meses), c_Meses: 01 a 12, o 13 a 18 bimestres. */
5293
5363
  months: string;
5294
- /** Año (Año). */
5364
+ /** Año (Año): el de la fecha de la factura o hasta cinco años antes (CFDI40136). */
5295
5365
  year: number;
5366
+ /** Solo emisores con régimen 603 (donatarias y asociaciones): true conserva la descripción, claves, unidad y cantidad de cada concepto en vez de «Venta», 01010101, ACT. */
5367
+ keep_concepts?: boolean;
5296
5368
  };
5297
5369
  /** Uso del CFDI (UsoCFDI), clave de c_UsoCFDI. Por omisión G03, o S01 con régimen 616. */
5298
5370
  use?: string;
@@ -7427,6 +7499,20 @@ export interface CheckSatListsParams {
7427
7499
  /** Los RFC a revisar, hasta 1000. */
7428
7500
  tax_ids: string[];
7429
7501
  }
7502
+ export interface VerifyCfdiParams {
7503
+ /** El XML del CFDI, como texto. Se leen de él el UUID, los dos RFC y el total. Hasta 4 millones de caracteres. */
7504
+ xml?: string;
7505
+ /** El texto del QR del PDF (https://verificacfdi.facturaelectronica.sat.gob.mx/default.aspx?id=…&re=…&rr=…&tt=…&fe=…), si no tiene el XML. */
7506
+ qr?: string;
7507
+ /** El folio fiscal, sin XML ni QR. Va con issuer_tax_id, receiver_tax_id y total. */
7508
+ uuid?: string;
7509
+ /** El RFC del emisor, sin XML ni QR. */
7510
+ issuer_tax_id?: string;
7511
+ /** El RFC del receptor, sin XML ni QR. */
7512
+ receiver_tax_id?: string;
7513
+ /** El total del comprobante, sin XML ni QR. El SAT lo compara como número. */
7514
+ total?: number;
7515
+ }
7430
7516
  export interface CreateSatDownloadParams {
7431
7517
  /** El emisor (iss_…). Por omisión, su único emisor. */
7432
7518
  issuer?: string;
@@ -8619,6 +8705,10 @@ export interface ListEventsParams {
8619
8705
  /** false: los que algún webhook no recibió (su último intento falló). true: los que recibieron todos los webhooks a los que se mandaron. */
8620
8706
  delivery_success?: boolean;
8621
8707
  }
8708
+ export interface ResendEventParams {
8709
+ /** El webhook (whe_…) al que mandarlo otra vez. Sin mandar: a todos los webhooks encendidos que escuchan ese tipo de evento. */
8710
+ endpoint?: string;
8711
+ }
8622
8712
  /** Cuenta: fiscalisto.account. */
8623
8713
  export declare class AccountResource {
8624
8714
  #private;
@@ -10327,6 +10417,20 @@ export declare class SatListsResource {
10327
10417
  */
10328
10418
  check(params: CheckSatListsParams, options?: RequestOptions): Promise<SatListCheckList>;
10329
10419
  }
10420
+ /** Verificar comprobantes: fiscalisto.cfdiVerifications. */
10421
+ export declare class CfdiVerificationsResource {
10422
+ #private;
10423
+ constructor(client: Client);
10424
+ /**
10425
+ * Verificar un CFDI en el SAT
10426
+ *
10427
+ * Si cualquier CFDI (suyo, de un proveedor o de un cliente) existe en el SAT y está vigente o cancelado, si se puede cancelar, y si su emisor y su receptor están en las listas del SAT. Mande su XML, el texto de su QR, o el UUID con los dos RFC y el total. Consulta el servicio público del SAT, sin e.firma. No usa timbres. En pruebas también consulta el SAT real: los comprobantes de prueba no están ahí y responden not_found.
10428
+ *
10429
+ * POST /v1/cfdi_verifications
10430
+ * @see https://fiscalisto.com/docs/api/referencia/verificar-comprobantes/verify-cfdi
10431
+ */
10432
+ create(params?: VerifyCfdiParams, options?: RequestOptions): Promise<CfdiVerification>;
10433
+ }
10330
10434
  /** Descargas del SAT: fiscalisto.satDownloads. */
10331
10435
  export declare class SatDownloadsResource {
10332
10436
  #private;
@@ -11179,6 +11283,15 @@ export declare class EventsResource {
11179
11283
  * @see https://fiscalisto.com/docs/api/referencia/eventos/get-event
11180
11284
  */
11181
11285
  get(id: string, options?: RequestOptions): Promise<Event>;
11286
+ /**
11287
+ * Reenviar un evento
11288
+ *
11289
+ * Manda otra vez, ahora, un evento de los últimos 30 días: a un webhook (endpoint) o a todos los encendidos que escuchan ese tipo. Es un intento aparte, firmado con el mismo webhook-id: no cambia los reintentos automáticos, y si llega, ya no se reintenta. Úselo después de arreglar su servidor, con GET /v1/events?delivery_success=false.
11290
+ *
11291
+ * POST /v1/events/{id}/resend
11292
+ * @see https://fiscalisto.com/docs/api/referencia/eventos/resend-event
11293
+ */
11294
+ resend(id: string, params?: ResendEventParams, options?: RequestOptions): Promise<EventResend>;
11182
11295
  }
11183
11296
  /** Cada recurso de la API. Úselo por medio de Fiscalisto (index.ts). */
11184
11297
  export declare class FiscalistoApi extends Core {
@@ -11223,6 +11336,7 @@ export declare class FiscalistoApi extends Core {
11223
11336
  readonly stockAdjustments: StockAdjustmentsResource;
11224
11337
  readonly satCatalogs: SatCatalogsResource;
11225
11338
  readonly satLists: SatListsResource;
11339
+ readonly cfdiVerifications: CfdiVerificationsResource;
11226
11340
  readonly satDownloads: SatDownloadsResource;
11227
11341
  readonly satInvoices: SatInvoicesResource;
11228
11342
  readonly satRetentions: SatRetentionsResource;
package/dist/generated.js CHANGED
@@ -2124,6 +2124,24 @@ export class SatListsResource {
2124
2124
  return this.#client.request({ method: "POST", path: "/v1/sat_lists/check", body: params, idempotent: true }, options);
2125
2125
  }
2126
2126
  }
2127
+ /** Verificar comprobantes: fiscalisto.cfdiVerifications. */
2128
+ export class CfdiVerificationsResource {
2129
+ #client;
2130
+ constructor(client) {
2131
+ this.#client = client;
2132
+ }
2133
+ /**
2134
+ * Verificar un CFDI en el SAT
2135
+ *
2136
+ * Si cualquier CFDI (suyo, de un proveedor o de un cliente) existe en el SAT y está vigente o cancelado, si se puede cancelar, y si su emisor y su receptor están en las listas del SAT. Mande su XML, el texto de su QR, o el UUID con los dos RFC y el total. Consulta el servicio público del SAT, sin e.firma. No usa timbres. En pruebas también consulta el SAT real: los comprobantes de prueba no están ahí y responden not_found.
2137
+ *
2138
+ * POST /v1/cfdi_verifications
2139
+ * @see https://fiscalisto.com/docs/api/referencia/verificar-comprobantes/verify-cfdi
2140
+ */
2141
+ create(params, options) {
2142
+ return this.#client.request({ method: "POST", path: "/v1/cfdi_verifications", body: params, idempotent: true }, options);
2143
+ }
2144
+ }
2127
2145
  /** Descargas del SAT: fiscalisto.satDownloads. */
2128
2146
  export class SatDownloadsResource {
2129
2147
  #client;
@@ -3178,6 +3196,17 @@ export class EventsResource {
3178
3196
  get(id, options) {
3179
3197
  return this.#client.request({ method: "GET", path: `/v1/events/${encodeURIComponent(id)}` }, options);
3180
3198
  }
3199
+ /**
3200
+ * Reenviar un evento
3201
+ *
3202
+ * Manda otra vez, ahora, un evento de los últimos 30 días: a un webhook (endpoint) o a todos los encendidos que escuchan ese tipo. Es un intento aparte, firmado con el mismo webhook-id: no cambia los reintentos automáticos, y si llega, ya no se reintenta. Úselo después de arreglar su servidor, con GET /v1/events?delivery_success=false.
3203
+ *
3204
+ * POST /v1/events/{id}/resend
3205
+ * @see https://fiscalisto.com/docs/api/referencia/eventos/resend-event
3206
+ */
3207
+ resend(id, params, options) {
3208
+ return this.#client.request({ method: "POST", path: `/v1/events/${encodeURIComponent(id)}/resend`, body: params, idempotent: true }, options);
3209
+ }
3181
3210
  }
3182
3211
  /** Cada recurso de la API. Úselo por medio de Fiscalisto (index.ts). */
3183
3212
  export class FiscalistoApi extends Core {
@@ -3222,6 +3251,7 @@ export class FiscalistoApi extends Core {
3222
3251
  stockAdjustments = new StockAdjustmentsResource(this);
3223
3252
  satCatalogs = new SatCatalogsResource(this);
3224
3253
  satLists = new SatListsResource(this);
3254
+ cfdiVerifications = new CfdiVerificationsResource(this);
3225
3255
  satDownloads = new SatDownloadsResource(this);
3226
3256
  satInvoices = new SatInvoicesResource(this);
3227
3257
  satRetentions = new SatRetentionsResource(this);