fiscalisto 0.1.3 → 0.1.5
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/cli.js +53 -11
- package/dist/core.d.ts +1 -1
- package/dist/core.js +1 -1
- package/dist/error-codes.d.ts +6 -0
- package/dist/error-codes.js +6 -0
- package/dist/generated.d.ts +917 -24
- package/dist/generated.js +323 -0
- package/dist/mock-routes.gen.js +1 -1
- package/package.json +1 -1
package/dist/generated.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { type Client, Core, type List, type RequestOptions } from "./core.js";
|
|
2
2
|
/** La cuenta API de la llave que hizo la solicitud. */
|
|
3
3
|
export interface Account {
|
|
4
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
4
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
5
5
|
id: string;
|
|
6
6
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
7
7
|
livemode: boolean;
|
|
@@ -64,7 +64,7 @@ export interface Balance {
|
|
|
64
64
|
}
|
|
65
65
|
/** Un emisor: un RFC que timbra desde su cuenta API. */
|
|
66
66
|
export interface Issuer {
|
|
67
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
67
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
68
68
|
id: string;
|
|
69
69
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
70
70
|
livemode: boolean;
|
|
@@ -120,7 +120,7 @@ export interface Issuer {
|
|
|
120
120
|
export type InvoiceItem = Record<string, unknown>;
|
|
121
121
|
/** Un CFDI 4.0 emitido: factura de ingreso o global, traslado, nota de crédito (E), complemento de pago (P) o recibo de nómina (N). */
|
|
122
122
|
export interface Invoice {
|
|
123
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
123
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
124
124
|
id: string;
|
|
125
125
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
126
126
|
livemode: boolean;
|
|
@@ -128,6 +128,8 @@ export interface Invoice {
|
|
|
128
128
|
object: "invoice";
|
|
129
129
|
/** El emisor (iss_…). */
|
|
130
130
|
issuer: string;
|
|
131
|
+
/** La sucursal (brn_…) desde donde se timbró, o null (el domicilio fiscal del emisor). Sus pagos y notas de crédito la siguen. */
|
|
132
|
+
branch: string | null;
|
|
131
133
|
/** Tipo de comprobante (TipoDeComprobante): I ingreso, E egreso, P pago, T traslado, N nómina. */
|
|
132
134
|
type: "I" | "E" | "P" | "T" | "N";
|
|
133
135
|
/** processing: el PAC no ha contestado (se resuelve sola; escuche invoice.stamped). valid: timbrada. pending: timbrada con una cancelación en espera del cliente. rejected: el SAT o el PAC no la aceptaron (ver error). canceled: cancelada. */
|
|
@@ -252,7 +254,7 @@ export interface Invoice {
|
|
|
252
254
|
};
|
|
253
255
|
/** El empleado (emp_…). */
|
|
254
256
|
employee: {
|
|
255
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
257
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
256
258
|
id: string | null;
|
|
257
259
|
/** Número de empleado (NumEmpleado). */
|
|
258
260
|
number: string;
|
|
@@ -391,7 +393,7 @@ export interface Invoice {
|
|
|
391
393
|
}
|
|
392
394
|
/** Una constancia de retenciones e información de pagos (CFDI de retenciones 2.0). */
|
|
393
395
|
export interface Retention {
|
|
394
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
396
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
395
397
|
id: string;
|
|
396
398
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
397
399
|
livemode: boolean;
|
|
@@ -499,7 +501,7 @@ export interface Retention {
|
|
|
499
501
|
}
|
|
500
502
|
/** Un cliente del catálogo de un emisor. */
|
|
501
503
|
export interface Customer {
|
|
502
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
504
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
503
505
|
id: string;
|
|
504
506
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
505
507
|
livemode: boolean;
|
|
@@ -535,7 +537,7 @@ export interface Customer {
|
|
|
535
537
|
}
|
|
536
538
|
/** Un producto o servicio del catálogo de un emisor. */
|
|
537
539
|
export interface Product {
|
|
538
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
540
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
539
541
|
id: string;
|
|
540
542
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
541
543
|
livemode: boolean;
|
|
@@ -580,6 +582,14 @@ export interface Product {
|
|
|
580
582
|
/** Tasa en por ciento (TasadeTraslado o TasadeRetencion). */
|
|
581
583
|
rate: number;
|
|
582
584
|
}[];
|
|
585
|
+
/** true si lleva existencias (Inventario). */
|
|
586
|
+
track_stock: boolean;
|
|
587
|
+
/** Su costo por unidad en pesos sin IVA, o null. */
|
|
588
|
+
cost: number | null;
|
|
589
|
+
/** Su código de barras, o null. */
|
|
590
|
+
barcode: string | null;
|
|
591
|
+
/** Su existencia mínima, o null. */
|
|
592
|
+
min_stock: number | null;
|
|
583
593
|
/** Cuándo se creó, ISO 8601 con la hora de la Ciudad de México (-06:00). */
|
|
584
594
|
created_at: string;
|
|
585
595
|
/** Cuándo cambió por última vez, ISO 8601 (-06:00). */
|
|
@@ -587,7 +597,7 @@ export interface Product {
|
|
|
587
597
|
}
|
|
588
598
|
/** Un empleado de un emisor, para sus recibos de nómina. */
|
|
589
599
|
export interface Employee {
|
|
590
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
600
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
591
601
|
id: string;
|
|
592
602
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
593
603
|
livemode: boolean;
|
|
@@ -774,7 +784,7 @@ export interface Advance {
|
|
|
774
784
|
}
|
|
775
785
|
/** Un lote de hasta 1,000 facturas timbradas en segundo plano. */
|
|
776
786
|
export interface InvoiceBatch {
|
|
777
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
787
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
778
788
|
id: string;
|
|
779
789
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
780
790
|
livemode: boolean;
|
|
@@ -903,7 +913,7 @@ export interface TaxIdValidation {
|
|
|
903
913
|
}
|
|
904
914
|
/** Una liga para que un cliente dé sus datos fiscales. */
|
|
905
915
|
export interface CustomerDataRequest {
|
|
906
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
916
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
907
917
|
id: string;
|
|
908
918
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
909
919
|
livemode: boolean;
|
|
@@ -966,7 +976,7 @@ export interface TestDataReset {
|
|
|
966
976
|
}
|
|
967
977
|
/** Un entorno de prueba: el modo de pruebas propio de una persona, con su emisor, llaves, webhooks y eventos aparte. */
|
|
968
978
|
export interface Sandbox {
|
|
969
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
979
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
970
980
|
id: string;
|
|
971
981
|
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
972
982
|
object: "sandbox";
|
|
@@ -1024,7 +1034,7 @@ export interface TestClock {
|
|
|
1024
1034
|
}
|
|
1025
1035
|
/** Una solicitud al SAT de las facturas emitidas o recibidas de un emisor en un periodo. */
|
|
1026
1036
|
export interface SatDownload {
|
|
1027
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
1037
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1028
1038
|
id: string;
|
|
1029
1039
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1030
1040
|
livemode: boolean;
|
|
@@ -1057,7 +1067,7 @@ export interface SatDownload {
|
|
|
1057
1067
|
}
|
|
1058
1068
|
/** Una factura que el SAT tiene del emisor, emitida o recibida, traída con una descarga. */
|
|
1059
1069
|
export interface SatInvoice {
|
|
1060
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
1070
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1061
1071
|
id: string;
|
|
1062
1072
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1063
1073
|
livemode: boolean;
|
|
@@ -1131,7 +1141,7 @@ export interface SatInvoice {
|
|
|
1131
1141
|
}
|
|
1132
1142
|
/** 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
1143
|
export interface SatDeclaration {
|
|
1134
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
1144
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1135
1145
|
id: string;
|
|
1136
1146
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1137
1147
|
livemode: boolean;
|
|
@@ -1285,9 +1295,308 @@ export interface SatDeclarationCalendar {
|
|
|
1285
1295
|
}[];
|
|
1286
1296
|
}[];
|
|
1287
1297
|
}
|
|
1298
|
+
/** Una sucursal del emisor: otro lugar desde donde factura, con su código postal (LugarExpedicion), su dirección en el PDF y sus series. */
|
|
1299
|
+
export interface Branch {
|
|
1300
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1301
|
+
id: string;
|
|
1302
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1303
|
+
livemode: boolean;
|
|
1304
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1305
|
+
object: "branch";
|
|
1306
|
+
/** El emisor de la sucursal. */
|
|
1307
|
+
issuer: string;
|
|
1308
|
+
/** Cómo la llama su equipo; va en el PDF. */
|
|
1309
|
+
name: string;
|
|
1310
|
+
/** Su código postal: el LugarExpedicion de sus CFDI. */
|
|
1311
|
+
zip: string;
|
|
1312
|
+
/** Su dirección, en el PDF de sus facturas. */
|
|
1313
|
+
address: {
|
|
1314
|
+
/** Calle (Calle). */
|
|
1315
|
+
street: string | null;
|
|
1316
|
+
/** Número exterior (NumeroExterior). */
|
|
1317
|
+
exterior: string | null;
|
|
1318
|
+
/** Número interior (NumeroInterior). */
|
|
1319
|
+
interior: string | null;
|
|
1320
|
+
/** Colonia. */
|
|
1321
|
+
neighborhood: string | null;
|
|
1322
|
+
/** Municipio o alcaldía. */
|
|
1323
|
+
city: string | null;
|
|
1324
|
+
/** Estado (Estado): en el extranjero c_Estado para USA y CAN, o texto. */
|
|
1325
|
+
state: string | null;
|
|
1326
|
+
};
|
|
1327
|
+
/** Teléfono, en el PDF, o null. */
|
|
1328
|
+
phone: string | null;
|
|
1329
|
+
/** Correo, en el PDF, o null. */
|
|
1330
|
+
email: string | null;
|
|
1331
|
+
/** La serie de cada tipo de CFDI que se timbra desde ella; null usa la del emisor. */
|
|
1332
|
+
series: {
|
|
1333
|
+
/** Serie de sus facturas (tipo I); null, la del emisor. */
|
|
1334
|
+
invoice: string | null;
|
|
1335
|
+
/** Serie de sus notas de crédito (tipo E); null, la del emisor. */
|
|
1336
|
+
credit_note: string | null;
|
|
1337
|
+
/** Serie de sus complementos de pago (tipo P); null, la del emisor. */
|
|
1338
|
+
payment: string | null;
|
|
1339
|
+
/** Serie de sus traslados (tipo T); null, la del emisor. */
|
|
1340
|
+
transfer: string | null;
|
|
1341
|
+
};
|
|
1342
|
+
/** true si está archivada: ya no se factura desde ella. */
|
|
1343
|
+
archived: boolean;
|
|
1344
|
+
/** Cuándo se creó. */
|
|
1345
|
+
created_at: string | null;
|
|
1346
|
+
/** Cuándo cambió por última vez. */
|
|
1347
|
+
updated_at: string | null;
|
|
1348
|
+
}
|
|
1349
|
+
/** Un almacén del emisor: el de la Matriz y uno por sucursal se crean solos; cada factura saca existencias del de su sucursal. */
|
|
1350
|
+
export interface Warehouse {
|
|
1351
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1352
|
+
id: string;
|
|
1353
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1354
|
+
livemode: boolean;
|
|
1355
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1356
|
+
object: "warehouse";
|
|
1357
|
+
/** El emisor del almacén. */
|
|
1358
|
+
issuer: string;
|
|
1359
|
+
/** Su nombre («Matriz», el de su sucursal, o el que le dieron en la app). */
|
|
1360
|
+
name: string;
|
|
1361
|
+
/** Su clave corta, o null. */
|
|
1362
|
+
code: string | null;
|
|
1363
|
+
/** warehouse (almacén propio) o consignment (mercancía en consignación con un cliente, todavía suya). */
|
|
1364
|
+
type: "warehouse" | "consignment";
|
|
1365
|
+
/** Su sucursal (brn_…), o null si es de la Matriz. */
|
|
1366
|
+
branch: string | null;
|
|
1367
|
+
/** true si es el almacén del que vende y recibe su sucursal. */
|
|
1368
|
+
default: boolean;
|
|
1369
|
+
/** true si está archivado. */
|
|
1370
|
+
archived: boolean;
|
|
1371
|
+
/** Cuándo se creó. */
|
|
1372
|
+
created_at: string | null;
|
|
1373
|
+
}
|
|
1374
|
+
/** Lo que hay de un producto en un almacén, y lo que vale. */
|
|
1375
|
+
export interface StockLevel {
|
|
1376
|
+
/** Su id (stl_…): el producto en ese almacén. Sirve como starting_after. */
|
|
1377
|
+
id: string;
|
|
1378
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1379
|
+
livemode: boolean;
|
|
1380
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1381
|
+
object: "stock_level";
|
|
1382
|
+
/** El producto (prd_…). */
|
|
1383
|
+
product: string;
|
|
1384
|
+
/** El almacén (whs_…). */
|
|
1385
|
+
warehouse: string;
|
|
1386
|
+
/** Lo que hay, en la unidad del producto (todos sus lotes). */
|
|
1387
|
+
on_hand: number;
|
|
1388
|
+
/** Lo apartado por cotizaciones aceptadas que no se han facturado. */
|
|
1389
|
+
reserved: number;
|
|
1390
|
+
/** on_hand menos reserved: lo que se puede vender. */
|
|
1391
|
+
available: number;
|
|
1392
|
+
/** Lo que valen esas existencias a su costo, en pesos sin IVA. */
|
|
1393
|
+
value: number;
|
|
1394
|
+
/** value / on_hand: el costo por unidad, o null sin existencias. */
|
|
1395
|
+
average_cost: number | null;
|
|
1396
|
+
}
|
|
1397
|
+
/** Una entrada o salida de existencias (el kárdex): una venta, una compra, un ajuste, un traspaso… */
|
|
1398
|
+
export interface StockMovement {
|
|
1399
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1400
|
+
id: string;
|
|
1401
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1402
|
+
livemode: boolean;
|
|
1403
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1404
|
+
object: "stock_movement";
|
|
1405
|
+
/** El emisor. */
|
|
1406
|
+
issuer: string;
|
|
1407
|
+
/** El producto (prd_…). */
|
|
1408
|
+
product: string;
|
|
1409
|
+
/** El almacén (whs_…). */
|
|
1410
|
+
warehouse: string;
|
|
1411
|
+
/** sale (una factura), purchase (una compra), customer_return, supplier_return, adjustment, count (conteo físico), transfer_out, transfer_in, initial, cost (un ajuste de costo) o reversal (deshace otro, como una factura cancelada). */
|
|
1412
|
+
type: "sale" | "purchase" | "customer_return" | "supplier_return" | "adjustment" | "count" | "transfer_out" | "transfer_in" | "initial" | "cost" | "reversal";
|
|
1413
|
+
/** Cuánto entró (positivo) o salió (negativo). */
|
|
1414
|
+
quantity: number;
|
|
1415
|
+
/** El costo por unidad con que entró o salió, en pesos sin IVA. */
|
|
1416
|
+
unit_cost: number;
|
|
1417
|
+
/** quantity × unit_cost: lo que cambió el valor del inventario. */
|
|
1418
|
+
value: number;
|
|
1419
|
+
/** El lote o número de serie, o null. */
|
|
1420
|
+
lot: string | null;
|
|
1421
|
+
/** Lo que lo causó: type invoice (id es el UUID del CFDI), adjustment (adj_…), receipt, transfer, count o ticket. */
|
|
1422
|
+
source: {
|
|
1423
|
+
/** Tipo de comprobante (TipoDeComprobante): I ingreso, E egreso, P pago, T traslado, N nómina. */
|
|
1424
|
+
type: string;
|
|
1425
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1426
|
+
id: string;
|
|
1427
|
+
};
|
|
1428
|
+
/** El motivo de un ajuste, o null. */
|
|
1429
|
+
reason: string | null;
|
|
1430
|
+
/** Cuándo pasó, hora de la Ciudad de México (la Fecha del CFDI en una venta). */
|
|
1431
|
+
date: string | null;
|
|
1432
|
+
/** true si un movimiento posterior lo deshizo. */
|
|
1433
|
+
reversed: boolean;
|
|
1434
|
+
/** Cuándo se registró. */
|
|
1435
|
+
created_at: string | null;
|
|
1436
|
+
}
|
|
1437
|
+
/** Un ajuste de existencias: lo que entró o salió de un almacén por inventario inicial, merma, robo, conteo… */
|
|
1438
|
+
export interface StockAdjustment {
|
|
1439
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1440
|
+
id: string;
|
|
1441
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1442
|
+
livemode: boolean;
|
|
1443
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1444
|
+
object: "stock_adjustment";
|
|
1445
|
+
/** El emisor. */
|
|
1446
|
+
issuer: string;
|
|
1447
|
+
/** El almacén (whs_…). */
|
|
1448
|
+
warehouse: string;
|
|
1449
|
+
/** El motivo (ver POST /v1/stock_adjustments). */
|
|
1450
|
+
reason: "shrinkage" | "theft" | "damage" | "expiration" | "internal_use" | "gift" | "initial" | "surplus" | "count" | "other";
|
|
1451
|
+
/** Su nota, o null. */
|
|
1452
|
+
note: string | null;
|
|
1453
|
+
/** applied (ya movió existencias), pending (espera aprobación en la app), rejected o reversed (se deshizo). */
|
|
1454
|
+
status: "applied" | "pending" | "rejected" | "reversed";
|
|
1455
|
+
/** Lo que vale lo que movió, en pesos sin IVA. */
|
|
1456
|
+
value: number;
|
|
1457
|
+
/** Lo que entró o salió de cada producto. */
|
|
1458
|
+
lines: {
|
|
1459
|
+
/** Un producto de su catálogo (prd_…): toma su clave, unidad, precio e impuestos. */
|
|
1460
|
+
product: string;
|
|
1461
|
+
/** Cantidad (Cantidad). Por omisión 1. */
|
|
1462
|
+
quantity: number;
|
|
1463
|
+
/** El costo por unidad que se dio al ajuste, en pesos sin IVA, o null (el costo promedio). */
|
|
1464
|
+
unit_cost: number | null;
|
|
1465
|
+
/** Lote del medicamento (LoteMedicamento). */
|
|
1466
|
+
lot: string | null;
|
|
1467
|
+
}[];
|
|
1468
|
+
/** Cuándo se hizo. */
|
|
1469
|
+
created_at: string | null;
|
|
1470
|
+
}
|
|
1471
|
+
/** La opinión de cumplimiento de obligaciones fiscales (32-D) más reciente del emisor, como la dio el SAT. */
|
|
1472
|
+
export interface ComplianceOpinion {
|
|
1473
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1474
|
+
object: "compliance_opinion";
|
|
1475
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1476
|
+
livemode: boolean;
|
|
1477
|
+
/** El emisor. */
|
|
1478
|
+
issuer: string;
|
|
1479
|
+
/** positive, negative, no_obligations (inscrito sin obligaciones) o suspended (en suspensión de actividades); null si no se ha consultado. */
|
|
1480
|
+
result: "positive" | "negative" | "no_obligations" | "suspended" | null;
|
|
1481
|
+
/** El día que la emitió el SAT (AAAA-MM-DD), o null. */
|
|
1482
|
+
date: string | null;
|
|
1483
|
+
/** Su folio, o null. */
|
|
1484
|
+
folio: string | null;
|
|
1485
|
+
/** Si es negativa, lo que el SAT marca como pendiente. */
|
|
1486
|
+
reasons: string[];
|
|
1487
|
+
/** true si su PDF está en GET /v1/issuers/{id}/compliance_opinion/pdf. */
|
|
1488
|
+
pdf: boolean;
|
|
1489
|
+
/** Cuándo se consultó por última vez, o null. */
|
|
1490
|
+
checked_at: string | null;
|
|
1491
|
+
/** Por qué falló la última consulta, o null. */
|
|
1492
|
+
last_error: string | null;
|
|
1493
|
+
}
|
|
1494
|
+
/** La constancia de situación fiscal más reciente del emisor, generada en el SAT con su e.firma. */
|
|
1495
|
+
export interface TaxStatusCertificate {
|
|
1496
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1497
|
+
object: "tax_status_certificate";
|
|
1498
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1499
|
+
livemode: boolean;
|
|
1500
|
+
/** El emisor. */
|
|
1501
|
+
issuer: string;
|
|
1502
|
+
/** El día que la emitió el SAT (AAAA-MM-DD), o null. */
|
|
1503
|
+
issued_on: string | null;
|
|
1504
|
+
/** Su idCIF, o null. */
|
|
1505
|
+
id_cif: string | null;
|
|
1506
|
+
/** El RFC. */
|
|
1507
|
+
tax_id: string;
|
|
1508
|
+
/** Nombre o razón social como la tiene el SAT, o null. */
|
|
1509
|
+
legal_name: string | null;
|
|
1510
|
+
/** Sus regímenes fiscales (clave de c_RegimenFiscal y nombre). */
|
|
1511
|
+
tax_systems: {
|
|
1512
|
+
/** Clave de la retención (CveRetenc), c_CveRetenc: 01 servicios profesionales, 05 arrendamiento, 14 dividendos, 16 intereses, 18 pagos al extranjero… */
|
|
1513
|
+
code: string;
|
|
1514
|
+
/** Nombre. */
|
|
1515
|
+
name: string;
|
|
1516
|
+
}[];
|
|
1517
|
+
/** El código postal de su domicilio fiscal, o null. */
|
|
1518
|
+
zip: string | null;
|
|
1519
|
+
/** Estatus en el padrón (ACTIVO, SUSPENDIDO…), o null. */
|
|
1520
|
+
status: string | null;
|
|
1521
|
+
/** true si su PDF está en GET /v1/issuers/{id}/tax_status_certificate/pdf. */
|
|
1522
|
+
pdf: boolean;
|
|
1523
|
+
/** Cuándo se generó. */
|
|
1524
|
+
created_at: string | null;
|
|
1525
|
+
}
|
|
1526
|
+
/** Un aviso del buzón tributario del SAT del emisor. */
|
|
1527
|
+
export interface SatMailboxMessage {
|
|
1528
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1529
|
+
id: string;
|
|
1530
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1531
|
+
livemode: boolean;
|
|
1532
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1533
|
+
object: "sat_mailbox_message";
|
|
1534
|
+
/** El emisor. */
|
|
1535
|
+
issuer: string;
|
|
1536
|
+
/** Su asunto. */
|
|
1537
|
+
subject: string;
|
|
1538
|
+
/** Su texto, resumido, o null. */
|
|
1539
|
+
summary: string | null;
|
|
1540
|
+
/** mailbox (el buzón del portal) o email (un aviso que el SAT mandó por correo). */
|
|
1541
|
+
source: "mailbox" | "email";
|
|
1542
|
+
/** true si no se ha leído en el SAT. */
|
|
1543
|
+
unread: boolean;
|
|
1544
|
+
/** urgent (un requerimiento, un plazo), attention o informational. */
|
|
1545
|
+
urgency: "urgent" | "attention" | "informational";
|
|
1546
|
+
/** Qué es: requerimiento, carta invitación, informativo… */
|
|
1547
|
+
kind: string;
|
|
1548
|
+
/** true si pide hacer algo. */
|
|
1549
|
+
action_required: boolean;
|
|
1550
|
+
/** Cuándo llegó, como lo dice el SAT. */
|
|
1551
|
+
received_at: string | null;
|
|
1552
|
+
/** Cuándo lo trajo Fiscalisto. */
|
|
1553
|
+
created_at: string | null;
|
|
1554
|
+
}
|
|
1555
|
+
/** Una consulta al SAT de un documento del emisor: si ya terminó y dónde leerlo. */
|
|
1556
|
+
export interface SatRefresh {
|
|
1557
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1558
|
+
object: "sat_refresh";
|
|
1559
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1560
|
+
livemode: boolean;
|
|
1561
|
+
/** El emisor. */
|
|
1562
|
+
issuer: string;
|
|
1563
|
+
/** Qué se consultó. */
|
|
1564
|
+
document: "compliance_opinion" | "tax_status_certificate" | "sat_mailbox";
|
|
1565
|
+
/** completed (ya está en url) o processing (el SAT tarda; llega a url en unos minutos). */
|
|
1566
|
+
status: "completed" | "processing";
|
|
1567
|
+
/** Cuándo se pidió. */
|
|
1568
|
+
refreshed_at: string | null;
|
|
1569
|
+
/** Desde cuándo se puede pedir otra vez. */
|
|
1570
|
+
next_refresh_at: string | null;
|
|
1571
|
+
/** Dónde leer lo que trajo. */
|
|
1572
|
+
url: string;
|
|
1573
|
+
}
|
|
1574
|
+
/** Un tipo de hallazgo en los CFDI del emisor (un proveedor en la lista 69-B, un CFDI cancelado, un pago en efectivo de más de $2,000…), con cuántos CFDI lo tienen. */
|
|
1575
|
+
export interface SatFinding {
|
|
1576
|
+
/** El código del hallazgo (el mismo que code). */
|
|
1577
|
+
id: string;
|
|
1578
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1579
|
+
livemode: boolean;
|
|
1580
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1581
|
+
object: "sat_finding";
|
|
1582
|
+
/** El emisor. */
|
|
1583
|
+
issuer: string;
|
|
1584
|
+
/** El código del hallazgo, estable (por ejemplo efos_definitivo). */
|
|
1585
|
+
code: string;
|
|
1586
|
+
/** critical (grave), warning (revisar) o info. */
|
|
1587
|
+
severity: "critical" | "warning" | "info";
|
|
1588
|
+
/** Qué es, en palabras. */
|
|
1589
|
+
title: string;
|
|
1590
|
+
/** Por qué importa y qué hacer, o null. */
|
|
1591
|
+
explanation: string | null;
|
|
1592
|
+
/** Cuántos CFDI lo tienen, sin revisar. */
|
|
1593
|
+
invoices: number;
|
|
1594
|
+
/** La suma de sus totales. */
|
|
1595
|
+
amount: number;
|
|
1596
|
+
}
|
|
1288
1597
|
/** Una venta que su comprador puede facturar él mismo en el portal del emisor (autofactura). */
|
|
1289
1598
|
export interface Ticket {
|
|
1290
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
1599
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1291
1600
|
id: string;
|
|
1292
1601
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1293
1602
|
livemode: boolean;
|
|
@@ -1350,7 +1659,7 @@ export interface SelfInvoicing {
|
|
|
1350
1659
|
}
|
|
1351
1660
|
/** Una factura que el emisor timbra solo, cada mes, semana o día. */
|
|
1352
1661
|
export interface RecurringInvoice {
|
|
1353
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
1662
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1354
1663
|
id: string;
|
|
1355
1664
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1356
1665
|
livemode: boolean;
|
|
@@ -1744,6 +2053,46 @@ export interface CrossChecks {
|
|
|
1744
2053
|
}[];
|
|
1745
2054
|
};
|
|
1746
2055
|
}
|
|
2056
|
+
/** Los CFDI que forman una cifra del cruce de un mes (invoiced): cada uno con lo que aporta, y el ajuste que Impuestos agrega encima. */
|
|
2057
|
+
export interface CrossCheckCfdi {
|
|
2058
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2059
|
+
object: "cross_check_cfdi";
|
|
2060
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
2061
|
+
livemode: boolean;
|
|
2062
|
+
/** El emisor. */
|
|
2063
|
+
issuer: string;
|
|
2064
|
+
/** El mes (AAAA-MM). */
|
|
2065
|
+
month: string;
|
|
2066
|
+
/** La cifra: vat_charged (IVA trasladado), vat_creditable (IVA acreditable), vat_withheld (IVA que le retuvieron), isr_income (ingresos para ISR), isr_withheld_salaries (ISR retenido en sus recibos de nómina), isr_withheld_suppliers o vat_withheld_suppliers (ISR o IVA que retuvo a proveedores). */
|
|
2067
|
+
key: "vat_charged" | "vat_creditable" | "vat_withheld" | "isr_income" | "isr_withheld_salaries" | "isr_withheld_suppliers" | "vat_withheld_suppliers";
|
|
2068
|
+
/** El cruce de esa cifra, como en GET /v1/accounting/cross_checks: matches, differs, not_filed o unreadable. */
|
|
2069
|
+
status: "matches" | "differs" | "not_filed" | "unreadable";
|
|
2070
|
+
/** Lo declarado, en pesos; null si no hay declaración o no se pudo leer. */
|
|
2071
|
+
declared: number | null;
|
|
2072
|
+
/** Lo que dicen los CFDI del mes: la suma de cfdi más adjustment. */
|
|
2073
|
+
invoiced: number;
|
|
2074
|
+
/** declared menos invoiced; null si declared es null. */
|
|
2075
|
+
difference: number | null;
|
|
2076
|
+
/** El número de operación de la declaración de donde salió la cifra. */
|
|
2077
|
+
operation_number: string | null;
|
|
2078
|
+
/** Cada CFDI que suma en el mes, de mayor a menor: los PUE y las notas de crédito en su mes, las facturas PPD por lo que se pagó en el mes. */
|
|
2079
|
+
cfdi: {
|
|
2080
|
+
/** El folio fiscal (UUID) del CFDI; el de la factura PPD en un pago. */
|
|
2081
|
+
uuid: string | null;
|
|
2082
|
+
/** invoice (factura de ingreso, PUE), credit_note (nota de crédito: resta) o payment (lo pagado en el mes de una factura PPD). */
|
|
2083
|
+
type: "invoice" | "credit_note" | "payment";
|
|
2084
|
+
/** La fecha del CFDI, o la del pago (AAAA-MM-DD). */
|
|
2085
|
+
date: string | null;
|
|
2086
|
+
/** El RFC de la contraparte: el cliente en lo emitido, el proveedor en lo recibido. */
|
|
2087
|
+
tax_id: string | null;
|
|
2088
|
+
/** El nombre de la contraparte, como viene en el CFDI. */
|
|
2089
|
+
name: string | null;
|
|
2090
|
+
/** Lo que aporta a la cifra, en pesos; negativo en una nota de crédito. */
|
|
2091
|
+
amount: number;
|
|
2092
|
+
}[];
|
|
2093
|
+
/** Lo que Impuestos agrega sobre los CFDI: en vat_creditable, la proporción de gastos comunes, el IVA retenido enterado del mes anterior y las importaciones; 0 en las demás. */
|
|
2094
|
+
adjustment: number;
|
|
2095
|
+
}
|
|
1747
2096
|
/** La DIOT de un mes: lo pagado a cada proveedor, por tipo de operación. */
|
|
1748
2097
|
export interface Diot {
|
|
1749
2098
|
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
@@ -1804,7 +2153,7 @@ export interface Diot {
|
|
|
1804
2153
|
}
|
|
1805
2154
|
/** Una tienda de Shopify o Mercado Libre cuyos pedidos pagados se vuelven tickets de autofactura del emisor. */
|
|
1806
2155
|
export interface StoreConnection {
|
|
1807
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
2156
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1808
2157
|
id: string;
|
|
1809
2158
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1810
2159
|
livemode: boolean;
|
|
@@ -1877,7 +2226,7 @@ export interface StoreImport {
|
|
|
1877
2226
|
}
|
|
1878
2227
|
/** Una cotización: su cliente la ve en una liga, la acepta, pide cambios o la rechaza, y se factura. */
|
|
1879
2228
|
export interface Quote {
|
|
1880
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
2229
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1881
2230
|
id: string;
|
|
1882
2231
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1883
2232
|
livemode: boolean;
|
|
@@ -1972,7 +2321,7 @@ export interface Receivable {
|
|
|
1972
2321
|
}
|
|
1973
2322
|
/** Un depósito de la cuenta del emisor, y las facturas que pagó. */
|
|
1974
2323
|
export interface BankTransaction {
|
|
1975
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
2324
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1976
2325
|
id: string;
|
|
1977
2326
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1978
2327
|
livemode: boolean;
|
|
@@ -2052,7 +2401,7 @@ export interface IssuerOnboardingLink {
|
|
|
2052
2401
|
}
|
|
2053
2402
|
/** Una dirección de su servidor que recibe eventos. */
|
|
2054
2403
|
export interface WebhookEndpoint {
|
|
2055
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
2404
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
2056
2405
|
id: string;
|
|
2057
2406
|
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
2058
2407
|
livemode: boolean;
|
|
@@ -2105,7 +2454,7 @@ export interface WebhookTest {
|
|
|
2105
2454
|
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";
|
|
2106
2455
|
/** Algo que pasó en su cuenta: el objeto completo como quedó. Se manda a sus webhooks firmado (Standard Webhooks). */
|
|
2107
2456
|
export interface EventBase<T extends EventType = EventType, O = unknown> {
|
|
2108
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
2457
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
2109
2458
|
id: string;
|
|
2110
2459
|
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2111
2460
|
object: "event";
|
|
@@ -2126,7 +2475,7 @@ export interface EventBase<T extends EventType = EventType, O = unknown> {
|
|
|
2126
2475
|
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>;
|
|
2127
2476
|
/** Confirmación de que se borró. */
|
|
2128
2477
|
export interface Deleted {
|
|
2129
|
-
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, evt_, whe_). */
|
|
2478
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
2130
2479
|
id: string;
|
|
2131
2480
|
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2132
2481
|
object: string;
|
|
@@ -2245,6 +2594,16 @@ export interface InvoiceBatchList {
|
|
|
2245
2594
|
/** La ruta de esta lista. */
|
|
2246
2595
|
url: string;
|
|
2247
2596
|
}
|
|
2597
|
+
export interface BranchList {
|
|
2598
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2599
|
+
object: "list";
|
|
2600
|
+
/** Los objetos de esta página. */
|
|
2601
|
+
data: Branch[];
|
|
2602
|
+
/** true si hay más: pida la siguiente con starting_after igual al id del último. */
|
|
2603
|
+
has_more: boolean;
|
|
2604
|
+
/** La ruta de esta lista. */
|
|
2605
|
+
url: string;
|
|
2606
|
+
}
|
|
2248
2607
|
export interface CustomerList {
|
|
2249
2608
|
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2250
2609
|
object: "list";
|
|
@@ -2275,6 +2634,66 @@ export interface ProductList {
|
|
|
2275
2634
|
/** La ruta de esta lista. */
|
|
2276
2635
|
url: string;
|
|
2277
2636
|
}
|
|
2637
|
+
export interface SatMailboxMessageList {
|
|
2638
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2639
|
+
object: "list";
|
|
2640
|
+
/** Los objetos de esta página. */
|
|
2641
|
+
data: SatMailboxMessage[];
|
|
2642
|
+
/** true si hay más: pida la siguiente con starting_after igual al id del último. */
|
|
2643
|
+
has_more: boolean;
|
|
2644
|
+
/** La ruta de esta lista. */
|
|
2645
|
+
url: string;
|
|
2646
|
+
}
|
|
2647
|
+
export interface SatFindingList {
|
|
2648
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2649
|
+
object: "list";
|
|
2650
|
+
/** Los objetos de esta página. */
|
|
2651
|
+
data: SatFinding[];
|
|
2652
|
+
/** true si hay más: pida la siguiente con starting_after igual al id del último. */
|
|
2653
|
+
has_more: boolean;
|
|
2654
|
+
/** La ruta de esta lista. */
|
|
2655
|
+
url: string;
|
|
2656
|
+
}
|
|
2657
|
+
export interface WarehouseList {
|
|
2658
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2659
|
+
object: "list";
|
|
2660
|
+
/** Los objetos de esta página. */
|
|
2661
|
+
data: Warehouse[];
|
|
2662
|
+
/** true si hay más: pida la siguiente con starting_after igual al id del último. */
|
|
2663
|
+
has_more: boolean;
|
|
2664
|
+
/** La ruta de esta lista. */
|
|
2665
|
+
url: string;
|
|
2666
|
+
}
|
|
2667
|
+
export interface StockLevelList {
|
|
2668
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2669
|
+
object: "list";
|
|
2670
|
+
/** Los objetos de esta página. */
|
|
2671
|
+
data: StockLevel[];
|
|
2672
|
+
/** true si hay más: pida la siguiente con starting_after igual al id del último. */
|
|
2673
|
+
has_more: boolean;
|
|
2674
|
+
/** La ruta de esta lista. */
|
|
2675
|
+
url: string;
|
|
2676
|
+
}
|
|
2677
|
+
export interface StockMovementList {
|
|
2678
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2679
|
+
object: "list";
|
|
2680
|
+
/** Los objetos de esta página. */
|
|
2681
|
+
data: StockMovement[];
|
|
2682
|
+
/** true si hay más: pida la siguiente con starting_after igual al id del último. */
|
|
2683
|
+
has_more: boolean;
|
|
2684
|
+
/** La ruta de esta lista. */
|
|
2685
|
+
url: string;
|
|
2686
|
+
}
|
|
2687
|
+
export interface StockAdjustmentList {
|
|
2688
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2689
|
+
object: "list";
|
|
2690
|
+
/** Los objetos de esta página. */
|
|
2691
|
+
data: StockAdjustment[];
|
|
2692
|
+
/** true si hay más: pida la siguiente con starting_after igual al id del último. */
|
|
2693
|
+
has_more: boolean;
|
|
2694
|
+
/** La ruta de esta lista. */
|
|
2695
|
+
url: string;
|
|
2696
|
+
}
|
|
2278
2697
|
export interface SatCatalogEntryList {
|
|
2279
2698
|
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2280
2699
|
object: "list";
|
|
@@ -2409,6 +2828,10 @@ export interface EventList {
|
|
|
2409
2828
|
export interface InvoiceCreate {
|
|
2410
2829
|
/** Emisor (iss_…). Si la llave tiene un solo emisor o la cuenta tiene uno solo, puede omitirse. */
|
|
2411
2830
|
issuer?: string;
|
|
2831
|
+
/** Sucursal (brn_…) desde donde se factura: su código postal va en LugarExpedicion, su dirección en el PDF y, si las tiene, sus series. Sin ella, el domicilio fiscal del emisor (la Matriz). */
|
|
2832
|
+
branch?: string;
|
|
2833
|
+
/** Almacén (whs_…) de donde salen sus productos con track_stock. Por omisión, el de su sucursal (o el de la Matriz). */
|
|
2834
|
+
warehouse?: string;
|
|
2412
2835
|
/** Cliente (Receptor): el id de uno de su catálogo (cus_…) o sus datos en un objeto. */
|
|
2413
2836
|
customer: string | {
|
|
2414
2837
|
/** RFC (Rfc), 12 caracteres una persona moral y 13 una física. */
|
|
@@ -3835,6 +4258,95 @@ export interface ValidateTaxIdParams {
|
|
|
3835
4258
|
/** El idCIF de su constancia de situación fiscal (11 dígitos, arriba a la izquierda, junto al QR). Con él se compara todo con lo que tiene el SAT. */
|
|
3836
4259
|
cif_id?: string;
|
|
3837
4260
|
}
|
|
4261
|
+
export interface CreateBranchParams {
|
|
4262
|
+
/** El emisor (iss_…). Por omisión, su único emisor. */
|
|
4263
|
+
issuer?: string;
|
|
4264
|
+
/** Cómo la llama su equipo, por ejemplo «Sucursal Monterrey». Va en el PDF. */
|
|
4265
|
+
name: string;
|
|
4266
|
+
/** Su código postal (LugarExpedicion de sus CFDI): uno por sucursal, distinto del domicilio fiscal del emisor. */
|
|
4267
|
+
zip: string;
|
|
4268
|
+
/** La dirección que va en el PDF de sus facturas. */
|
|
4269
|
+
address?: {
|
|
4270
|
+
/** Calle. */
|
|
4271
|
+
street?: string | null;
|
|
4272
|
+
/** Número exterior. */
|
|
4273
|
+
exterior?: string | null;
|
|
4274
|
+
/** Número interior. */
|
|
4275
|
+
interior?: string | null;
|
|
4276
|
+
/** Colonia. */
|
|
4277
|
+
neighborhood?: string | null;
|
|
4278
|
+
/** Municipio o alcaldía. */
|
|
4279
|
+
city?: string | null;
|
|
4280
|
+
/** Estado; por omisión, el de su código postal. */
|
|
4281
|
+
state?: string | null;
|
|
4282
|
+
};
|
|
4283
|
+
/** Teléfono, para el PDF. */
|
|
4284
|
+
phone?: string | null;
|
|
4285
|
+
/** Correo, para el PDF. */
|
|
4286
|
+
email?: string | null;
|
|
4287
|
+
/** Serie (Serie), hasta 25 caracteres. Cada serie lleva sus propios folios. */
|
|
4288
|
+
series?: {
|
|
4289
|
+
/** Serie de sus facturas (tipo I); sin ella, la del emisor. */
|
|
4290
|
+
invoice?: string | null;
|
|
4291
|
+
/** Serie de sus notas de crédito (tipo E); sin ella, la del emisor. */
|
|
4292
|
+
credit_note?: string | null;
|
|
4293
|
+
/** Serie de sus complementos de pago (tipo P); sin ella, la del emisor. */
|
|
4294
|
+
payment?: string | null;
|
|
4295
|
+
/** Serie de sus traslados (tipo T); sin ella, la del emisor. */
|
|
4296
|
+
transfer?: string | null;
|
|
4297
|
+
};
|
|
4298
|
+
}
|
|
4299
|
+
/** Los parámetros de GET /v1/branches. */
|
|
4300
|
+
export interface ListBranchesParams {
|
|
4301
|
+
/** Cuántos por página, de 1 a 100. Por omisión 10. */
|
|
4302
|
+
limit?: number;
|
|
4303
|
+
/** El id del último de la página anterior, para la siguiente. */
|
|
4304
|
+
starting_after?: string;
|
|
4305
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
4306
|
+
issuer?: string;
|
|
4307
|
+
/** true para incluir las archivadas. */
|
|
4308
|
+
include_archived?: boolean;
|
|
4309
|
+
/** Solo la de este código postal. */
|
|
4310
|
+
zip?: string;
|
|
4311
|
+
}
|
|
4312
|
+
export interface UpdateBranchParams {
|
|
4313
|
+
/** Cómo la llama su equipo, por ejemplo «Sucursal Monterrey». Va en el PDF. */
|
|
4314
|
+
name?: string;
|
|
4315
|
+
/** Su código postal (LugarExpedicion de sus CFDI): uno por sucursal, distinto del domicilio fiscal del emisor. */
|
|
4316
|
+
zip?: string;
|
|
4317
|
+
/** La dirección que va en el PDF de sus facturas. */
|
|
4318
|
+
address?: {
|
|
4319
|
+
/** Calle. */
|
|
4320
|
+
street?: string | null;
|
|
4321
|
+
/** Número exterior. */
|
|
4322
|
+
exterior?: string | null;
|
|
4323
|
+
/** Número interior. */
|
|
4324
|
+
interior?: string | null;
|
|
4325
|
+
/** Colonia. */
|
|
4326
|
+
neighborhood?: string | null;
|
|
4327
|
+
/** Municipio o alcaldía. */
|
|
4328
|
+
city?: string | null;
|
|
4329
|
+
/** Estado; por omisión, el de su código postal. */
|
|
4330
|
+
state?: string | null;
|
|
4331
|
+
};
|
|
4332
|
+
/** Teléfono, para el PDF. */
|
|
4333
|
+
phone?: string | null;
|
|
4334
|
+
/** Correo, para el PDF. */
|
|
4335
|
+
email?: string | null;
|
|
4336
|
+
/** Serie (Serie), hasta 25 caracteres. Cada serie lleva sus propios folios. */
|
|
4337
|
+
series?: {
|
|
4338
|
+
/** Serie de sus facturas (tipo I); sin ella, la del emisor. */
|
|
4339
|
+
invoice?: string | null;
|
|
4340
|
+
/** Serie de sus notas de crédito (tipo E); sin ella, la del emisor. */
|
|
4341
|
+
credit_note?: string | null;
|
|
4342
|
+
/** Serie de sus complementos de pago (tipo P); sin ella, la del emisor. */
|
|
4343
|
+
payment?: string | null;
|
|
4344
|
+
/** Serie de sus traslados (tipo T); sin ella, la del emisor. */
|
|
4345
|
+
transfer?: string | null;
|
|
4346
|
+
};
|
|
4347
|
+
/** true la archiva: ya no se puede facturar desde ella, y sus facturas la siguen nombrando. false la restaura. */
|
|
4348
|
+
archived?: boolean;
|
|
4349
|
+
}
|
|
3838
4350
|
export interface CreateCustomerParams {
|
|
3839
4351
|
/** Emisor (iss_…). Si la llave tiene un solo emisor o la cuenta tiene uno solo, puede omitirse. */
|
|
3840
4352
|
issuer?: string;
|
|
@@ -3953,6 +4465,14 @@ export interface CreateProductParams {
|
|
|
3953
4465
|
/** Tasa en por ciento (TasadeTraslado o TasadeRetencion). */
|
|
3954
4466
|
rate: number;
|
|
3955
4467
|
}[];
|
|
4468
|
+
/** Lleva existencias (Inventario): cada factura que lo vende las saca del almacén de su sucursal, y una cancelada las regresa. Ver GET /v1/products/{id}/stock. */
|
|
4469
|
+
track_stock?: boolean;
|
|
4470
|
+
/** Su costo por unidad en pesos sin IVA, hasta que sus compras den otro: vale las existencias que entran sin unit_cost. */
|
|
4471
|
+
cost?: number | null;
|
|
4472
|
+
/** Código de barras (EAN, UPC o el suyo). Una factura cuyo concepto lo trae como NoIdentificacion saca existencias de este producto. */
|
|
4473
|
+
barcode?: string | null;
|
|
4474
|
+
/** Existencia mínima: por debajo, el aviso de existencias bajas lo incluye. */
|
|
4475
|
+
min_stock?: number | null;
|
|
3956
4476
|
}
|
|
3957
4477
|
/** Los parámetros de GET /v1/products. */
|
|
3958
4478
|
export interface ListProductsParams {
|
|
@@ -4005,6 +4525,107 @@ export interface UpdateProductParams {
|
|
|
4005
4525
|
/** Tasa en por ciento (TasadeTraslado o TasadeRetencion). */
|
|
4006
4526
|
rate: number;
|
|
4007
4527
|
}[];
|
|
4528
|
+
/** Lleva existencias (Inventario): cada factura que lo vende las saca del almacén de su sucursal, y una cancelada las regresa. Ver GET /v1/products/{id}/stock. */
|
|
4529
|
+
track_stock?: boolean;
|
|
4530
|
+
/** Su costo por unidad en pesos sin IVA, hasta que sus compras den otro: vale las existencias que entran sin unit_cost. */
|
|
4531
|
+
cost?: number | null;
|
|
4532
|
+
/** Código de barras (EAN, UPC o el suyo). Una factura cuyo concepto lo trae como NoIdentificacion saca existencias de este producto. */
|
|
4533
|
+
barcode?: string | null;
|
|
4534
|
+
/** Existencia mínima: por debajo, el aviso de existencias bajas lo incluye. */
|
|
4535
|
+
min_stock?: number | null;
|
|
4536
|
+
}
|
|
4537
|
+
/** Los parámetros de GET /v1/sat_mailbox_messages. */
|
|
4538
|
+
export interface ListSatMailboxMessagesParams {
|
|
4539
|
+
/** Cuántos por página, de 1 a 100. Por omisión 10. */
|
|
4540
|
+
limit?: number;
|
|
4541
|
+
/** El id del último de la página anterior, para la siguiente. */
|
|
4542
|
+
starting_after?: string;
|
|
4543
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
4544
|
+
issuer?: string;
|
|
4545
|
+
/** true para solo los no leídos en el SAT, false para los leídos. */
|
|
4546
|
+
unread?: boolean;
|
|
4547
|
+
}
|
|
4548
|
+
/** Los parámetros de GET /v1/sat_findings. */
|
|
4549
|
+
export interface ListSatFindingsParams {
|
|
4550
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
4551
|
+
issuer?: string;
|
|
4552
|
+
/** issued (emitidos) o received (recibidos); sin él, los dos. */
|
|
4553
|
+
direction?: "issued" | "received";
|
|
4554
|
+
/** CFDI desde este día (AAAA-MM-DD). */
|
|
4555
|
+
date_gte?: string;
|
|
4556
|
+
/** CFDI hasta este día (AAAA-MM-DD, completo). */
|
|
4557
|
+
date_lte?: string;
|
|
4558
|
+
}
|
|
4559
|
+
/** Los parámetros de GET /v1/warehouses. */
|
|
4560
|
+
export interface ListWarehousesParams {
|
|
4561
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
4562
|
+
issuer?: string;
|
|
4563
|
+
/** true para incluir los archivados. */
|
|
4564
|
+
include_archived?: boolean;
|
|
4565
|
+
}
|
|
4566
|
+
/** Los parámetros de GET /v1/warehouses/{id}/stock. */
|
|
4567
|
+
export interface ListWarehouseStockParams {
|
|
4568
|
+
/** Cuántos por página, de 1 a 100. Por omisión 10. */
|
|
4569
|
+
limit?: number;
|
|
4570
|
+
/** El id del último de la página anterior, para la siguiente. */
|
|
4571
|
+
starting_after?: string;
|
|
4572
|
+
/** true para incluir los productos con track_stock que están en 0. */
|
|
4573
|
+
include_empty?: boolean;
|
|
4574
|
+
}
|
|
4575
|
+
/** Los parámetros de GET /v1/stock_movements. */
|
|
4576
|
+
export interface ListStockMovementsParams {
|
|
4577
|
+
/** Cuántos por página, de 1 a 100. Por omisión 10. */
|
|
4578
|
+
limit?: number;
|
|
4579
|
+
/** El id del último de la página anterior, para la siguiente. */
|
|
4580
|
+
starting_after?: string;
|
|
4581
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
4582
|
+
issuer?: string;
|
|
4583
|
+
/** Solo los de este producto (prd_…). */
|
|
4584
|
+
product?: string;
|
|
4585
|
+
/** Solo los de este almacén (whs_…). */
|
|
4586
|
+
warehouse?: string;
|
|
4587
|
+
/** Solo los de este tipo. */
|
|
4588
|
+
type?: "sale" | "purchase" | "customer_return" | "supplier_return" | "adjustment" | "count" | "transfer_out" | "transfer_in" | "initial" | "cost" | "reversal";
|
|
4589
|
+
/** Desde este día (AAAA-MM-DD) u hora (AAAA-MM-DDTHH:MM:SS) de la Ciudad de México. */
|
|
4590
|
+
date_gte?: string;
|
|
4591
|
+
/** Hasta este día (completo) u hora de la Ciudad de México. */
|
|
4592
|
+
date_lte?: string;
|
|
4593
|
+
}
|
|
4594
|
+
export interface CreateStockAdjustmentParams {
|
|
4595
|
+
/** El emisor (iss_…). Por omisión, su único emisor. */
|
|
4596
|
+
issuer?: string;
|
|
4597
|
+
/** El almacén (whs_…). Por omisión, el de la Matriz. */
|
|
4598
|
+
warehouse?: string;
|
|
4599
|
+
/** Por qué: shrinkage (merma), theft (robo o extravío), damage (daño), expiration (caducidad), internal_use (uso interno), gift (muestra o regalo), initial (inventario inicial), surplus (sobrante), count (conteo físico) u other. */
|
|
4600
|
+
reason: "shrinkage" | "theft" | "damage" | "expiration" | "internal_use" | "gift" | "initial" | "surplus" | "count" | "other";
|
|
4601
|
+
/** Una nota, para el kárdex. */
|
|
4602
|
+
note?: string | null;
|
|
4603
|
+
/** Lo que entra o sale de cada producto, hasta 500 líneas. */
|
|
4604
|
+
lines: {
|
|
4605
|
+
/** El producto (prd_…), con track_stock: true. */
|
|
4606
|
+
product: string;
|
|
4607
|
+
/** Cuánto entra (positivo) o sale (negativo), en la unidad del producto. */
|
|
4608
|
+
quantity: number;
|
|
4609
|
+
/** Lo que costó cada unidad que entra, en pesos sin IVA; sin él, el costo promedio de hoy. */
|
|
4610
|
+
unit_cost?: number;
|
|
4611
|
+
/** El lote o número de serie, si el producto los lleva. */
|
|
4612
|
+
lot?: string;
|
|
4613
|
+
/** La caducidad de un lote nuevo (AAAA-MM-DD). */
|
|
4614
|
+
expires_on?: string;
|
|
4615
|
+
}[];
|
|
4616
|
+
}
|
|
4617
|
+
/** Los parámetros de GET /v1/stock_adjustments. */
|
|
4618
|
+
export interface ListStockAdjustmentsParams {
|
|
4619
|
+
/** Cuántos por página, de 1 a 100. Por omisión 10. */
|
|
4620
|
+
limit?: number;
|
|
4621
|
+
/** El id del último de la página anterior, para la siguiente. */
|
|
4622
|
+
starting_after?: string;
|
|
4623
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
4624
|
+
issuer?: string;
|
|
4625
|
+
/** Solo los de este almacén (whs_…). */
|
|
4626
|
+
warehouse?: string;
|
|
4627
|
+
/** applied, pending, rejected o reversed. */
|
|
4628
|
+
status?: "applied" | "pending" | "rejected" | "reversed";
|
|
4008
4629
|
}
|
|
4009
4630
|
/** Los parámetros de GET /v1/sat_catalogs/{name}. */
|
|
4010
4631
|
export interface GetSatCatalogParams {
|
|
@@ -4168,6 +4789,15 @@ export interface GetCrossChecksParams {
|
|
|
4168
4789
|
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
4169
4790
|
issuer?: string;
|
|
4170
4791
|
}
|
|
4792
|
+
/** Los parámetros de GET /v1/accounting/cross_checks/cfdi. */
|
|
4793
|
+
export interface GetCrossCheckCfdiParams {
|
|
4794
|
+
/** El mes (AAAA-MM), cuya declaración ya venció. */
|
|
4795
|
+
month: string;
|
|
4796
|
+
/** La cifra: vat_charged, vat_creditable, vat_withheld, isr_income, isr_withheld_salaries, isr_withheld_suppliers o vat_withheld_suppliers. */
|
|
4797
|
+
key: "vat_charged" | "vat_creditable" | "vat_withheld" | "isr_income" | "isr_withheld_salaries" | "isr_withheld_suppliers" | "vat_withheld_suppliers";
|
|
4798
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
4799
|
+
issuer?: string;
|
|
4800
|
+
}
|
|
4171
4801
|
/** Los parámetros de GET /v1/accounting/accounts. */
|
|
4172
4802
|
export interface ListLedgerAccountsParams {
|
|
4173
4803
|
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
@@ -4692,10 +5322,12 @@ export interface ListEventsParams {
|
|
|
4692
5322
|
limit?: number;
|
|
4693
5323
|
/** El id del último de la página anterior, para la siguiente. */
|
|
4694
5324
|
starting_after?: string;
|
|
4695
|
-
/** Solo de este tipo. */
|
|
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";
|
|
5325
|
+
/** Solo de este tipo (invoice.stamped), o todos los de un recurso con un comodín (invoice.*). */
|
|
5326
|
+
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" | "invoice.*" | "invoice_batch.*" | "recurring_invoice.*" | "quote.*" | "ticket.*" | "retention.*" | "customer_data_request.*" | "sat_download.*" | "sat_declaration.*" | "issuer.*" | "balance.*" | "test_clock.*";
|
|
4697
5327
|
/** Solo los de este objeto (inv_…, ret_…, bat_…). */
|
|
4698
5328
|
object?: string;
|
|
5329
|
+
/** false: los que algún webhook no recibió (su último intento falló). true: los que recibieron todos los webhooks a los que se mandaron. */
|
|
5330
|
+
delivery_success?: boolean;
|
|
4699
5331
|
}
|
|
4700
5332
|
/** Cuenta: fiscalisto.account. */
|
|
4701
5333
|
export declare class AccountResource {
|
|
@@ -4915,6 +5547,69 @@ export declare class IssuersResource {
|
|
|
4915
5547
|
* @see https://fiscalisto.com/docs/api/referencia/emisores/create-issuer-onboarding-link
|
|
4916
5548
|
*/
|
|
4917
5549
|
createOnboardingLink(id: string, params?: CreateIssuerOnboardingLinkParams, options?: RequestOptions): Promise<IssuerOnboardingLink>;
|
|
5550
|
+
/**
|
|
5551
|
+
* Ver la opinión de cumplimiento (32-D)
|
|
5552
|
+
*
|
|
5553
|
+
* La última opinión que trajo del SAT: positiva, negativa (con sus motivos), sin obligaciones o en suspensión. result es null hasta la primera consulta. No usa timbres.
|
|
5554
|
+
*
|
|
5555
|
+
* GET /v1/issuers/{id}/compliance_opinion
|
|
5556
|
+
* @see https://fiscalisto.com/docs/api/referencia/cumplimiento-sat/get-compliance-opinion
|
|
5557
|
+
*/
|
|
5558
|
+
complianceOpinion(id: string, options?: RequestOptions): Promise<ComplianceOpinion>;
|
|
5559
|
+
/**
|
|
5560
|
+
* Pedir la opinión de cumplimiento al SAT
|
|
5561
|
+
*
|
|
5562
|
+
* La pide al SAT ahora con la e.firma guardada del emisor (POST /v1/issuers/{id}/efirma con keep_for_downloads: true). 1 timbre en producción, una vez cada 10 minutos; regresa si el SAT no contesta. Si el SAT tarda, contesta status processing y el resultado llega a GET /v1/issuers/{id}/compliance_opinion. En pruebas da una positiva de ejemplo.
|
|
5563
|
+
*
|
|
5564
|
+
* POST /v1/issuers/{id}/compliance_opinion/refresh
|
|
5565
|
+
* @see https://fiscalisto.com/docs/api/referencia/cumplimiento-sat/refresh-compliance-opinion
|
|
5566
|
+
*/
|
|
5567
|
+
refreshComplianceOpinion(id: string, options?: RequestOptions): Promise<SatRefresh>;
|
|
5568
|
+
/**
|
|
5569
|
+
* Descargar el PDF de la opinión de cumplimiento
|
|
5570
|
+
*
|
|
5571
|
+
* El PDF de la última opinión, como lo da el SAT. No usa timbres.
|
|
5572
|
+
*
|
|
5573
|
+
* GET /v1/issuers/{id}/compliance_opinion/pdf
|
|
5574
|
+
* @see https://fiscalisto.com/docs/api/referencia/cumplimiento-sat/get-compliance-opinion-pdf
|
|
5575
|
+
*/
|
|
5576
|
+
complianceOpinionPdf(id: string, options?: RequestOptions): Promise<Uint8Array>;
|
|
5577
|
+
/**
|
|
5578
|
+
* Ver la constancia de situación fiscal
|
|
5579
|
+
*
|
|
5580
|
+
* Lo que dice la última constancia generada: razón social, regímenes, código postal, estatus en el padrón e idCIF. No usa timbres.
|
|
5581
|
+
*
|
|
5582
|
+
* GET /v1/issuers/{id}/tax_status_certificate
|
|
5583
|
+
* @see https://fiscalisto.com/docs/api/referencia/cumplimiento-sat/get-tax-status-certificate
|
|
5584
|
+
*/
|
|
5585
|
+
taxStatusCertificate(id: string, options?: RequestOptions): Promise<TaxStatusCertificate>;
|
|
5586
|
+
/**
|
|
5587
|
+
* Generar la constancia de situación fiscal en el SAT
|
|
5588
|
+
*
|
|
5589
|
+
* Genera una constancia nueva con la e.firma guardada del emisor. 1 timbre en producción, una vez cada 10 minutos; regresa si el SAT no contesta. En pruebas hace una con los datos del emisor.
|
|
5590
|
+
*
|
|
5591
|
+
* POST /v1/issuers/{id}/tax_status_certificate/refresh
|
|
5592
|
+
* @see https://fiscalisto.com/docs/api/referencia/cumplimiento-sat/refresh-tax-status-certificate
|
|
5593
|
+
*/
|
|
5594
|
+
refreshTaxStatusCertificate(id: string, options?: RequestOptions): Promise<SatRefresh>;
|
|
5595
|
+
/**
|
|
5596
|
+
* Descargar el PDF de la constancia
|
|
5597
|
+
*
|
|
5598
|
+
* El PDF de la última constancia, como lo da el SAT. No usa timbres.
|
|
5599
|
+
*
|
|
5600
|
+
* GET /v1/issuers/{id}/tax_status_certificate/pdf
|
|
5601
|
+
* @see https://fiscalisto.com/docs/api/referencia/cumplimiento-sat/get-tax-status-certificate-pdf
|
|
5602
|
+
*/
|
|
5603
|
+
taxStatusCertificatePdf(id: string, options?: RequestOptions): Promise<Uint8Array>;
|
|
5604
|
+
/**
|
|
5605
|
+
* Revisar el buzón tributario en el SAT
|
|
5606
|
+
*
|
|
5607
|
+
* Lee los avisos del buzón tributario del emisor ahora, con su e.firma guardada; nunca abre notificaciones (abrirlas firma el acuse y corren los plazos). 1 timbre en producción, una vez cada 10 minutos. En pruebas deja dos avisos de ejemplo.
|
|
5608
|
+
*
|
|
5609
|
+
* POST /v1/issuers/{id}/sat_mailbox/refresh
|
|
5610
|
+
* @see https://fiscalisto.com/docs/api/referencia/cumplimiento-sat/refresh-sat-mailbox
|
|
5611
|
+
*/
|
|
5612
|
+
refreshSatMailbox(id: string, options?: RequestOptions): Promise<SatRefresh>;
|
|
4918
5613
|
/**
|
|
4919
5614
|
* Ver el portal de autofactura de un emisor
|
|
4920
5615
|
*
|
|
@@ -5349,6 +6044,56 @@ export declare class TaxIdsResource {
|
|
|
5349
6044
|
*/
|
|
5350
6045
|
validate(params: ValidateTaxIdParams, options?: RequestOptions): Promise<TaxIdValidation>;
|
|
5351
6046
|
}
|
|
6047
|
+
/** Sucursales: fiscalisto.branches. */
|
|
6048
|
+
export declare class BranchesResource {
|
|
6049
|
+
#private;
|
|
6050
|
+
constructor(client: Client);
|
|
6051
|
+
/**
|
|
6052
|
+
* Crear una sucursal
|
|
6053
|
+
*
|
|
6054
|
+
* Otro lugar desde donde factura el emisor, con su propio código postal: sus facturas llevan ese CP en LugarExpedicion (y su zona horaria en la Fecha, y el IVA 8 % si es de la franja fronteriza), su dirección en el PDF y, si las da, sus propias series. Un CP que ya tiene otra sucursal contesta branch_exists; el del domicilio fiscal del emisor no es sucursal (es la Matriz). Hasta 200 por emisor.
|
|
6055
|
+
*
|
|
6056
|
+
* POST /v1/branches
|
|
6057
|
+
* @see https://fiscalisto.com/docs/api/referencia/sucursales/create-branch
|
|
6058
|
+
*/
|
|
6059
|
+
create(params: CreateBranchParams, options?: RequestOptions): Promise<Branch>;
|
|
6060
|
+
/**
|
|
6061
|
+
* Listar sucursales
|
|
6062
|
+
*
|
|
6063
|
+
* Las sucursales del emisor, las más recientes primero. Las archivadas solo con include_archived=true.
|
|
6064
|
+
*
|
|
6065
|
+
* GET /v1/branches
|
|
6066
|
+
* @see https://fiscalisto.com/docs/api/referencia/sucursales/list-branches
|
|
6067
|
+
*/
|
|
6068
|
+
list(params?: ListBranchesParams, options?: RequestOptions): List<Branch>;
|
|
6069
|
+
/**
|
|
6070
|
+
* Ver una sucursal
|
|
6071
|
+
*
|
|
6072
|
+
* Una sucursal del emisor.
|
|
6073
|
+
*
|
|
6074
|
+
* GET /v1/branches/{id}
|
|
6075
|
+
* @see https://fiscalisto.com/docs/api/referencia/sucursales/get-branch
|
|
6076
|
+
*/
|
|
6077
|
+
get(id: string, options?: RequestOptions): Promise<Branch>;
|
|
6078
|
+
/**
|
|
6079
|
+
* Actualizar una sucursal
|
|
6080
|
+
*
|
|
6081
|
+
* Cambia solo los campos que manda; una serie en null vuelve a la del emisor. archived: true la archiva (ya no se factura desde ella y sus facturas la siguen nombrando), false la restaura. El código postal de una sucursal que ya facturó no cambia: si se mudó, archívela y cree otra.
|
|
6082
|
+
*
|
|
6083
|
+
* POST /v1/branches/{id}
|
|
6084
|
+
* @see https://fiscalisto.com/docs/api/referencia/sucursales/update-branch
|
|
6085
|
+
*/
|
|
6086
|
+
update(id: string, params?: UpdateBranchParams, options?: RequestOptions): Promise<Branch>;
|
|
6087
|
+
/**
|
|
6088
|
+
* Borrar una sucursal
|
|
6089
|
+
*
|
|
6090
|
+
* Solo una que nunca facturó; con facturas contesta branch_has_invoices: archívela con archived: true.
|
|
6091
|
+
*
|
|
6092
|
+
* DELETE /v1/branches/{id}
|
|
6093
|
+
* @see https://fiscalisto.com/docs/api/referencia/sucursales/delete-branch
|
|
6094
|
+
*/
|
|
6095
|
+
delete(id: string, options?: RequestOptions): Promise<Deleted>;
|
|
6096
|
+
}
|
|
5352
6097
|
/** Clientes: fiscalisto.customers. */
|
|
5353
6098
|
export declare class CustomersResource {
|
|
5354
6099
|
#private;
|
|
@@ -5489,6 +6234,139 @@ export declare class ProductsResource {
|
|
|
5489
6234
|
* @see https://fiscalisto.com/docs/api/referencia/productos/delete-product
|
|
5490
6235
|
*/
|
|
5491
6236
|
delete(id: string, options?: RequestOptions): Promise<Deleted>;
|
|
6237
|
+
/**
|
|
6238
|
+
* Ver las existencias de un producto
|
|
6239
|
+
*
|
|
6240
|
+
* Lo que hay del producto en cada almacén del emisor (también en 0), apartado por cotizaciones y disponible.
|
|
6241
|
+
*
|
|
6242
|
+
* GET /v1/products/{id}/stock
|
|
6243
|
+
* @see https://fiscalisto.com/docs/api/referencia/inventario/get-product-stock
|
|
6244
|
+
*/
|
|
6245
|
+
stock(id: string, options?: RequestOptions): Promise<StockLevelList>;
|
|
6246
|
+
}
|
|
6247
|
+
/** Cumplimiento SAT: fiscalisto.satMailboxMessages. */
|
|
6248
|
+
export declare class SatMailboxMessagesResource {
|
|
6249
|
+
#private;
|
|
6250
|
+
constructor(client: Client);
|
|
6251
|
+
/**
|
|
6252
|
+
* Listar avisos del buzón tributario
|
|
6253
|
+
*
|
|
6254
|
+
* Los avisos que trajo del buzón del emisor, los más recientes primero. No usa timbres.
|
|
6255
|
+
*
|
|
6256
|
+
* GET /v1/sat_mailbox_messages
|
|
6257
|
+
* @see https://fiscalisto.com/docs/api/referencia/cumplimiento-sat/list-sat-mailbox-messages
|
|
6258
|
+
*/
|
|
6259
|
+
list(params?: ListSatMailboxMessagesParams, options?: RequestOptions): List<SatMailboxMessage>;
|
|
6260
|
+
/**
|
|
6261
|
+
* Ver un aviso del buzón tributario
|
|
6262
|
+
*
|
|
6263
|
+
* Un aviso del buzón, con su urgencia y si pide hacer algo.
|
|
6264
|
+
*
|
|
6265
|
+
* GET /v1/sat_mailbox_messages/{id}
|
|
6266
|
+
* @see https://fiscalisto.com/docs/api/referencia/cumplimiento-sat/get-sat-mailbox-message
|
|
6267
|
+
*/
|
|
6268
|
+
get(id: string, options?: RequestOptions): Promise<SatMailboxMessage>;
|
|
6269
|
+
}
|
|
6270
|
+
/** Cumplimiento SAT: fiscalisto.satFindings. */
|
|
6271
|
+
export declare class SatFindingsResource {
|
|
6272
|
+
#private;
|
|
6273
|
+
constructor(client: Client);
|
|
6274
|
+
/**
|
|
6275
|
+
* Listar hallazgos en los CFDI
|
|
6276
|
+
*
|
|
6277
|
+
* Lo que Fiscalisto encontró en los CFDI del emisor (los suyos y los descargados del SAT) y nadie ha revisado, por tipo y del más grave al más leve: proveedores en la lista 69-B, CFDI cancelados, pagos en efectivo de más de $2,000, errores de CFDI 4.0. Todos en una página. No usa timbres.
|
|
6278
|
+
*
|
|
6279
|
+
* GET /v1/sat_findings
|
|
6280
|
+
* @see https://fiscalisto.com/docs/api/referencia/cumplimiento-sat/list-sat-findings
|
|
6281
|
+
*/
|
|
6282
|
+
list(params?: ListSatFindingsParams, options?: RequestOptions): Promise<SatFindingList>;
|
|
6283
|
+
}
|
|
6284
|
+
/** Inventario: fiscalisto.warehouses. */
|
|
6285
|
+
export declare class WarehousesResource {
|
|
6286
|
+
#private;
|
|
6287
|
+
constructor(client: Client);
|
|
6288
|
+
/**
|
|
6289
|
+
* Listar almacenes
|
|
6290
|
+
*
|
|
6291
|
+
* Los almacenes del emisor, los más recientes primero: el de la Matriz y uno por sucursal se crean solos. Todos en una página.
|
|
6292
|
+
*
|
|
6293
|
+
* GET /v1/warehouses
|
|
6294
|
+
* @see https://fiscalisto.com/docs/api/referencia/inventario/list-warehouses
|
|
6295
|
+
*/
|
|
6296
|
+
list(params?: ListWarehousesParams, options?: RequestOptions): Promise<WarehouseList>;
|
|
6297
|
+
/**
|
|
6298
|
+
* Ver un almacén
|
|
6299
|
+
*
|
|
6300
|
+
* Un almacén del emisor.
|
|
6301
|
+
*
|
|
6302
|
+
* GET /v1/warehouses/{id}
|
|
6303
|
+
* @see https://fiscalisto.com/docs/api/referencia/inventario/get-warehouse
|
|
6304
|
+
*/
|
|
6305
|
+
get(id: string, options?: RequestOptions): Promise<Warehouse>;
|
|
6306
|
+
/**
|
|
6307
|
+
* Ver las existencias de un almacén
|
|
6308
|
+
*
|
|
6309
|
+
* Lo que hay de cada producto en el almacén, el producto más reciente primero. Solo los que tienen existencias, salvo con include_empty=true (todos los que llevan track_stock).
|
|
6310
|
+
*
|
|
6311
|
+
* GET /v1/warehouses/{id}/stock
|
|
6312
|
+
* @see https://fiscalisto.com/docs/api/referencia/inventario/list-warehouse-stock
|
|
6313
|
+
*/
|
|
6314
|
+
stock(id: string, params?: ListWarehouseStockParams, options?: RequestOptions): List<StockLevel>;
|
|
6315
|
+
}
|
|
6316
|
+
/** Inventario: fiscalisto.stockMovements. */
|
|
6317
|
+
export declare class StockMovementsResource {
|
|
6318
|
+
#private;
|
|
6319
|
+
constructor(client: Client);
|
|
6320
|
+
/**
|
|
6321
|
+
* Listar movimientos (kárdex)
|
|
6322
|
+
*
|
|
6323
|
+
* Cada entrada y salida de existencias, la más reciente primero: ventas (de sus facturas), compras, ajustes, traspasos y lo que deshizo una cancelación.
|
|
6324
|
+
*
|
|
6325
|
+
* GET /v1/stock_movements
|
|
6326
|
+
* @see https://fiscalisto.com/docs/api/referencia/inventario/list-stock-movements
|
|
6327
|
+
*/
|
|
6328
|
+
list(params?: ListStockMovementsParams, options?: RequestOptions): List<StockMovement>;
|
|
6329
|
+
/**
|
|
6330
|
+
* Ver un movimiento
|
|
6331
|
+
*
|
|
6332
|
+
* Una entrada o salida de existencias, con lo que la causó (source).
|
|
6333
|
+
*
|
|
6334
|
+
* GET /v1/stock_movements/{id}
|
|
6335
|
+
* @see https://fiscalisto.com/docs/api/referencia/inventario/get-stock-movement
|
|
6336
|
+
*/
|
|
6337
|
+
get(id: string, options?: RequestOptions): Promise<StockMovement>;
|
|
6338
|
+
}
|
|
6339
|
+
/** Inventario: fiscalisto.stockAdjustments. */
|
|
6340
|
+
export declare class StockAdjustmentsResource {
|
|
6341
|
+
#private;
|
|
6342
|
+
constructor(client: Client);
|
|
6343
|
+
/**
|
|
6344
|
+
* Ajustar existencias
|
|
6345
|
+
*
|
|
6346
|
+
* Mete o saca existencias de un almacén con su motivo: el inventario inicial, una merma, un robo, un sobrante. Las entradas valen su unit_cost (o el costo promedio), las salidas el costo del emisor (promedio o PEPS). Los productos deben llevar track_stock: true. Se aplica al momento (status applied).
|
|
6347
|
+
*
|
|
6348
|
+
* POST /v1/stock_adjustments
|
|
6349
|
+
* @see https://fiscalisto.com/docs/api/referencia/inventario/create-stock-adjustment
|
|
6350
|
+
*/
|
|
6351
|
+
create(params: CreateStockAdjustmentParams, options?: RequestOptions): Promise<StockAdjustment>;
|
|
6352
|
+
/**
|
|
6353
|
+
* Listar ajustes
|
|
6354
|
+
*
|
|
6355
|
+
* Los ajustes del emisor, los más recientes primero.
|
|
6356
|
+
*
|
|
6357
|
+
* GET /v1/stock_adjustments
|
|
6358
|
+
* @see https://fiscalisto.com/docs/api/referencia/inventario/list-stock-adjustments
|
|
6359
|
+
*/
|
|
6360
|
+
list(params?: ListStockAdjustmentsParams, options?: RequestOptions): List<StockAdjustment>;
|
|
6361
|
+
/**
|
|
6362
|
+
* Ver un ajuste
|
|
6363
|
+
*
|
|
6364
|
+
* Un ajuste de existencias, con sus líneas.
|
|
6365
|
+
*
|
|
6366
|
+
* GET /v1/stock_adjustments/{id}
|
|
6367
|
+
* @see https://fiscalisto.com/docs/api/referencia/inventario/get-stock-adjustment
|
|
6368
|
+
*/
|
|
6369
|
+
get(id: string, options?: RequestOptions): Promise<StockAdjustment>;
|
|
5492
6370
|
}
|
|
5493
6371
|
/** Catálogos del SAT: fiscalisto.satCatalogs. */
|
|
5494
6372
|
export declare class SatCatalogsResource {
|
|
@@ -5740,6 +6618,15 @@ export declare class AccountingResource {
|
|
|
5740
6618
|
* @see https://fiscalisto.com/docs/api/referencia/contabilidad/get-cross-checks
|
|
5741
6619
|
*/
|
|
5742
6620
|
crossChecks(params?: GetCrossChecksParams, options?: RequestOptions): Promise<CrossChecks>;
|
|
6621
|
+
/**
|
|
6622
|
+
* Ver los CFDI de una cifra del cruce
|
|
6623
|
+
*
|
|
6624
|
+
* Los CFDI que forman lo facturado (invoiced) de una cifra del cruce de un mes, con los mismos cálculos de Impuestos: cada factura PUE o nota de crédito en su mes y cada factura PPD por lo que se pagó en el mes, con lo que aporta. La suma de cfdi más adjustment es invoiced. Sirve para ver por qué una cifra differs. Gratis: no consulta al SAT.
|
|
6625
|
+
*
|
|
6626
|
+
* GET /v1/accounting/cross_checks/cfdi
|
|
6627
|
+
* @see https://fiscalisto.com/docs/api/referencia/contabilidad/get-cross-check-cfdi
|
|
6628
|
+
*/
|
|
6629
|
+
crossCheckCfdi(params: GetCrossCheckCfdiParams, options?: RequestOptions): Promise<CrossCheckCfdi>;
|
|
5743
6630
|
/**
|
|
5744
6631
|
* Ver el catálogo de cuentas
|
|
5745
6632
|
*
|
|
@@ -6100,9 +6987,15 @@ export declare class FiscalistoApi extends Core {
|
|
|
6100
6987
|
readonly payrollReceipts: PayrollReceiptsResource;
|
|
6101
6988
|
readonly invoiceBatches: InvoiceBatchesResource;
|
|
6102
6989
|
readonly taxIds: TaxIdsResource;
|
|
6990
|
+
readonly branches: BranchesResource;
|
|
6103
6991
|
readonly customers: CustomersResource;
|
|
6104
6992
|
readonly customerDataRequests: CustomerDataRequestsResource;
|
|
6105
6993
|
readonly products: ProductsResource;
|
|
6994
|
+
readonly satMailboxMessages: SatMailboxMessagesResource;
|
|
6995
|
+
readonly satFindings: SatFindingsResource;
|
|
6996
|
+
readonly warehouses: WarehousesResource;
|
|
6997
|
+
readonly stockMovements: StockMovementsResource;
|
|
6998
|
+
readonly stockAdjustments: StockAdjustmentsResource;
|
|
6106
6999
|
readonly satCatalogs: SatCatalogsResource;
|
|
6107
7000
|
readonly satLists: SatListsResource;
|
|
6108
7001
|
readonly satDownloads: SatDownloadsResource;
|