fiscalisto 0.1.14 → 0.1.16
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 +1 -1
- package/dist/core.js +1 -1
- package/dist/error-codes.d.ts +5 -3
- package/dist/error-codes.js +5 -3
- package/dist/generated.d.ts +101 -19
- package/dist/generated.js +25 -3
- package/dist/mock-routes.gen.js +1 -1
- package/package.json +1 -1
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.
|
|
7
|
+
export declare const VERSION = "0.1.16";
|
|
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.
|
|
6
|
+
export const VERSION = "0.1.16";
|
|
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.
|
package/dist/error-codes.d.ts
CHANGED
|
@@ -121,10 +121,12 @@ export declare const ErrorCode: {
|
|
|
121
121
|
readonly QuoteCustomerMissing: "quote_customer_missing";
|
|
122
122
|
/** La cotización no se pudo guardar o ya no cambia (aceptada, rechazada o facturada), o no se puede mandar así. El mensaje dice por qué. */
|
|
123
123
|
readonly QuoteInvalid: "quote_invalid";
|
|
124
|
-
/**
|
|
125
|
-
readonly
|
|
126
|
-
/** La cotización se
|
|
124
|
+
/** La cotización ya se aceptó o se facturó: no se borra. Para cerrar una que no se aceptó, también puede retirarla (POST /v1/quotes/{id}/withdraw). */
|
|
125
|
+
readonly QuoteNotDeletable: "quote_not_deletable";
|
|
126
|
+
/** La cotización se rechazó, se retiró o venció: no se factura. Si venció o se retiró, cámbiela (es una versión nueva) y vuelva a mandarla. */
|
|
127
127
|
readonly QuoteNotInvoiceable: "quote_not_invoiceable";
|
|
128
|
+
/** La cotización nunca se envió, así que no se retira ni se marca rechazada: bórrela con DELETE /v1/quotes/{id}. */
|
|
129
|
+
readonly QuoteNotSent: "quote_not_sent";
|
|
128
130
|
/** Demasiadas solicitudes con la llave. Espere lo que dice Retry-After y reintente. */
|
|
129
131
|
readonly RateLimit: "rate_limit";
|
|
130
132
|
/** La factura recurrente no se pudo guardar: el día, la hora, la zona o la factura no son válidos. El mensaje dice cuál. */
|
package/dist/error-codes.js
CHANGED
|
@@ -122,10 +122,12 @@ export const ErrorCode = {
|
|
|
122
122
|
QuoteCustomerMissing: "quote_customer_missing",
|
|
123
123
|
/** La cotización no se pudo guardar o ya no cambia (aceptada, rechazada o facturada), o no se puede mandar así. El mensaje dice por qué. */
|
|
124
124
|
QuoteInvalid: "quote_invalid",
|
|
125
|
-
/**
|
|
126
|
-
|
|
127
|
-
/** La cotización se
|
|
125
|
+
/** La cotización ya se aceptó o se facturó: no se borra. Para cerrar una que no se aceptó, también puede retirarla (POST /v1/quotes/{id}/withdraw). */
|
|
126
|
+
QuoteNotDeletable: "quote_not_deletable",
|
|
127
|
+
/** La cotización se rechazó, se retiró o venció: no se factura. Si venció o se retiró, cámbiela (es una versión nueva) y vuelva a mandarla. */
|
|
128
128
|
QuoteNotInvoiceable: "quote_not_invoiceable",
|
|
129
|
+
/** La cotización nunca se envió, así que no se retira ni se marca rechazada: bórrela con DELETE /v1/quotes/{id}. */
|
|
130
|
+
QuoteNotSent: "quote_not_sent",
|
|
129
131
|
/** Demasiadas solicitudes con la llave. Espere lo que dice Retry-After y reintente. */
|
|
130
132
|
RateLimit: "rate_limit",
|
|
131
133
|
/** La factura recurrente no se pudo guardar: el día, la hora, la zona o la factura no son válidos. El mensaje dice cuál. */
|
package/dist/generated.d.ts
CHANGED
|
@@ -1905,7 +1905,7 @@ export interface Ticket {
|
|
|
1905
1905
|
code: string;
|
|
1906
1906
|
/** pending (se puede facturar), invoiced (su comprador lo facturó: la factura en invoice), global (entró en la factura global del periodo) o cancelled. */
|
|
1907
1907
|
status: "pending" | "invoiced" | "global" | "cancelled";
|
|
1908
|
-
/** La página del portal con el código
|
|
1908
|
+
/** La página del portal con el código (c) y el total (t) del ticket: el portal lo encuentra solo y el comprador solo da sus datos. Quien tenga la liga puede facturar el ticket: désela solo al comprador (como el ticket impreso). Puede incrustarla con fiscalisto.js. null si ya no está pendiente. */
|
|
1909
1909
|
url: string | null;
|
|
1910
1910
|
/** Lo que se cobró, impuestos incluidos y sin propina. */
|
|
1911
1911
|
total: number;
|
|
@@ -1913,10 +1913,27 @@ export interface Ticket {
|
|
|
1913
1913
|
tip: number;
|
|
1914
1914
|
/** c_FormaPago de la venta. */
|
|
1915
1915
|
payment_form: string;
|
|
1916
|
-
/** El concepto de la factura. */
|
|
1916
|
+
/** El concepto de la factura (el primero, si lleva varios). */
|
|
1917
1917
|
description: string;
|
|
1918
|
-
/** c_ClaveProdServ del concepto. */
|
|
1918
|
+
/** c_ClaveProdServ del concepto (el primero, si lleva varios). */
|
|
1919
1919
|
product_key: string;
|
|
1920
|
+
/** Sus conceptos, en orden: uno solo si se registró sin lines. Cada uno con su producto (prd_… o null), descripción, claves del SAT, IVA (null si no es objeto de impuesto), unidades y lo que se cobró por él, impuestos incluidos. */
|
|
1921
|
+
lines: {
|
|
1922
|
+
/** Un producto de su catálogo (prd_…): toma su clave, unidad, precio e impuestos. */
|
|
1923
|
+
product: string | null;
|
|
1924
|
+
/** Descripción. */
|
|
1925
|
+
description: string;
|
|
1926
|
+
/** Clave del producto o servicio (ClaveProdServ), 8 dígitos de c_ClaveProdServ. Búsquela con GET /v1/sat_catalogs/product_keys?q=… */
|
|
1927
|
+
product_key: string;
|
|
1928
|
+
/** Clave de unidad (ClaveUnidad) de c_ClaveUnidad: E48 unidad de servicio (por omisión), H87 pieza, ACT actividad… */
|
|
1929
|
+
unit_key: string;
|
|
1930
|
+
/** Tasa de IVA trasladado: 0.16 (por omisión), 0.08 (región fronteriza), 0 o exento. */
|
|
1931
|
+
iva: string | null;
|
|
1932
|
+
/** Cantidad (Cantidad). Por omisión 1. */
|
|
1933
|
+
quantity: number;
|
|
1934
|
+
/** Total en la moneda del comprobante (Total). */
|
|
1935
|
+
total: number;
|
|
1936
|
+
}[];
|
|
1920
1937
|
/** Cuándo se vendió. */
|
|
1921
1938
|
sold_at: string;
|
|
1922
1939
|
/** El último día (AAAA-MM-DD) en que el comprador puede facturarlo; después entra en la factura global. */
|
|
@@ -1951,6 +1968,14 @@ export interface SelfInvoicing {
|
|
|
1951
1968
|
window_days: number;
|
|
1952
1969
|
/** Cada cuánto se timbra sola la factura global con lo que nadie facturó: 01 diaria, 02 semanal, 03 quincenal, 04 mensual. */
|
|
1953
1970
|
global_periodicity: "01" | "02" | "03" | "04";
|
|
1971
|
+
/** Si el portal pide el total para encontrar el ticket (true) o solo su código (false). */
|
|
1972
|
+
ask_total: boolean;
|
|
1973
|
+
/** El título del portal, o null para «Facture su ticket». */
|
|
1974
|
+
portal_title: string | null;
|
|
1975
|
+
/** El mensaje bajo el título, o null. */
|
|
1976
|
+
portal_message: string | null;
|
|
1977
|
+
/** Dónde encuentra el comprador su código, bajo el campo; null para el texto de Fiscalisto. */
|
|
1978
|
+
code_hint: string | null;
|
|
1954
1979
|
}
|
|
1955
1980
|
/** Una factura que el emisor timbra solo, cada mes, semana o día. */
|
|
1956
1981
|
export interface RecurringInvoice {
|
|
@@ -2537,8 +2562,8 @@ export interface Quote {
|
|
|
2537
2562
|
number: string;
|
|
2538
2563
|
/** Cambiar una ya enviada hace una versión nueva con el mismo número; el id contesta siempre la última. */
|
|
2539
2564
|
version: number;
|
|
2540
|
-
/** draft, sent, viewed (el cliente abrió la liga), accepted, rejected, expired (pasó valid_until) o invoiced. */
|
|
2541
|
-
status: "draft" | "sent" | "viewed" | "accepted" | "rejected" | "expired" | "invoiced";
|
|
2565
|
+
/** draft, sent, viewed (el cliente abrió la liga), accepted, rejected, withdrawn (usted la retiró), expired (pasó valid_until) o invoiced. */
|
|
2566
|
+
status: "draft" | "sent" | "viewed" | "accepted" | "rejected" | "withdrawn" | "expired" | "invoiced";
|
|
2542
2567
|
/** La liga donde el cliente la ve, descarga su PDF, la acepta, pide cambios o la rechaza; null mientras sea borrador. */
|
|
2543
2568
|
url: string | null;
|
|
2544
2569
|
/** A quién va: tax_id null si aún no tiene sus datos fiscales; catalog_id es su cliente (cus_…) en su catálogo, o null. */
|
|
@@ -2577,15 +2602,19 @@ export interface Quote {
|
|
|
2577
2602
|
notes: string | null;
|
|
2578
2603
|
/** Si al aceptarla se timbra la factura sola. */
|
|
2579
2604
|
auto_invoice: boolean;
|
|
2580
|
-
/**
|
|
2605
|
+
/** Si se le manda un recordatorio por correo 3 días antes de su último día mientras no responda (remind en POST /v1/quotes/{id}/send). */
|
|
2606
|
+
remind: boolean;
|
|
2607
|
+
/** Cuándo se mandó el recordatorio, o null. */
|
|
2608
|
+
reminded_at: string | null;
|
|
2609
|
+
/** Lo que escribió el cliente al pedir cambios o al rechazarla, la nota de usted al retirarla o marcarla rechazada, o null. */
|
|
2581
2610
|
customer_comment: string | null;
|
|
2582
2611
|
/** Cuándo se envió. */
|
|
2583
2612
|
sent_at: string | null;
|
|
2584
2613
|
/** Cuándo el cliente abrió la liga por primera vez. */
|
|
2585
2614
|
viewed_at: string | null;
|
|
2586
|
-
/** Cuándo se
|
|
2615
|
+
/** Cuándo se aceptó, se rechazó o se retiró. */
|
|
2587
2616
|
decided_at: string | null;
|
|
2588
|
-
/** customer (en su liga) o user (usted
|
|
2617
|
+
/** customer (en su liga) o user (usted: POST /v1/quotes/{id}/accept, /reject o /withdraw, o desde la app). */
|
|
2589
2618
|
decided_by: "customer" | "user" | null;
|
|
2590
2619
|
/** La factura (inv_…) que se timbró de ella, o null. */
|
|
2591
2620
|
invoice: string | null;
|
|
@@ -2750,14 +2779,14 @@ export interface WebhookTest {
|
|
|
2750
2779
|
};
|
|
2751
2780
|
}
|
|
2752
2781
|
/** Lo que puede pasar: el tipo de cada evento. */
|
|
2753
|
-
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" | "issuer.ready" | "balance.low" | "test_clock.ready";
|
|
2782
|
+
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" | "issuer.ready" | "balance.low" | "test_clock.ready";
|
|
2754
2783
|
/** Algo que pasó en su cuenta: el objeto completo como quedó. Se manda a sus webhooks firmado (Standard Webhooks). */
|
|
2755
2784
|
export interface EventBase<T extends EventType = EventType, O = unknown> {
|
|
2756
2785
|
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
2757
2786
|
id: string;
|
|
2758
2787
|
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2759
2788
|
object: "event";
|
|
2760
|
-
/** 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, 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, issuer.ready, balance.low o test_clock.ready. */
|
|
2789
|
+
/** 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, 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, issuer.ready, balance.low o test_clock.ready. */
|
|
2761
2790
|
type: T;
|
|
2762
2791
|
/** Versión de la API con que se armó el objeto. */
|
|
2763
2792
|
api_version: string;
|
|
@@ -2771,7 +2800,7 @@ export interface EventBase<T extends EventType = EventType, O = unknown> {
|
|
|
2771
2800
|
};
|
|
2772
2801
|
}
|
|
2773
2802
|
/** Un evento: según su type, data.object es la factura, la constancia o el lote. */
|
|
2774
|
-
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<"invoice.email_bounced", Invoice> | EventBase<"invoice.email_complained", Invoice> | EventBase<"retention.stamped", Retention> | EventBase<"retention.failed", Retention> | EventBase<"retention.canceled", Retention> | EventBase<"invoice_batch.completed", InvoiceBatch> | EventBase<"payroll_batch.completed", PayrollBatch> | 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>;
|
|
2803
|
+
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<"invoice.email_bounced", Invoice> | EventBase<"invoice.email_complained", Invoice> | EventBase<"retention.stamped", Retention> | EventBase<"retention.failed", Retention> | EventBase<"retention.canceled", Retention> | EventBase<"invoice_batch.completed", InvoiceBatch> | EventBase<"payroll_batch.completed", PayrollBatch> | 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<"quote.withdrawn", Quote> | EventBase<"issuer.ready", Issuer> | EventBase<"balance.low", Balance> | EventBase<"test_clock.ready", TestClock>;
|
|
2775
2804
|
/** Confirmación de que se borró. */
|
|
2776
2805
|
export interface Deleted {
|
|
2777
2806
|
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
@@ -5421,8 +5450,8 @@ export interface CreateTicketParams {
|
|
|
5421
5450
|
issuer?: string;
|
|
5422
5451
|
/** El folio de la venta en su sistema, único por emisor: letras, números, - _ / y punto. Registrar el mismo folio con el mismo total responde el ticket que ya existe. */
|
|
5423
5452
|
folio: string;
|
|
5424
|
-
/** Lo que se cobró, impuestos incluidos y sin propina. */
|
|
5425
|
-
total
|
|
5453
|
+
/** Lo que se cobró, impuestos incluidos y sin propina. Con `lines` puede omitirlo (es su suma); si lo manda, debe ser igual. */
|
|
5454
|
+
total?: number;
|
|
5426
5455
|
/** Propina: no va en la factura. El cliente puede escribir el total con ella o sin ella. */
|
|
5427
5456
|
tip?: number;
|
|
5428
5457
|
/** c_FormaPago de la venta: 01 efectivo, 04 tarjeta de crédito… */
|
|
@@ -5439,6 +5468,23 @@ export interface CreateTicketParams {
|
|
|
5439
5468
|
unit_key?: string;
|
|
5440
5469
|
/** Tasa de IVA incluida en el total. Por omisión 0.16. */
|
|
5441
5470
|
iva?: "0" | "0.16" | "0.08" | "exento";
|
|
5471
|
+
/** Una venta de varios conceptos (el folio de un hotel: noches, desayunos, lavandería), cada uno con su producto o sus claves, sus impuestos y lo que se cobró por él; hasta 200. En lugar de `product`, `description`, `product_key`, `unit_key` e `iva`. La factura del cliente lleva un concepto por línea; la factura global, uno por cada combinación de impuestos del ticket. */
|
|
5472
|
+
lines?: {
|
|
5473
|
+
/** Un producto (prd_…) de su catálogo: sus claves, IVA e impuestos locales. */
|
|
5474
|
+
product?: string;
|
|
5475
|
+
/** El concepto. Con `product`, reemplaza su descripción; sin él, va con `product_key`. */
|
|
5476
|
+
description?: string;
|
|
5477
|
+
/** c_ClaveProdServ (8 dígitos), si no usa `product`. */
|
|
5478
|
+
product_key?: string;
|
|
5479
|
+
/** c_ClaveUnidad. Por omisión, la de la clave del producto. */
|
|
5480
|
+
unit_key?: string;
|
|
5481
|
+
/** Tasa de IVA incluida en su total. Por omisión 0.16. */
|
|
5482
|
+
iva?: "0" | "0.16" | "0.08" | "exento";
|
|
5483
|
+
/** Unidades (noches, piezas). Por omisión 1. */
|
|
5484
|
+
quantity?: number;
|
|
5485
|
+
/** Lo que se cobró por este concepto, impuestos incluidos. */
|
|
5486
|
+
total: number;
|
|
5487
|
+
}[];
|
|
5442
5488
|
}
|
|
5443
5489
|
/** Los parámetros de GET /v1/tickets. */
|
|
5444
5490
|
export interface ListTicketsParams {
|
|
@@ -5462,6 +5508,14 @@ export interface UpdateSelfInvoicingParams {
|
|
|
5462
5508
|
window_days?: number;
|
|
5463
5509
|
/** c_Periodicidad de la factura global con los tickets que nadie facturó: 01 diaria, 02 semanal, 03 quincenal, 04 mensual. */
|
|
5464
5510
|
global_periodicity?: "01" | "02" | "03" | "04";
|
|
5511
|
+
/** `true` (por omisión): el comprador busca su ticket con el código y el total. `false`: solo con el código (sus 4 caracteres al azar; cada ticket se bloquea tras varios intentos fallidos). */
|
|
5512
|
+
ask_total?: boolean;
|
|
5513
|
+
/** El título del portal, en lugar de «Facture su ticket». `null` lo quita. */
|
|
5514
|
+
portal_title?: string | null;
|
|
5515
|
+
/** Un mensaje bajo el título (instrucciones, horario, a quién escribir). `null` lo quita. */
|
|
5516
|
+
portal_message?: string | null;
|
|
5517
|
+
/** Dónde encuentra el comprador su código, bajo el campo («Viene en su correo de salida»). `null` pone el de Fiscalisto. */
|
|
5518
|
+
code_hint?: string | null;
|
|
5465
5519
|
}
|
|
5466
5520
|
/** Los parámetros de GET /v1/accounting/journal_entries. */
|
|
5467
5521
|
export interface ListJournalEntriesParams {
|
|
@@ -5831,7 +5885,7 @@ export interface ListQuotesParams {
|
|
|
5831
5885
|
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
5832
5886
|
issuer?: string;
|
|
5833
5887
|
/** Solo las que estén en este estado. */
|
|
5834
|
-
status?: "draft" | "sent" | "viewed" | "accepted" | "rejected" | "expired" | "invoiced";
|
|
5888
|
+
status?: "draft" | "sent" | "viewed" | "accepted" | "rejected" | "withdrawn" | "expired" | "invoiced";
|
|
5835
5889
|
}
|
|
5836
5890
|
export interface UpdateQuoteParams {
|
|
5837
5891
|
/** Un cliente de su catálogo (cus_…), uno con sus datos fiscales (como en POST /v1/invoices: se agrega a sus clientes) o solo name y email si aún no los tiene. */
|
|
@@ -5984,6 +6038,16 @@ export interface SendQuoteParams {
|
|
|
5984
6038
|
message?: string;
|
|
5985
6039
|
/** Al aceptarla, timbrar la factura sola (con los datos fiscales del cliente; si no los tiene, la página se los pide primero). Por omisión false: la factura se timbra con POST /v1/quotes/{id}/invoice. */
|
|
5986
6040
|
auto_invoice?: boolean;
|
|
6041
|
+
/** Recordarle por correo, a los mismos destinatarios, 3 días antes de su último día si no ha respondido (una vez). Solo al mandarla por correo; por omisión false. */
|
|
6042
|
+
remind?: boolean;
|
|
6043
|
+
}
|
|
6044
|
+
export interface WithdrawQuoteParams {
|
|
6045
|
+
/** Por qué (queda en customer_comment; el cliente no la ve). */
|
|
6046
|
+
note?: string;
|
|
6047
|
+
}
|
|
6048
|
+
export interface RejectQuoteParams {
|
|
6049
|
+
/** Por qué (queda en customer_comment; el cliente no la ve). */
|
|
6050
|
+
note?: string;
|
|
5987
6051
|
}
|
|
5988
6052
|
export interface CreateWebhookEndpointParams {
|
|
5989
6053
|
/** Dirección https de su servidor que recibe los avisos. */
|
|
@@ -6020,7 +6084,7 @@ export interface RollWebhookSecretParams {
|
|
|
6020
6084
|
}
|
|
6021
6085
|
export interface TestWebhookEndpointParams {
|
|
6022
6086
|
/** El evento a mandar. Por omisión invoice.stamped. */
|
|
6023
|
-
type?: "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" | "issuer.ready" | "balance.low" | "test_clock.ready";
|
|
6087
|
+
type?: "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" | "issuer.ready" | "balance.low" | "test_clock.ready";
|
|
6024
6088
|
}
|
|
6025
6089
|
/** Los parámetros de GET /v1/events. */
|
|
6026
6090
|
export interface ListEventsParams {
|
|
@@ -6029,7 +6093,7 @@ export interface ListEventsParams {
|
|
|
6029
6093
|
/** El id del último de la página anterior, para la siguiente. */
|
|
6030
6094
|
starting_after?: string;
|
|
6031
6095
|
/** Solo de este tipo (invoice.stamped), o todos los de un recurso con un comodín (invoice.*). */
|
|
6032
|
-
type?: "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" | "issuer.ready" | "balance.low" | "test_clock.ready" | "invoice.*" | "invoice_batch.*" | "payroll_batch.*" | "recurring_invoice.*" | "quote.*" | "ticket.*" | "retention.*" | "customer_data_request.*" | "sat_download.*" | "sat_declaration.*" | "issuer.*" | "balance.*" | "test_clock.*";
|
|
6096
|
+
type?: "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" | "issuer.ready" | "balance.low" | "test_clock.ready" | "invoice.*" | "invoice_batch.*" | "payroll_batch.*" | "recurring_invoice.*" | "quote.*" | "ticket.*" | "retention.*" | "customer_data_request.*" | "sat_download.*" | "sat_declaration.*" | "issuer.*" | "balance.*" | "test_clock.*";
|
|
6033
6097
|
/** Solo los de este objeto (inv_…, ret_…, bat_…). */
|
|
6034
6098
|
object?: string;
|
|
6035
6099
|
/** false: los que algún webhook no recibió (su último intento falló). true: los que recibieron todos los webhooks a los que se mandaron. */
|
|
@@ -7300,7 +7364,7 @@ export declare class TicketsResource {
|
|
|
7300
7364
|
/**
|
|
7301
7365
|
* Registrar un ticket
|
|
7302
7366
|
*
|
|
7303
|
-
* Una venta que su comprador factura él mismo: con el código (code) y el total en el portal del emisor (url, que puede incrustar en su página con fiscalisto.js), da sus datos fiscales y la factura se timbra al momento con los timbres de su cuenta. Lo que nadie factura entra solo en la factura global del periodo. Registrar otra vez el mismo folio con el mismo total contesta el ticket que ya existe (los reintentos son seguros); con otro total, 409.
|
|
7367
|
+
* Una venta que su comprador factura él mismo: con el código (code) y el total en el portal del emisor (url, que puede incrustar en su página con fiscalisto.js), da sus datos fiscales y la factura se timbra al momento con los timbres de su cuenta. Lo que nadie factura entra solo en la factura global del periodo. Registrar otra vez el mismo folio con el mismo total contesta el ticket que ya existe (los reintentos son seguros); con otro total, 409. Una venta de varios conceptos (el folio de un hotel) va en lines, cada uno con su clave SAT, descripción, impuestos y monto.
|
|
7304
7368
|
*
|
|
7305
7369
|
* POST /v1/tickets
|
|
7306
7370
|
* @see https://fiscalisto.com/docs/api/referencia/autofactura/create-ticket
|
|
@@ -7581,7 +7645,7 @@ export declare class QuotesResource {
|
|
|
7581
7645
|
/**
|
|
7582
7646
|
* Cambiar una cotización
|
|
7583
7647
|
*
|
|
7584
|
-
* Solo lo que mande cambia. Un borrador cambia ahí mismo; una que ya se envió se vuelve una versión nueva en borrador (mismo número, version + 1) que el cliente ve al mandarla; mientras, su liga muestra la anterior. Una aceptada
|
|
7648
|
+
* Solo lo que mande cambia. Un borrador cambia ahí mismo; una que ya se envió (también si venció, se rechazó o se retiró) se vuelve una versión nueva en borrador (mismo número, version + 1) que el cliente ve al mandarla; mientras, su liga muestra la anterior. Una aceptada o facturada ya no cambia.
|
|
7585
7649
|
*
|
|
7586
7650
|
* POST /v1/quotes/{id}
|
|
7587
7651
|
* @see https://fiscalisto.com/docs/api/referencia/cotizaciones/update-quote
|
|
@@ -7590,7 +7654,7 @@ export declare class QuotesResource {
|
|
|
7590
7654
|
/**
|
|
7591
7655
|
* Borrar una cotización
|
|
7592
7656
|
*
|
|
7593
|
-
*
|
|
7657
|
+
* Borra la cotización con todas sus versiones; si ya se envió, su url deja de funcionar. Una aceptada o facturada no se borra: 400 quote_not_deletable. Para cerrarla sin borrarla, POST /v1/quotes/{id}/withdraw.
|
|
7594
7658
|
*
|
|
7595
7659
|
* DELETE /v1/quotes/{id}
|
|
7596
7660
|
* @see https://fiscalisto.com/docs/api/referencia/cotizaciones/delete-quote
|
|
@@ -7614,6 +7678,24 @@ export declare class QuotesResource {
|
|
|
7614
7678
|
* @see https://fiscalisto.com/docs/api/referencia/cotizaciones/accept-quote
|
|
7615
7679
|
*/
|
|
7616
7680
|
accept(id: string, options?: RequestOptions): Promise<Quote>;
|
|
7681
|
+
/**
|
|
7682
|
+
* Retirar una cotización
|
|
7683
|
+
*
|
|
7684
|
+
* Usted ya no la ofrece: su liga dice que se retiró y el cliente ya no la puede aceptar (status withdrawn, decided_by user). Llega quote.withdrawn. Para ofrecerla de nuevo, cámbiela con POST /v1/quotes/{id} (una versión nueva) y mándela. Una que nunca se envió se borra: 400 quote_not_sent.
|
|
7685
|
+
*
|
|
7686
|
+
* POST /v1/quotes/{id}/withdraw
|
|
7687
|
+
* @see https://fiscalisto.com/docs/api/referencia/cotizaciones/withdraw-quote
|
|
7688
|
+
*/
|
|
7689
|
+
withdraw(id: string, params?: WithdrawQuoteParams, options?: RequestOptions): Promise<Quote>;
|
|
7690
|
+
/**
|
|
7691
|
+
* Marcar rechazada
|
|
7692
|
+
*
|
|
7693
|
+
* El cliente le dijo que no por teléfono, en persona… (status rejected, decided_by user; su nota en customer_comment). Llega quote.rejected. También para una vencida que ya no va a seguir.
|
|
7694
|
+
*
|
|
7695
|
+
* POST /v1/quotes/{id}/reject
|
|
7696
|
+
* @see https://fiscalisto.com/docs/api/referencia/cotizaciones/reject-quote
|
|
7697
|
+
*/
|
|
7698
|
+
reject(id: string, params?: RejectQuoteParams, options?: RequestOptions): Promise<Quote>;
|
|
7617
7699
|
/**
|
|
7618
7700
|
* Facturar una cotización
|
|
7619
7701
|
*
|
package/dist/generated.js
CHANGED
|
@@ -1575,7 +1575,7 @@ export class TicketsResource {
|
|
|
1575
1575
|
/**
|
|
1576
1576
|
* Registrar un ticket
|
|
1577
1577
|
*
|
|
1578
|
-
* Una venta que su comprador factura él mismo: con el código (code) y el total en el portal del emisor (url, que puede incrustar en su página con fiscalisto.js), da sus datos fiscales y la factura se timbra al momento con los timbres de su cuenta. Lo que nadie factura entra solo en la factura global del periodo. Registrar otra vez el mismo folio con el mismo total contesta el ticket que ya existe (los reintentos son seguros); con otro total, 409.
|
|
1578
|
+
* Una venta que su comprador factura él mismo: con el código (code) y el total en el portal del emisor (url, que puede incrustar en su página con fiscalisto.js), da sus datos fiscales y la factura se timbra al momento con los timbres de su cuenta. Lo que nadie factura entra solo en la factura global del periodo. Registrar otra vez el mismo folio con el mismo total contesta el ticket que ya existe (los reintentos son seguros); con otro total, 409. Una venta de varios conceptos (el folio de un hotel) va en lines, cada uno con su clave SAT, descripción, impuestos y monto.
|
|
1579
1579
|
*
|
|
1580
1580
|
* POST /v1/tickets
|
|
1581
1581
|
* @see https://fiscalisto.com/docs/api/referencia/autofactura/create-ticket
|
|
@@ -1922,7 +1922,7 @@ export class QuotesResource {
|
|
|
1922
1922
|
/**
|
|
1923
1923
|
* Cambiar una cotización
|
|
1924
1924
|
*
|
|
1925
|
-
* Solo lo que mande cambia. Un borrador cambia ahí mismo; una que ya se envió se vuelve una versión nueva en borrador (mismo número, version + 1) que el cliente ve al mandarla; mientras, su liga muestra la anterior. Una aceptada
|
|
1925
|
+
* Solo lo que mande cambia. Un borrador cambia ahí mismo; una que ya se envió (también si venció, se rechazó o se retiró) se vuelve una versión nueva en borrador (mismo número, version + 1) que el cliente ve al mandarla; mientras, su liga muestra la anterior. Una aceptada o facturada ya no cambia.
|
|
1926
1926
|
*
|
|
1927
1927
|
* POST /v1/quotes/{id}
|
|
1928
1928
|
* @see https://fiscalisto.com/docs/api/referencia/cotizaciones/update-quote
|
|
@@ -1933,7 +1933,7 @@ export class QuotesResource {
|
|
|
1933
1933
|
/**
|
|
1934
1934
|
* Borrar una cotización
|
|
1935
1935
|
*
|
|
1936
|
-
*
|
|
1936
|
+
* Borra la cotización con todas sus versiones; si ya se envió, su url deja de funcionar. Una aceptada o facturada no se borra: 400 quote_not_deletable. Para cerrarla sin borrarla, POST /v1/quotes/{id}/withdraw.
|
|
1937
1937
|
*
|
|
1938
1938
|
* DELETE /v1/quotes/{id}
|
|
1939
1939
|
* @see https://fiscalisto.com/docs/api/referencia/cotizaciones/delete-quote
|
|
@@ -1963,6 +1963,28 @@ export class QuotesResource {
|
|
|
1963
1963
|
accept(id, options) {
|
|
1964
1964
|
return this.#client.request({ method: "POST", path: `/v1/quotes/${encodeURIComponent(id)}/accept`, idempotent: true }, options);
|
|
1965
1965
|
}
|
|
1966
|
+
/**
|
|
1967
|
+
* Retirar una cotización
|
|
1968
|
+
*
|
|
1969
|
+
* Usted ya no la ofrece: su liga dice que se retiró y el cliente ya no la puede aceptar (status withdrawn, decided_by user). Llega quote.withdrawn. Para ofrecerla de nuevo, cámbiela con POST /v1/quotes/{id} (una versión nueva) y mándela. Una que nunca se envió se borra: 400 quote_not_sent.
|
|
1970
|
+
*
|
|
1971
|
+
* POST /v1/quotes/{id}/withdraw
|
|
1972
|
+
* @see https://fiscalisto.com/docs/api/referencia/cotizaciones/withdraw-quote
|
|
1973
|
+
*/
|
|
1974
|
+
withdraw(id, params, options) {
|
|
1975
|
+
return this.#client.request({ method: "POST", path: `/v1/quotes/${encodeURIComponent(id)}/withdraw`, body: params, idempotent: true }, options);
|
|
1976
|
+
}
|
|
1977
|
+
/**
|
|
1978
|
+
* Marcar rechazada
|
|
1979
|
+
*
|
|
1980
|
+
* El cliente le dijo que no por teléfono, en persona… (status rejected, decided_by user; su nota en customer_comment). Llega quote.rejected. También para una vencida que ya no va a seguir.
|
|
1981
|
+
*
|
|
1982
|
+
* POST /v1/quotes/{id}/reject
|
|
1983
|
+
* @see https://fiscalisto.com/docs/api/referencia/cotizaciones/reject-quote
|
|
1984
|
+
*/
|
|
1985
|
+
reject(id, params, options) {
|
|
1986
|
+
return this.#client.request({ method: "POST", path: `/v1/quotes/${encodeURIComponent(id)}/reject`, body: params, idempotent: true }, options);
|
|
1987
|
+
}
|
|
1966
1988
|
/**
|
|
1967
1989
|
* Facturar una cotización
|
|
1968
1990
|
*
|