fiscalisto 0.1.60 → 0.1.62

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/core.d.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * llamar.
5
5
  */
6
6
  import type { ErrorCode } from "./error-codes.js";
7
- export declare const VERSION = "0.1.60";
7
+ export declare const VERSION = "0.1.62";
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.60";
6
+ export const VERSION = "0.1.62";
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.
@@ -7,6 +7,8 @@ export declare const ErrorCode: {
7
7
  readonly AccountSuspended: "account_suspended";
8
8
  /** No existe esa versión de la API (en Fiscalisto-Version o api_version). El mensaje dice cuáles hay; vea Versiones. */
9
9
  readonly ApiVersionInvalid: "api_version_invalid";
10
+ /** Asistencia no lo permite: el mensaje dice por qué (una hora en el futuro o de hace más de 400 días, un empleado con fecha de baja, un periodo de más de 92 días, una marca ya quitada). */
11
+ readonly AttendanceInvalid: "attendance_invalid";
10
12
  /** El depósito no se puede conciliar, clasificar o reabrir así (ya está conciliado, las facturas son de otro cliente o una está cancelada…). El mensaje dice por qué. */
11
13
  readonly BankTransactionInvalid: "bank_transaction_invalid";
12
14
  /** Una factura del lote no pasa la revisión; param dice cuál (invoices.3.items.0.unit_price). Ninguna del lote se timbró. */
@@ -8,6 +8,8 @@ export const ErrorCode = {
8
8
  AccountSuspended: "account_suspended",
9
9
  /** No existe esa versión de la API (en Fiscalisto-Version o api_version). El mensaje dice cuáles hay; vea Versiones. */
10
10
  ApiVersionInvalid: "api_version_invalid",
11
+ /** Asistencia no lo permite: el mensaje dice por qué (una hora en el futuro o de hace más de 400 días, un empleado con fecha de baja, un periodo de más de 92 días, una marca ya quitada). */
12
+ AttendanceInvalid: "attendance_invalid",
11
13
  /** El depósito no se puede conciliar, clasificar o reabrir así (ya está conciliado, las facturas son de otro cliente o una está cancelada…). El mensaje dice por qué. */
12
14
  BankTransactionInvalid: "bank_transaction_invalid",
13
15
  /** Una factura del lote no pasa la revisión; param dice cuál (invoices.3.items.0.unit_price). Ninguna del lote se timbró. */
@@ -29,6 +29,155 @@ export interface Account {
29
29
  sandbox: string | null;
30
30
  };
31
31
  }
32
+ /** Una marca de entrada o salida de Asistencia (registro electrónico de jornada, LFT art. 132). */
33
+ export interface AttendanceMark {
34
+ /** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
35
+ id: string;
36
+ /** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
37
+ livemode: boolean;
38
+ /** Qué tipo de objeto es («invoice», «customer»…). */
39
+ object: "attendance_mark";
40
+ /** El empleado (emp_…). */
41
+ employee: string;
42
+ /** in: entrada; out: salida. */
43
+ kind: "in" | "out";
44
+ /** Cuándo marcó (UTC). */
45
+ at: string;
46
+ /** El día al que cuenta, AAAA-MM-DD en la hora del lugar. */
47
+ date: string;
48
+ /** La hora en el lugar, HH:MM. */
49
+ time: string;
50
+ /** Cómo marcó: kiosk_qr (el código del checador), kiosk_pin (número y NIP en el checador), printed_qr (el QR impreso), remote (fuera de la sucursal, con su ubicación), manual (corrección en la app), api. */
51
+ method: "kiosk_qr" | "kiosk_pin" | "printed_qr" | "remote" | "manual" | "api";
52
+ /** El lugar donde marcó, o null. */
53
+ place: string | null;
54
+ /** A cuántos metros del lugar estaba, si dio su ubicación; si no, null. */
55
+ distance_m: number | null;
56
+ /** Notas para revisar (la marca nunca se rechaza por ellas): no_location (no dio su ubicación), far (lejos del lugar), imprecise (ubicación imprecisa), remote (fuera de la sucursal), new_device (un celular nuevo). */
57
+ flags: ("no_location" | "far" | "imprecise" | "remote" | "new_device")[];
58
+ /** Por qué se agregó, en una corrección o desde la API (el empleado lo ve); null si la hizo él. */
59
+ reason: string | null;
60
+ /** Quién la agregó, en una corrección; null si la hizo él. */
61
+ created_by: string | null;
62
+ /** true si se quitó: queda tachada, no cuenta, y se ve con su motivo. */
63
+ voided: boolean;
64
+ /** Por qué se quitó, o null. */
65
+ void_reason: string | null;
66
+ /** Quién la quitó, o null. */
67
+ voided_by: string | null;
68
+ /** Cuándo se quitó, o null. */
69
+ voided_at: string | null;
70
+ }
71
+ /** La asistencia de un periodo, por empleado: horas contra su horario, faltas, retardos y horas extra dobles y triples por semana, como Nómina › Asistencia › Registro. */
72
+ export interface AttendanceReport {
73
+ /** Qué tipo de objeto es («invoice», «customer»…). */
74
+ object: "attendance_report";
75
+ /** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
76
+ livemode: boolean;
77
+ /** El emisor (iss_…), el patrón. */
78
+ issuer: string;
79
+ /** Primer día del periodo, AAAA-MM-DD. */
80
+ from: string;
81
+ /** Último día del periodo, AAAA-MM-DD. */
82
+ to: string;
83
+ /** true: las horas extra cuentan solo hasta lo que la empresa autorizó cada día. */
84
+ overtime_approval: boolean;
85
+ /** Cada empleado del emisor en el periodo. */
86
+ employees: {
87
+ /** El empleado (emp_…). */
88
+ employee: string;
89
+ /** Su nombre. */
90
+ name: string;
91
+ /** Su número de empleado, o null. */
92
+ number: string | null;
93
+ /** Donde marca, o null (cualquier lugar). */
94
+ place: string | null;
95
+ /** Minutos trabajados en el periodo. */
96
+ worked_minutes: number;
97
+ /** Minutos de su horario en el periodo. */
98
+ scheduled_minutes: number;
99
+ /** Faltas: días de trabajo sin marcas ni nota. */
100
+ absences: number;
101
+ /** Días con nota de incapacidad. */
102
+ disability_days: number;
103
+ /** Días con nota de vacaciones. */
104
+ vacation_days: number;
105
+ /** Cuántos días llegó tarde. */
106
+ late_count: number;
107
+ /** Minutos de retardo en total. */
108
+ late_minutes: number;
109
+ /** Días con una marca sin su pareja (sin salida). */
110
+ incomplete_days: number;
111
+ /** Marcas con una nota para revisar (flags). */
112
+ flagged_marks: number;
113
+ /** Horas extra que se pagan dobles (hasta 9 por semana en 2026, 12 desde 2027). */
114
+ overtime_double_minutes: number;
115
+ /** Horas extra que se pagan triples (las que pasan del límite de la semana). */
116
+ overtime_triple_minutes: number;
117
+ /** Todos los minutos de más en el registro, autorizados o no. */
118
+ overtime_minutes: number;
119
+ /** Minutos de más que nadie autorizó: quedan en el registro y no cuentan para la nómina. */
120
+ unapproved_overtime_minutes: number;
121
+ /** Días de descanso en que trabajó. */
122
+ rest_days_worked: number;
123
+ /** Días festivos en que trabajó. */
124
+ holidays_worked: number;
125
+ /** Semanas que el empleado confirmó en su enlace. */
126
+ weeks_confirmed: number;
127
+ /** Las semanas con las que el empleado no está de acuerdo. */
128
+ weeks_disputed: {
129
+ /** El lunes de la semana, AAAA-MM-DD. */
130
+ week: string;
131
+ /** Lo que el empleado dijo que no coincide. */
132
+ text: string;
133
+ }[];
134
+ /** Cada día del periodo, solo cuando se pide un employee; si no, null. */
135
+ days: {
136
+ /** AAAA-MM-DD. */
137
+ date: string;
138
+ /** worked (trabajó), incomplete (falta una marca), absent (falta), rest (descanso), holiday (día festivo), excused (justificado con una nota), upcoming (por venir), before (antes de empezar su registro). */
139
+ status: "worked" | "incomplete" | "absent" | "rest" | "holiday" | "excused" | "upcoming" | "before";
140
+ /** Su horario ese día, o null si descansa. */
141
+ scheduled: {
142
+ /** Hora de entrada, HH:MM. */
143
+ start: string;
144
+ /** Hora de salida, HH:MM (antes de la entrada: al día siguiente). */
145
+ end: string;
146
+ /** Minutos de comida que no se pagan. */
147
+ break_minutes: number;
148
+ } | null;
149
+ /** Minutos trabajados ese día. */
150
+ worked_minutes: number;
151
+ /** Minutos de retardo, pasada la tolerancia. */
152
+ late_minutes: number;
153
+ /** Minutos de más ese día (horas extra). */
154
+ overtime_minutes: number;
155
+ /** De esos, los que cuentan para la nómina: hasta lo autorizado ese día cuando las horas extra necesitan autorización; si no, todos. */
156
+ approved_overtime_minutes: number;
157
+ /** La nota del día que puso la empresa, o null. */
158
+ note: "vacaciones" | "incapacidad" | "permiso_con_goce" | "permiso_sin_goce" | "descanso" | "festivo" | "falta" | null;
159
+ /** El nombre del día festivo, o null. */
160
+ holiday: string | null;
161
+ }[] | null;
162
+ /** Sus marcas, también las quitadas, solo cuando se pide un employee; si no, null. */
163
+ marks: AttendanceMark[] | null;
164
+ }[];
165
+ }
166
+ /** Las horas extra que la empresa autorizó para un día de un empleado, antes o después de ese día. */
167
+ export interface AttendanceOvertime {
168
+ /** Qué tipo de objeto es («invoice», «customer»…). */
169
+ object: "attendance_overtime";
170
+ /** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
171
+ livemode: boolean;
172
+ /** El empleado (emp_…). */
173
+ employee: string;
174
+ /** El día, AAAA-MM-DD. */
175
+ date: string;
176
+ /** Hasta cuántos minutos de horas extra de ese día cuentan para la nómina; null: sin autorización. */
177
+ minutes: number | null;
178
+ /** Por qué, o null. */
179
+ comment: string | null;
180
+ }
32
181
  /** Timbres de producción de la cuenta, por paquete, el que vence antes primero. */
33
182
  export interface Balance {
34
183
  /** Qué tipo de objeto es («invoice», «customer»…). */
@@ -7784,6 +7933,41 @@ export interface QuotePricesParams {
7784
7933
  unit?: string | null;
7785
7934
  }[];
7786
7935
  }
7936
+ /** Los parámetros de GET /v1/attendance. */
7937
+ export interface GetAttendanceParams {
7938
+ /** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
7939
+ issuer?: string;
7940
+ /** Primer día, AAAA-MM-DD. */
7941
+ from: string;
7942
+ /** Último día, AAAA-MM-DD (hasta 92 días después de from). */
7943
+ to: string;
7944
+ /** Solo este empleado (emp_…), con sus días y marcas. */
7945
+ employee?: string;
7946
+ }
7947
+ export interface CreateAttendanceMarkParams {
7948
+ /** El empleado (emp_…). */
7949
+ employee: string;
7950
+ /** in: entrada; out: salida. */
7951
+ kind: "in" | "out";
7952
+ /** Cuándo marcó, con su zona horaria (2027-01-04T09:02:00-06:00). No en el futuro ni de hace más de 400 días. */
7953
+ at: string;
7954
+ /** Por qué se registra (se guarda y el empleado lo ve en su enlace). Por omisión «Registrada por la API». */
7955
+ reason?: string;
7956
+ }
7957
+ export interface VoidAttendanceMarkParams {
7958
+ /** Por qué se quita: queda tachada con este motivo y el empleado lo ve. */
7959
+ reason: string;
7960
+ }
7961
+ export interface ApproveAttendanceOvertimeParams {
7962
+ /** El empleado (emp_…). */
7963
+ employee: string;
7964
+ /** AAAA-MM-DD. */
7965
+ date: string;
7966
+ /** Hasta cuántos minutos de horas extra de ese día cuentan para la nómina (0 a 960); null quita la autorización. */
7967
+ minutes: number | null;
7968
+ /** Por qué (opcional). */
7969
+ comment?: string;
7970
+ }
7787
7971
  export interface CreateExpensePersonParams {
7788
7972
  /** El emisor (iss_…). Por omisión, su único emisor. */
7789
7973
  issuer?: string;
@@ -11065,6 +11249,47 @@ export declare class PricesResource {
11065
11249
  */
11066
11250
  quote(params: QuotePricesParams, options?: RequestOptions): Promise<PriceQuote>;
11067
11251
  }
11252
+ /** Asistencia: fiscalisto.attendance. */
11253
+ export declare class AttendanceResource {
11254
+ #private;
11255
+ constructor(client: Client);
11256
+ /**
11257
+ * Ver la asistencia de un periodo
11258
+ *
11259
+ * El registro de jornada del emisor (LFT art. 132) del periodo, por empleado: minutos trabajados contra su horario, faltas, retardos, días sin salida, marcas con notas y horas extra dobles y triples por semana. Con employee, también cada día y cada marca (con sus correcciones). Hasta 92 días a la vez.
11260
+ *
11261
+ * GET /v1/attendance
11262
+ * @see https://fiscalisto.com/docs/api/referencia/asistencia/get-attendance
11263
+ */
11264
+ get(params: GetAttendanceParams, options?: RequestOptions): Promise<AttendanceReport>;
11265
+ /**
11266
+ * Registrar una marca
11267
+ *
11268
+ * Una entrada o salida que viene de otro reloj checador. Queda con method api y su motivo, y el empleado la ve en su enlace. Una marca igual del mismo empleado dentro de 60 segundos no se duplica.
11269
+ *
11270
+ * POST /v1/attendance/marks
11271
+ * @see https://fiscalisto.com/docs/api/referencia/asistencia/create-attendance-mark
11272
+ */
11273
+ createMark(params: CreateAttendanceMarkParams, options?: RequestOptions): Promise<AttendanceMark>;
11274
+ /**
11275
+ * Quitar una marca
11276
+ *
11277
+ * La marca deja de contar y queda tachada con su motivo, quién y cuándo (nunca se borra). En la app se puede restaurar.
11278
+ *
11279
+ * POST /v1/attendance/marks/{id}/void
11280
+ * @see https://fiscalisto.com/docs/api/referencia/asistencia/void-attendance-mark
11281
+ */
11282
+ voidMark(id: string, params: VoidAttendanceMarkParams, options?: RequestOptions): Promise<AttendanceMark>;
11283
+ /**
11284
+ * Autorizar horas extra
11285
+ *
11286
+ * Hasta cuántos minutos de horas extra de un día de un empleado cuentan para la nómina, antes o después de ese día (minutes null quita la autorización). Con la regla «Las horas extra necesitan autorización» encendida, lo demás queda en el registro como sin autorizar.
11287
+ *
11288
+ * POST /v1/attendance/overtime
11289
+ * @see https://fiscalisto.com/docs/api/referencia/asistencia/approve-attendance-overtime
11290
+ */
11291
+ approveOvertime(params: ApproveAttendanceOvertimeParams, options?: RequestOptions): Promise<AttendanceOvertime>;
11292
+ }
11068
11293
  /** Viáticos y gastos: fiscalisto.expensePeople. */
11069
11294
  export declare class ExpensePeopleResource {
11070
11295
  #private;
@@ -12666,6 +12891,7 @@ export declare class FiscalistoApi extends Core {
12666
12891
  readonly priceLists: PriceListsResource;
12667
12892
  readonly customerGroups: CustomerGroupsResource;
12668
12893
  readonly prices: PricesResource;
12894
+ readonly attendance: AttendanceResource;
12669
12895
  readonly expensePeople: ExpensePeopleResource;
12670
12896
  readonly expenseReports: ExpenseReportsResource;
12671
12897
  readonly expensePolicy: ExpensePolicyResource;
package/dist/generated.js CHANGED
@@ -1655,6 +1655,57 @@ export class PricesResource {
1655
1655
  return this.#client.request({ method: "POST", path: "/v1/prices", body: params, idempotent: true }, options);
1656
1656
  }
1657
1657
  }
1658
+ /** Asistencia: fiscalisto.attendance. */
1659
+ export class AttendanceResource {
1660
+ #client;
1661
+ constructor(client) {
1662
+ this.#client = client;
1663
+ }
1664
+ /**
1665
+ * Ver la asistencia de un periodo
1666
+ *
1667
+ * El registro de jornada del emisor (LFT art. 132) del periodo, por empleado: minutos trabajados contra su horario, faltas, retardos, días sin salida, marcas con notas y horas extra dobles y triples por semana. Con employee, también cada día y cada marca (con sus correcciones). Hasta 92 días a la vez.
1668
+ *
1669
+ * GET /v1/attendance
1670
+ * @see https://fiscalisto.com/docs/api/referencia/asistencia/get-attendance
1671
+ */
1672
+ get(params, options) {
1673
+ return this.#client.request({ method: "GET", path: "/v1/attendance", query: params }, options);
1674
+ }
1675
+ /**
1676
+ * Registrar una marca
1677
+ *
1678
+ * Una entrada o salida que viene de otro reloj checador. Queda con method api y su motivo, y el empleado la ve en su enlace. Una marca igual del mismo empleado dentro de 60 segundos no se duplica.
1679
+ *
1680
+ * POST /v1/attendance/marks
1681
+ * @see https://fiscalisto.com/docs/api/referencia/asistencia/create-attendance-mark
1682
+ */
1683
+ createMark(params, options) {
1684
+ return this.#client.request({ method: "POST", path: "/v1/attendance/marks", body: params, idempotent: true }, options);
1685
+ }
1686
+ /**
1687
+ * Quitar una marca
1688
+ *
1689
+ * La marca deja de contar y queda tachada con su motivo, quién y cuándo (nunca se borra). En la app se puede restaurar.
1690
+ *
1691
+ * POST /v1/attendance/marks/{id}/void
1692
+ * @see https://fiscalisto.com/docs/api/referencia/asistencia/void-attendance-mark
1693
+ */
1694
+ voidMark(id, params, options) {
1695
+ return this.#client.request({ method: "POST", path: `/v1/attendance/marks/${encodeURIComponent(id)}/void`, body: params, idempotent: true }, options);
1696
+ }
1697
+ /**
1698
+ * Autorizar horas extra
1699
+ *
1700
+ * Hasta cuántos minutos de horas extra de un día de un empleado cuentan para la nómina, antes o después de ese día (minutes null quita la autorización). Con la regla «Las horas extra necesitan autorización» encendida, lo demás queda en el registro como sin autorizar.
1701
+ *
1702
+ * POST /v1/attendance/overtime
1703
+ * @see https://fiscalisto.com/docs/api/referencia/asistencia/approve-attendance-overtime
1704
+ */
1705
+ approveOvertime(params, options) {
1706
+ return this.#client.request({ method: "POST", path: "/v1/attendance/overtime", body: params, idempotent: true }, options);
1707
+ }
1708
+ }
1658
1709
  /** Viáticos y gastos: fiscalisto.expensePeople. */
1659
1710
  export class ExpensePeopleResource {
1660
1711
  #client;
@@ -3636,6 +3687,7 @@ export class FiscalistoApi extends Core {
3636
3687
  priceLists = new PriceListsResource(this);
3637
3688
  customerGroups = new CustomerGroupsResource(this);
3638
3689
  prices = new PricesResource(this);
3690
+ attendance = new AttendanceResource(this);
3639
3691
  expensePeople = new ExpensePeopleResource(this);
3640
3692
  expenseReports = new ExpenseReportsResource(this);
3641
3693
  expensePolicy = new ExpensePolicyResource(this);