fiscalisto 0.1.30 → 0.1.33
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/agent-guide.d.ts +1 -1
- package/dist/agent-guide.js +5 -0
- package/dist/core.d.ts +1 -1
- package/dist/core.js +1 -1
- package/dist/error-codes.d.ts +13 -1
- package/dist/error-codes.js +13 -1
- package/dist/generated.d.ts +1577 -42
- package/dist/generated.js +489 -28
- package/dist/mock-routes.gen.js +1 -1
- package/package.json +1 -1
package/dist/generated.d.ts
CHANGED
|
@@ -1829,6 +1829,239 @@ export interface CostCenter {
|
|
|
1829
1829
|
/** Cuándo cambió por última vez. */
|
|
1830
1830
|
updated_at: string | null;
|
|
1831
1831
|
}
|
|
1832
|
+
/** Alguien que viaja o gasta por el emisor: un empleado (de Nómina) o alguien por honorarios. Tiene un enlace propio para subir sus facturas sin cuenta. */
|
|
1833
|
+
export interface ExpensePerson {
|
|
1834
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1835
|
+
id: string;
|
|
1836
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1837
|
+
livemode: boolean;
|
|
1838
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1839
|
+
object: "expense_person";
|
|
1840
|
+
/** El emisor por el que gasta. */
|
|
1841
|
+
issuer: string;
|
|
1842
|
+
/** empleado (sueldos y salarios: viáticos exentos en su recibo de nómina) o honorarios. */
|
|
1843
|
+
kind: "empleado" | "honorarios";
|
|
1844
|
+
/** Su empleado de Nómina (emp_…), o null si es por honorarios. */
|
|
1845
|
+
employee: string | null;
|
|
1846
|
+
/** Su nombre. */
|
|
1847
|
+
name: string;
|
|
1848
|
+
/** Su RFC, o null. */
|
|
1849
|
+
tax_id: string | null;
|
|
1850
|
+
/** Su correo, a donde se le manda su enlace y los avisos, o null. */
|
|
1851
|
+
email: string | null;
|
|
1852
|
+
/** Dónde trabaja: un viaje a más de 50 km de ahí es de viáticos. */
|
|
1853
|
+
base_city: string | null;
|
|
1854
|
+
/** Su área, o null. */
|
|
1855
|
+
department: string | null;
|
|
1856
|
+
/** true si tiene un enlace que funciona para subir sus facturas. */
|
|
1857
|
+
link_active: boolean;
|
|
1858
|
+
/** true si está archivada. */
|
|
1859
|
+
archived: boolean;
|
|
1860
|
+
/** Cuándo se agregó. */
|
|
1861
|
+
created_at: string | null;
|
|
1862
|
+
}
|
|
1863
|
+
/** El enlace de una persona: ahí ve solo sus comprobaciones y sube sus facturas desde el teléfono, sin cuenta. */
|
|
1864
|
+
export interface ExpensePersonLink {
|
|
1865
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1866
|
+
object: "expense_person_link";
|
|
1867
|
+
/** La persona (exp_…). */
|
|
1868
|
+
person: string;
|
|
1869
|
+
/** Su enlace, o null si está apagado. */
|
|
1870
|
+
url: string | null;
|
|
1871
|
+
}
|
|
1872
|
+
/** Un gasto de una comprobación. */
|
|
1873
|
+
export interface ExpenseItem {
|
|
1874
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1875
|
+
id: string;
|
|
1876
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1877
|
+
object: "expense_item";
|
|
1878
|
+
/** Cuándo se gastó (AAAA-MM-DD). */
|
|
1879
|
+
date: string;
|
|
1880
|
+
/** De qué es: hospedaje, alimentos, avion, transporte, auto, combustible, comidas, papeleria, mensajeria, software u otros. */
|
|
1881
|
+
category: "hospedaje" | "alimentos" | "avion" | "transporte" | "auto" | "combustible" | "comidas" | "papeleria" | "mensajeria" | "software" | "otros";
|
|
1882
|
+
/** Qué fue (el proveedor), o null. */
|
|
1883
|
+
description: string | null;
|
|
1884
|
+
/** En pesos. */
|
|
1885
|
+
amount: number;
|
|
1886
|
+
/** En su moneda, o null. */
|
|
1887
|
+
foreign_amount: number | null;
|
|
1888
|
+
/** Su moneda (USD, EUR…), o null. */
|
|
1889
|
+
foreign_currency: string | null;
|
|
1890
|
+
/** Cuántas personas comieron (en alimentos el tope es por persona). */
|
|
1891
|
+
people: number;
|
|
1892
|
+
/** Cómo se pagó: tarjeta_empresa, tarjeta_propia, efectivo, transferencia u otro, o null. */
|
|
1893
|
+
payment: "tarjeta_empresa" | "tarjeta_propia" | "efectivo" | "transferencia" | "otro" | null;
|
|
1894
|
+
/** Su comprobante: cfdi, extranjero, ticket o ninguno. */
|
|
1895
|
+
receipt: "cfdi" | "extranjero" | "ticket" | "ninguno";
|
|
1896
|
+
/** El UUID de su factura, o null. */
|
|
1897
|
+
uuid: string | null;
|
|
1898
|
+
/** La nota de la persona, o null. */
|
|
1899
|
+
note: string | null;
|
|
1900
|
+
/** true si quien aprueba lo rechazó. */
|
|
1901
|
+
rejected: boolean;
|
|
1902
|
+
/** Por qué se rechazó, o null. */
|
|
1903
|
+
reject_reason: string | null;
|
|
1904
|
+
/** Lo que se deduce de este gasto. */
|
|
1905
|
+
deductible: number;
|
|
1906
|
+
/** Lo que no se deduce. */
|
|
1907
|
+
non_deductible: number;
|
|
1908
|
+
/** true si pasa un tope de la política. */
|
|
1909
|
+
over_policy: boolean;
|
|
1910
|
+
/** Sus avisos contra la ley y la política. */
|
|
1911
|
+
issues: {
|
|
1912
|
+
/** error (impide enviarla), warning, policy (pasa la política) o info. */
|
|
1913
|
+
level: "error" | "warning" | "policy" | "info";
|
|
1914
|
+
/** Qué es, como código estable. */
|
|
1915
|
+
code: string;
|
|
1916
|
+
/** Qué es, en palabras. */
|
|
1917
|
+
message: string;
|
|
1918
|
+
}[];
|
|
1919
|
+
/** Cuándo se agregó. */
|
|
1920
|
+
created_at: string | null;
|
|
1921
|
+
}
|
|
1922
|
+
/** Dinero que se le dio a la persona (anticipo, reembolso) o que devolvió. */
|
|
1923
|
+
export interface ExpenseMovement {
|
|
1924
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1925
|
+
id: string;
|
|
1926
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1927
|
+
object: "expense_movement";
|
|
1928
|
+
/** anticipo, reembolso o devolucion. */
|
|
1929
|
+
kind: "anticipo" | "reembolso" | "devolucion";
|
|
1930
|
+
/** En pesos. */
|
|
1931
|
+
amount: number;
|
|
1932
|
+
/** Cuándo se pagó (AAAA-MM-DD). */
|
|
1933
|
+
date: string;
|
|
1934
|
+
/** transferencia, efectivo, tarjeta o nomina (en su recibo de nómina). */
|
|
1935
|
+
method: "transferencia" | "efectivo" | "tarjeta" | "nomina";
|
|
1936
|
+
/** Su referencia, o null. */
|
|
1937
|
+
reference: string | null;
|
|
1938
|
+
/** true si ya se pagó en un recibo de nómina. */
|
|
1939
|
+
in_payroll: boolean;
|
|
1940
|
+
/** Cuándo se registró. */
|
|
1941
|
+
created_at: string | null;
|
|
1942
|
+
}
|
|
1943
|
+
/** Una comprobación de viáticos (un viaje) o de gastos de un periodo: sus gastos revisados contra la ley y la política, y el dinero dado o devuelto. Al aprobarla sus facturas se deducen y entra en las pólizas por 107.01. */
|
|
1944
|
+
export interface ExpenseReport {
|
|
1945
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1946
|
+
id: string;
|
|
1947
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1948
|
+
livemode: boolean;
|
|
1949
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1950
|
+
object: "expense_report";
|
|
1951
|
+
/** El emisor. */
|
|
1952
|
+
issuer: string;
|
|
1953
|
+
/** Su número, consecutivo por emisor. */
|
|
1954
|
+
number: number;
|
|
1955
|
+
/** Cómo se muestra, por ejemplo «VIA-0012». */
|
|
1956
|
+
label: string;
|
|
1957
|
+
/** Quién la comprueba (exp_…). */
|
|
1958
|
+
person: string;
|
|
1959
|
+
/** El nombre de esa persona. */
|
|
1960
|
+
person_name: string;
|
|
1961
|
+
/** viaje o gastos (de oficina, de un periodo). */
|
|
1962
|
+
kind: "viaje" | "gastos";
|
|
1963
|
+
/** Su nombre. */
|
|
1964
|
+
title: string;
|
|
1965
|
+
/** Para qué fue, o null. */
|
|
1966
|
+
purpose: string | null;
|
|
1967
|
+
/** A dónde, o null. */
|
|
1968
|
+
destination: string | null;
|
|
1969
|
+
/** true si fue al extranjero. */
|
|
1970
|
+
abroad: boolean;
|
|
1971
|
+
/** true si fue a más de 50 km de donde trabaja la persona. */
|
|
1972
|
+
far: boolean;
|
|
1973
|
+
/** La salida o el inicio del periodo (AAAA-MM-DD), o null. */
|
|
1974
|
+
start_date: string | null;
|
|
1975
|
+
/** El regreso o el fin del periodo (AAAA-MM-DD), o null. */
|
|
1976
|
+
end_date: string | null;
|
|
1977
|
+
/** draft (abierta), submitted (por aprobar), rejected (devuelta para corregir), approved (por liquidar) o closed (cerrada, con el saldo en cero). */
|
|
1978
|
+
status: "draft" | "submitted" | "rejected" | "approved" | "closed";
|
|
1979
|
+
/** Hasta cuándo hay para comprobarla (la política), o null. */
|
|
1980
|
+
due_date: string | null;
|
|
1981
|
+
/** Cuándo se envió a aprobar, o null. */
|
|
1982
|
+
submitted_at: string | null;
|
|
1983
|
+
/** Cuándo se aprobó o se devolvió, o null. */
|
|
1984
|
+
decided_at: string | null;
|
|
1985
|
+
/** La nota de quien la aprobó o la devolvió, o null. */
|
|
1986
|
+
decision_note: string | null;
|
|
1987
|
+
/** Cuándo se cerró, o null. */
|
|
1988
|
+
closed_at: string | null;
|
|
1989
|
+
/** true si ya se reportó en un recibo de nómina (viáticos 050 y 081). */
|
|
1990
|
+
in_payroll: boolean;
|
|
1991
|
+
/** Lo gastado, sin los gastos rechazados. */
|
|
1992
|
+
spent: number;
|
|
1993
|
+
/** Lo de los gastos rechazados. */
|
|
1994
|
+
rejected: number;
|
|
1995
|
+
/** Lo comprobado con factura o comprobante del extranjero. */
|
|
1996
|
+
proven: number;
|
|
1997
|
+
/** Lo que se deduce, con los topes de la ley. */
|
|
1998
|
+
deductible: number;
|
|
1999
|
+
/** Lo que no se deduce (pasa los topes o no tiene comprobante). */
|
|
2000
|
+
non_deductible: number;
|
|
2001
|
+
/** Lo que se le dio en anticipos. */
|
|
2002
|
+
advances: number;
|
|
2003
|
+
/** Lo que se le reembolsó. */
|
|
2004
|
+
reimbursed: number;
|
|
2005
|
+
/** Lo que devolvió. */
|
|
2006
|
+
returned: number;
|
|
2007
|
+
/** Positivo, lo que la persona debe devolver; negativo, lo que la empresa le debe reembolsar; 0, liquidada. Lo pagado con la tarjeta de la empresa no cuenta. */
|
|
2008
|
+
balance: number;
|
|
2009
|
+
/** true si se puede enviar o aprobar: ningún gasto tiene errores. */
|
|
2010
|
+
ready: boolean;
|
|
2011
|
+
/** Avisos de la comprobación entera. */
|
|
2012
|
+
issues: {
|
|
2013
|
+
/** error (impide enviarla), warning, policy (pasa la política) o info. */
|
|
2014
|
+
level: "error" | "warning" | "policy" | "info";
|
|
2015
|
+
/** Qué es, como código estable. */
|
|
2016
|
+
code: string;
|
|
2017
|
+
/** Qué es, en palabras. */
|
|
2018
|
+
message: string;
|
|
2019
|
+
}[];
|
|
2020
|
+
/** Para un empleado, cómo irá en su recibo de nómina (o null). */
|
|
2021
|
+
payroll: {
|
|
2022
|
+
/** Viáticos exentos comprobados (OtroPago/Percepción 050, ImporteExento). */
|
|
2023
|
+
exempt: number;
|
|
2024
|
+
/** Lo que grava como sueldo (050, ImporteGravado): lo gastado sin comprobar. */
|
|
2025
|
+
taxed: number;
|
|
2026
|
+
/** Lo que se descuenta (deducción 081) por lo que ya se le dio y sobró. */
|
|
2027
|
+
adjustment: number;
|
|
2028
|
+
/** Lo que neto cobra o paga en el recibo por esta comprobación. */
|
|
2029
|
+
net: number;
|
|
2030
|
+
} | null;
|
|
2031
|
+
/** Sus gastos. */
|
|
2032
|
+
items: ExpenseItem[];
|
|
2033
|
+
/** El dinero que se le dio o devolvió. */
|
|
2034
|
+
movements: ExpenseMovement[];
|
|
2035
|
+
/** Cuándo se abrió. */
|
|
2036
|
+
created_at: string | null;
|
|
2037
|
+
/** Cuándo cambió por última vez. */
|
|
2038
|
+
updated_at: string | null;
|
|
2039
|
+
}
|
|
2040
|
+
/** La política de viáticos y gastos del emisor: topes por categoría, hasta cuánto sin factura y en cuántos días se comprueba. */
|
|
2041
|
+
export interface ExpensePolicy {
|
|
2042
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2043
|
+
object: "expense_policy";
|
|
2044
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
2045
|
+
livemode: boolean;
|
|
2046
|
+
/** El emisor. */
|
|
2047
|
+
issuer: string;
|
|
2048
|
+
/** Topes por categoría (hospedaje, alimentos…): las que no están no tienen tope. */
|
|
2049
|
+
limits: Record<string, {
|
|
2050
|
+
domestic: number | null;
|
|
2051
|
+
abroad: number | null;
|
|
2052
|
+
per: "dia" | "gasto";
|
|
2053
|
+
}>;
|
|
2054
|
+
/** Hasta cuánto se acepta un gasto sin factura; 0: todos la piden. */
|
|
2055
|
+
ticket_limit: number;
|
|
2056
|
+
/** Días después del regreso para comprobar. */
|
|
2057
|
+
due_days: number;
|
|
2058
|
+
/** true si pide una nota en cada gasto que pase un tope. */
|
|
2059
|
+
note_over_limit: boolean;
|
|
2060
|
+
/** true si avisa por correo a quien aprueba. */
|
|
2061
|
+
notify_approvers: boolean;
|
|
2062
|
+
/** true si avisa a la persona cuando se aprueba, se devuelve o se le paga. */
|
|
2063
|
+
notify_people: boolean;
|
|
2064
|
+
}
|
|
1832
2065
|
/** Un almacén del emisor: el de la Matriz y uno por sucursal se crean solos; cada factura saca existencias del de su sucursal. */
|
|
1833
2066
|
export interface Warehouse {
|
|
1834
2067
|
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
@@ -2290,8 +2523,8 @@ export interface JournalEntry {
|
|
|
2290
2523
|
object: "journal_entry";
|
|
2291
2524
|
/** El emisor. */
|
|
2292
2525
|
issuer: string;
|
|
2293
|
-
/** De qué es: invoice (un CFDI de ingreso o egreso), payment_received o payment_made (un pago de un complemento), payroll (un recibo de nómina) o depreciation (la depreciación del mes de los activos fijos). */
|
|
2294
|
-
type: "invoice" | "payment_received" | "payment_made" | "payroll" | "depreciation";
|
|
2526
|
+
/** De qué es: invoice (un CFDI de ingreso o egreso), payment_received o payment_made (un pago de un complemento), payroll (un recibo de nómina), employee_expenses (un anticipo, reembolso, devolución o comprobación de viáticos, contra 107.01 «Funcionarios y empleados») o depreciation (la depreciación del mes de los activos fijos). */
|
|
2527
|
+
type: "invoice" | "payment_received" | "payment_made" | "payroll" | "employee_expenses" | "depreciation";
|
|
2295
2528
|
/** La fecha del CFDI o del pago; en la depreciación, el último día del mes. */
|
|
2296
2529
|
date: string;
|
|
2297
2530
|
/** El documento, su folio y la contraparte. */
|
|
@@ -2709,6 +2942,91 @@ export interface Diot {
|
|
|
2709
2942
|
/** Lo que conviene revisar antes de presentarla. */
|
|
2710
2943
|
warnings: string[];
|
|
2711
2944
|
}
|
|
2945
|
+
/** El IVA a favor del emisor mes por mes, qué pasó con cada saldo y, con un mes, la revisión antes de pedir su devolución. */
|
|
2946
|
+
export interface VatRefund {
|
|
2947
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
2948
|
+
object: "vat_refund";
|
|
2949
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
2950
|
+
livemode: boolean;
|
|
2951
|
+
/** El emisor. */
|
|
2952
|
+
issuer: string;
|
|
2953
|
+
/** El IVA a favor que todavía puede pedir de vuelta: lo que queda de cada saldo sin acreditar, sin solicitud y sin prescribir. */
|
|
2954
|
+
available: number;
|
|
2955
|
+
/** Lo pedido en solicitudes que siguen en trámite o ya se resolvieron sin depósito. */
|
|
2956
|
+
in_refund: number;
|
|
2957
|
+
/** Lo que el SAT ya depositó. */
|
|
2958
|
+
refunded: number;
|
|
2959
|
+
/** true si algún mes sale de sus CFDI porque su declaración no se ha leído (POST /v1/sat_declarations/refresh). */
|
|
2960
|
+
estimated: boolean;
|
|
2961
|
+
/** Cada mes con IVA a favor en los últimos cinco años, del más reciente al más antiguo. */
|
|
2962
|
+
balances: {
|
|
2963
|
+
/** El mes del saldo (AAAA-MM). */
|
|
2964
|
+
month: string;
|
|
2965
|
+
/** declaration si sale de la declaración leída; cfdi si se calculó con sus CFDI. */
|
|
2966
|
+
source: "declaration" | "cfdi";
|
|
2967
|
+
/** El saldo a favor del mes. */
|
|
2968
|
+
amount: number;
|
|
2969
|
+
/** El número de operación de la declaración, o null. */
|
|
2970
|
+
operation_number: string | null;
|
|
2971
|
+
/** Lo que de este saldo se acreditó en meses posteriores, del saldo más antiguo primero. */
|
|
2972
|
+
credited: number;
|
|
2973
|
+
/** En qué mes se acreditó cada parte y cuánto. */
|
|
2974
|
+
credited_in: {
|
|
2975
|
+
/** El mes en que se acreditó esa parte (AAAA-MM). */
|
|
2976
|
+
month: string;
|
|
2977
|
+
/** Lo acreditado ese mes. */
|
|
2978
|
+
amount: number;
|
|
2979
|
+
}[];
|
|
2980
|
+
/** Lo que queda de este saldo para pedir de vuelta. */
|
|
2981
|
+
available: number;
|
|
2982
|
+
/** available (se puede pedir), credited (ya se acreditó), in_refund (con solicitud), refunded (depositado), denied (negado) o prescribed (pasaron cinco años). */
|
|
2983
|
+
status: "available" | "credited" | "in_refund" | "refunded" | "denied" | "prescribed";
|
|
2984
|
+
/** Cuándo prescribe el derecho a pedirlo: cinco años desde su declaración (AAAA-MM-DD). */
|
|
2985
|
+
prescribes_on: string;
|
|
2986
|
+
}[];
|
|
2987
|
+
/** Con month, la revisión de ese mes antes de pedirlo; null sin month. */
|
|
2988
|
+
review: {
|
|
2989
|
+
/** El mes revisado (AAAA-MM). */
|
|
2990
|
+
month: string;
|
|
2991
|
+
/** Lo que conviene pedir, en pesos sin centavos como lo pide el SAT. */
|
|
2992
|
+
amount_to_request: number;
|
|
2993
|
+
/** true si ya acreditó parte del saldo y lo que pide es el remanente. */
|
|
2994
|
+
remainder: boolean;
|
|
2995
|
+
/** true si ninguna revisión bloquea la solicitud. */
|
|
2996
|
+
ready: boolean;
|
|
2997
|
+
/** Cada revisión, de la más grave a la que está bien. */
|
|
2998
|
+
checks: {
|
|
2999
|
+
/** Qué se revisó, estable para su código. */
|
|
3000
|
+
key: string;
|
|
3001
|
+
/** ok, warning (conviene revisar), blocking (el SAT la rechazaría) o pending (falta un dato). */
|
|
3002
|
+
result: "ok" | "warning" | "blocking" | "pending";
|
|
3003
|
+
/** La revisión, en una línea. */
|
|
3004
|
+
title: string;
|
|
3005
|
+
/** Qué encontró y qué hacer. */
|
|
3006
|
+
detail: string;
|
|
3007
|
+
/** Los pesos que toca, como el IVA en riesgo, o null. */
|
|
3008
|
+
amount: number | null;
|
|
3009
|
+
}[];
|
|
3010
|
+
/** Los proveedores del mes, para la relación que pide el SAT. */
|
|
3011
|
+
suppliers: {
|
|
3012
|
+
/** Cuántos proveedores tuvo en el mes. */
|
|
3013
|
+
count: number;
|
|
3014
|
+
/** Cuántos CFDI recibidos suman al IVA acreditable. */
|
|
3015
|
+
cfdi: number;
|
|
3016
|
+
/** Cuántos proveedores juntan el 80% del IVA acreditable. */
|
|
3017
|
+
main: number;
|
|
3018
|
+
/** El IVA de CFDI de proveedores que el SAT no reconocería: cancelados, de EFOS o con otros hallazgos. */
|
|
3019
|
+
vat_at_risk: number;
|
|
3020
|
+
};
|
|
3021
|
+
/** Los clientes del mes. */
|
|
3022
|
+
customers: {
|
|
3023
|
+
/** Cuántos clientes tuvo en el mes. */
|
|
3024
|
+
count: number;
|
|
3025
|
+
/** Cuántos CFDI emitidos suman al IVA cobrado. */
|
|
3026
|
+
cfdi: number;
|
|
3027
|
+
};
|
|
3028
|
+
} | null;
|
|
3029
|
+
}
|
|
2712
3030
|
/** Una tienda de Shopify, WooCommerce, Tiendanube, Mercado Libre o Amazon cuyos pedidos pagados se vuelven tickets de autofactura del emisor. */
|
|
2713
3031
|
export interface StoreConnection {
|
|
2714
3032
|
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
@@ -2859,6 +3177,158 @@ export interface Quote {
|
|
|
2859
3177
|
/** Cuándo se creó. */
|
|
2860
3178
|
created_at: string | null;
|
|
2861
3179
|
}
|
|
3180
|
+
/** Un pedido de venta: lo que su cliente pidió, cómo se entrega (remisiones) y cómo se factura y se cobra. */
|
|
3181
|
+
export interface SalesOrder {
|
|
3182
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
3183
|
+
id: string;
|
|
3184
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
3185
|
+
livemode: boolean;
|
|
3186
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
3187
|
+
object: "sales_order";
|
|
3188
|
+
/** El emisor (iss_…). */
|
|
3189
|
+
issuer: string;
|
|
3190
|
+
/** Su serie y folio (PED-12). */
|
|
3191
|
+
number: string;
|
|
3192
|
+
/** draft (borrador), confirmed, partially_delivered, delivered (todo entregado), invoiced (todo facturado), paid (sus facturas pagadas), closed (se dio por terminado) o canceled. Cambia solo, con lo que pasa. */
|
|
3193
|
+
status: "draft" | "confirmed" | "partially_delivered" | "delivered" | "invoiced" | "paid" | "closed" | "canceled";
|
|
3194
|
+
/** La etapa del negocio en que va («Por empacar», «En ruta»…), o null. Se elige en la app. */
|
|
3195
|
+
stage: string | null;
|
|
3196
|
+
/** La liga donde su cliente ve el pedido, lo confirma, firma cada entrega y abre sus facturas. null mientras sea borrador o no se haya mandado. */
|
|
3197
|
+
url: string | null;
|
|
3198
|
+
/** El cliente: su RFC, nombre, correo y su id en su catálogo. */
|
|
3199
|
+
customer: {
|
|
3200
|
+
/** RFC (Rfc), 12 caracteres una persona moral y 13 una física. */
|
|
3201
|
+
tax_id: string | null;
|
|
3202
|
+
/** Nombre. */
|
|
3203
|
+
name: string | null;
|
|
3204
|
+
/** Correo a donde se envía (varios separados por comas). Solo se usa si se pide enviarlo. */
|
|
3205
|
+
email: string | null;
|
|
3206
|
+
/** El cliente (cus_…) en su catálogo, o null si no está en él. */
|
|
3207
|
+
catalog_id: string | null;
|
|
3208
|
+
};
|
|
3209
|
+
/** El número de orden de compra de su cliente, o null. */
|
|
3210
|
+
customer_po: string | null;
|
|
3211
|
+
/** La cotización (quo_…) de donde salió, o null. */
|
|
3212
|
+
quote: string | null;
|
|
3213
|
+
/** La moneda. */
|
|
3214
|
+
currency: string;
|
|
3215
|
+
/** Los conceptos: id (para entregar o facturar una parte), lo pedido, lo entregado, lo facturado y lo que ya no se entregará (canceled). goods es true cuando sale del almacén. */
|
|
3216
|
+
items: {
|
|
3217
|
+
/** El id del concepto en el pedido: con él entrega o factura una parte (line). */
|
|
3218
|
+
id: number;
|
|
3219
|
+
/** Descripción del concepto (Descripcion), hasta 1,000 caracteres. */
|
|
3220
|
+
description: string;
|
|
3221
|
+
/** Clave del producto o servicio (ClaveProdServ), 8 dígitos de c_ClaveProdServ. Búsquela con GET /v1/sat_catalogs/product_keys?q=… */
|
|
3222
|
+
product_key: string | null;
|
|
3223
|
+
/** Cantidad (Cantidad). Por omisión 1. */
|
|
3224
|
+
quantity: number;
|
|
3225
|
+
/** La unidad, como la ve el cliente. */
|
|
3226
|
+
unit: string | null;
|
|
3227
|
+
/** Precio unitario antes de impuestos (ValorUnitario). */
|
|
3228
|
+
unit_price: number;
|
|
3229
|
+
/** El descuento del concepto, en dinero. */
|
|
3230
|
+
discount: number;
|
|
3231
|
+
/** El importe del concepto, sin impuestos. */
|
|
3232
|
+
amount: number;
|
|
3233
|
+
/** true si sale del almacén con cada entrega; false si es un servicio (solo se factura). */
|
|
3234
|
+
goods: boolean;
|
|
3235
|
+
/** Cuánto ya se entregó. */
|
|
3236
|
+
delivered: number;
|
|
3237
|
+
/** Cuánto ya se facturó. */
|
|
3238
|
+
invoiced: number;
|
|
3239
|
+
/** Cuánto ya no se entregará (POST /v1/sales_orders/{id}/cancel_remaining). */
|
|
3240
|
+
canceled: number;
|
|
3241
|
+
}[];
|
|
3242
|
+
/** El subtotal, sin impuestos. */
|
|
3243
|
+
subtotal: number;
|
|
3244
|
+
/** El total con impuestos. */
|
|
3245
|
+
total: number;
|
|
3246
|
+
/** La suma de sus facturas timbradas (sin las canceladas). */
|
|
3247
|
+
invoiced_total: number;
|
|
3248
|
+
/** Lo que ya se pagó de esas facturas. */
|
|
3249
|
+
paid_total: number;
|
|
3250
|
+
/** La entrega estimada (AAAA-MM-DD), o null. */
|
|
3251
|
+
expected_on: string | null;
|
|
3252
|
+
/** Días de crédito: cada factura vence esos días después de su fecha. */
|
|
3253
|
+
payment_days: number;
|
|
3254
|
+
/** delivered: cada factura lleva lo ya entregado; ordered: se factura lo pedido, entregado o no. */
|
|
3255
|
+
invoice_policy: "delivered" | "ordered";
|
|
3256
|
+
/** Dónde se entrega, o null. */
|
|
3257
|
+
ship_to: string | null;
|
|
3258
|
+
/** Las condiciones impresas en el pedido, o null. */
|
|
3259
|
+
terms: string | null;
|
|
3260
|
+
/** Las notas, como las de una factura. */
|
|
3261
|
+
notes: string | null;
|
|
3262
|
+
/** La nota interna (su cliente no la ve), o null. */
|
|
3263
|
+
internal_note: string | null;
|
|
3264
|
+
/** Sus entregas, cada una con su remisión. */
|
|
3265
|
+
deliveries: SalesOrderDelivery[];
|
|
3266
|
+
/** Sus facturas timbradas (inv_…), con lo que falta por pagar de cada una (balance). */
|
|
3267
|
+
invoices: {
|
|
3268
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
3269
|
+
id: string;
|
|
3270
|
+
/** stamped, o canceled (lo que llevaba se puede volver a facturar). */
|
|
3271
|
+
status: "stamped" | "canceled";
|
|
3272
|
+
/** El total de la factura. */
|
|
3273
|
+
total: number;
|
|
3274
|
+
/** Lo que falta por pagar de esa factura, o null si aún no se sabe. */
|
|
3275
|
+
balance: number | null;
|
|
3276
|
+
}[];
|
|
3277
|
+
/** Cuándo su cliente lo confirmó en su liga, o null. */
|
|
3278
|
+
customer_confirmed_at: string | null;
|
|
3279
|
+
/** Cuándo se mandó, o null. */
|
|
3280
|
+
sent_at: string | null;
|
|
3281
|
+
/** Cuándo su cliente abrió la liga por primera vez, o null. */
|
|
3282
|
+
viewed_at: string | null;
|
|
3283
|
+
/** Cuándo se confirmó, o null. */
|
|
3284
|
+
confirmed_at: string | null;
|
|
3285
|
+
/** Cuándo quedó todo entregado, o null. */
|
|
3286
|
+
delivered_at: string | null;
|
|
3287
|
+
/** Cuándo quedó todo facturado, o null. */
|
|
3288
|
+
invoiced_at: string | null;
|
|
3289
|
+
/** Cuándo quedaron pagadas sus facturas, o null. */
|
|
3290
|
+
paid_at: string | null;
|
|
3291
|
+
/** Cuándo se cerró, o null. */
|
|
3292
|
+
closed_at: string | null;
|
|
3293
|
+
/** Cuándo se canceló, o null. */
|
|
3294
|
+
canceled_at: string | null;
|
|
3295
|
+
/** Por qué se canceló, o null. */
|
|
3296
|
+
cancel_reason: string | null;
|
|
3297
|
+
/** Cuándo se creó. */
|
|
3298
|
+
created_at: string | null;
|
|
3299
|
+
}
|
|
3300
|
+
/** Una entrega del pedido, con su remisión (REM-1): lo que salió del almacén. */
|
|
3301
|
+
export interface SalesOrderDelivery {
|
|
3302
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
3303
|
+
id: string;
|
|
3304
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
3305
|
+
object: "sales_order_delivery";
|
|
3306
|
+
/** Su remisión (REM-1). */
|
|
3307
|
+
number: string;
|
|
3308
|
+
/** delivered, o canceled (la mercancía regresó al almacén). */
|
|
3309
|
+
status: "delivered" | "canceled";
|
|
3310
|
+
/** El día en que salió (AAAA-MM-DD). */
|
|
3311
|
+
delivered_on: string;
|
|
3312
|
+
/** El transporte, o null. */
|
|
3313
|
+
carrier: string | null;
|
|
3314
|
+
/** El número de guía, o null. */
|
|
3315
|
+
tracking: string | null;
|
|
3316
|
+
/** Una nota, o null. */
|
|
3317
|
+
note: string | null;
|
|
3318
|
+
/** Quién recibió (lo firmó en la liga o lo anotó usted), o null. */
|
|
3319
|
+
received_by: string | null;
|
|
3320
|
+
/** Cuándo se recibió, o null. */
|
|
3321
|
+
received_at: string | null;
|
|
3322
|
+
/** Cuánto salió de cada concepto (line es items[].id del pedido). */
|
|
3323
|
+
items: {
|
|
3324
|
+
/** El concepto del pedido (su items[].id). */
|
|
3325
|
+
line: number;
|
|
3326
|
+
/** Cuánto salió de él. */
|
|
3327
|
+
quantity: number;
|
|
3328
|
+
}[];
|
|
3329
|
+
/** Cuándo se registró. */
|
|
3330
|
+
created_at: string | null;
|
|
3331
|
+
}
|
|
2862
3332
|
/** Lo que un cliente le debe a un emisor en una moneda, de sus facturas abiertas. */
|
|
2863
3333
|
export interface Receivable {
|
|
2864
3334
|
/** El RFC y la moneda (RFC:MXN): para starting_after. */
|
|
@@ -2885,6 +3355,92 @@ export interface Receivable {
|
|
|
2885
3355
|
/** La fecha (AAAA-MM-DD) de su factura abierta más antigua. */
|
|
2886
3356
|
oldest_invoice_date: string;
|
|
2887
3357
|
}
|
|
3358
|
+
/** Cómo paga un cliente: de sus facturas a crédito (PPD) de los últimos 12 meses y sus complementos de pago, en pesos. */
|
|
3359
|
+
export interface CustomerPaymentBehavior {
|
|
3360
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
3361
|
+
object: "customer_payment_behavior";
|
|
3362
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
3363
|
+
livemode: boolean;
|
|
3364
|
+
/** El emisor. */
|
|
3365
|
+
issuer: string;
|
|
3366
|
+
/** El cliente (cus_…). */
|
|
3367
|
+
customer: string;
|
|
3368
|
+
/** Su RFC. */
|
|
3369
|
+
tax_id: string;
|
|
3370
|
+
/** Sus días de crédito: los suyos (Clientes) o los de la empresa (Ajustes › Cobranza automática). Contra ellos se mide el atraso. */
|
|
3371
|
+
credit_days: number;
|
|
3372
|
+
/** on_time (80 % o más llega a tiempo y atraso promedio de 5 días o menos), sometimes_late (hasta 15 días), late (hasta 45), very_late (más) o no_history (menos de 2 facturas pagadas y nada vencido). */
|
|
3373
|
+
rating: "on_time" | "sometimes_late" | "late" | "very_late" | "no_history";
|
|
3374
|
+
/** Facturas PPD con un pago en los últimos 12 meses. */
|
|
3375
|
+
paid_invoices: number;
|
|
3376
|
+
/** Días de la factura a su pago, en promedio por monto; null sin pagos. */
|
|
3377
|
+
average_days_to_pay: number | null;
|
|
3378
|
+
/** La factura típica: la mitad se pagó en estos días o menos. */
|
|
3379
|
+
median_days_to_pay: number | null;
|
|
3380
|
+
/** 3 de cada 4 facturas se pagaron en estos días o menos. */
|
|
3381
|
+
p75_days_to_pay: number | null;
|
|
3382
|
+
/** La parte (0 a 1) de lo pagado que llegó antes de vencer; lo vencido sin pagar cuenta como tarde. */
|
|
3383
|
+
on_time_share: number | null;
|
|
3384
|
+
/** Días después del vencimiento, en promedio por monto; lo vencido sin pagar cuenta con sus días de atraso hasta hoy. */
|
|
3385
|
+
average_days_late: number | null;
|
|
3386
|
+
/** Los últimos 3 meses contra los 9 anteriores; null con menos de 2 facturas pagadas en cada lado. */
|
|
3387
|
+
trend: {
|
|
3388
|
+
/** slower: tarda 7 días o más que antes; faster: 7 o más menos. */
|
|
3389
|
+
direction: "slower" | "faster" | "steady";
|
|
3390
|
+
/** Días promedio para pagar de los últimos 3 meses. */
|
|
3391
|
+
recent_days: number;
|
|
3392
|
+
/** Días promedio de los 9 meses anteriores. */
|
|
3393
|
+
earlier_days: number;
|
|
3394
|
+
} | null;
|
|
3395
|
+
/** Lo que debe ya vencido, en pesos. */
|
|
3396
|
+
overdue_amount: number;
|
|
3397
|
+
/** Cuántas facturas tiene vencidas. */
|
|
3398
|
+
overdue_invoices: number;
|
|
3399
|
+
/** Cómo le pagó, la mayor primero. */
|
|
3400
|
+
payment_forms: {
|
|
3401
|
+
/** Clave de forma de pago del SAT (c_FormaPago): 03 transferencia, 02 cheque… */
|
|
3402
|
+
payment_form: string;
|
|
3403
|
+
/** Lo pagado así, en pesos. */
|
|
3404
|
+
amount: number;
|
|
3405
|
+
/** Su parte de lo pagado (0 a 1). */
|
|
3406
|
+
share: number;
|
|
3407
|
+
}[];
|
|
3408
|
+
/** Cada uno de los últimos 12 meses, el más antiguo primero. */
|
|
3409
|
+
months: {
|
|
3410
|
+
/** El mes de los pagos (AAAA-MM). */
|
|
3411
|
+
month: string;
|
|
3412
|
+
/** Días promedio (por monto) de los pagos de ese mes; null sin pagos. */
|
|
3413
|
+
average_days_to_pay: number | null;
|
|
3414
|
+
/** Lo pagado ese mes, en pesos. */
|
|
3415
|
+
amount: number;
|
|
3416
|
+
/** Facturas con un pago ese mes. */
|
|
3417
|
+
paid_invoices: number;
|
|
3418
|
+
}[];
|
|
3419
|
+
/** Su último pago; null sin pagos en 12 meses. */
|
|
3420
|
+
last_payment: {
|
|
3421
|
+
/** El día (AAAA-MM-DD). */
|
|
3422
|
+
date: string;
|
|
3423
|
+
/** Lo pagado ese día, en pesos. */
|
|
3424
|
+
amount: number;
|
|
3425
|
+
} | null;
|
|
3426
|
+
/** Facturas de contado (PUE) de los últimos 12 meses: se pagan al emitirse y no cuentan en lo demás. */
|
|
3427
|
+
cash_invoices: number;
|
|
3428
|
+
/** Lo que debe ahora, la factura más antigua primero. */
|
|
3429
|
+
open_invoices: {
|
|
3430
|
+
/** El UUID (folio fiscal) de la factura. */
|
|
3431
|
+
uuid: string;
|
|
3432
|
+
/** Su fecha (AAAA-MM-DD). */
|
|
3433
|
+
date: string;
|
|
3434
|
+
/** PPD a crédito; PUE que le pagan este mes. */
|
|
3435
|
+
payment_method: "PPD" | "PUE";
|
|
3436
|
+
/** Lo que falta, en pesos. */
|
|
3437
|
+
amount_due: number;
|
|
3438
|
+
/** Cuándo vence: su fecha más los días de crédito (una PUE, al fin de su mes). */
|
|
3439
|
+
due_date: string;
|
|
3440
|
+
/** Cuándo le llegaría: su fecha más lo que el cliente suele tardar (sin historial, el vencimiento). */
|
|
3441
|
+
expected_payment_date: string;
|
|
3442
|
+
}[];
|
|
3443
|
+
}
|
|
2888
3444
|
/** Un depósito de la cuenta del emisor, y las facturas que pagó. */
|
|
2889
3445
|
export interface BankTransaction {
|
|
2890
3446
|
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
@@ -3087,14 +3643,14 @@ export interface WebhookTest {
|
|
|
3087
3643
|
};
|
|
3088
3644
|
}
|
|
3089
3645
|
/** Lo que puede pasar: el tipo de cada evento. */
|
|
3090
|
-
export type EventType = "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "invoice.email_bounced" | "invoice.email_complained" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "payroll_batch.completed" | "customer_data_request.completed" | "sat_download.completed" | "sat_download.failed" | "sat_declaration.created" | "sat_declaration.updated" | "ticket.invoiced" | "ticket.included_in_global" | "recurring_invoice.failed" | "quote.viewed" | "quote.accepted" | "quote.changes_requested" | "quote.rejected" | "quote.withdrawn" | "issuer.ready" | "balance.low" | "test_clock.ready";
|
|
3646
|
+
export type EventType = "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "invoice.email_bounced" | "invoice.email_complained" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "payroll_batch.completed" | "customer_data_request.completed" | "sat_download.completed" | "sat_download.failed" | "sat_declaration.created" | "sat_declaration.updated" | "ticket.invoiced" | "ticket.included_in_global" | "recurring_invoice.failed" | "quote.viewed" | "quote.accepted" | "quote.changes_requested" | "quote.rejected" | "quote.withdrawn" | "sales_order.confirmed" | "sales_order.customer_confirmed" | "sales_order.delivered" | "sales_order.paid" | "sales_order.canceled" | "issuer.ready" | "balance.low" | "test_clock.ready";
|
|
3091
3647
|
/** Algo que pasó en su cuenta: el objeto completo como quedó. Se manda a sus webhooks firmado (Standard Webhooks). */
|
|
3092
3648
|
export interface EventBase<T extends EventType = EventType, O = unknown> {
|
|
3093
3649
|
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
3094
3650
|
id: string;
|
|
3095
3651
|
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
3096
3652
|
object: "event";
|
|
3097
|
-
/** Qué pasó: invoice.stamped, invoice.failed, invoice.canceled, invoice.cancellation_pending, invoice.cancellation_rejected, invoice.paid, invoice.partially_paid, retention.stamped, retention.failed, retention.canceled, invoice_batch.completed, payroll_batch.completed, customer_data_request.completed, sat_download.completed, sat_download.failed, sat_declaration.created, sat_declaration.updated, ticket.invoiced, ticket.included_in_global, recurring_invoice.failed, quote.viewed, quote.accepted, quote.changes_requested, quote.rejected, quote.withdrawn, issuer.ready, balance.low o test_clock.ready. */
|
|
3653
|
+
/** Qué pasó: invoice.stamped, invoice.failed, invoice.canceled, invoice.cancellation_pending, invoice.cancellation_rejected, invoice.paid, invoice.partially_paid, retention.stamped, retention.failed, retention.canceled, invoice_batch.completed, payroll_batch.completed, customer_data_request.completed, sat_download.completed, sat_download.failed, sat_declaration.created, sat_declaration.updated, ticket.invoiced, ticket.included_in_global, recurring_invoice.failed, quote.viewed, quote.accepted, quote.changes_requested, quote.rejected, quote.withdrawn, sales_order.confirmed, sales_order.customer_confirmed, sales_order.delivered, sales_order.paid, sales_order.canceled, issuer.ready, balance.low o test_clock.ready. */
|
|
3098
3654
|
type: T;
|
|
3099
3655
|
/** Versión de la API con que se armó el objeto. */
|
|
3100
3656
|
api_version: string;
|
|
@@ -3108,7 +3664,7 @@ export interface EventBase<T extends EventType = EventType, O = unknown> {
|
|
|
3108
3664
|
};
|
|
3109
3665
|
}
|
|
3110
3666
|
/** Un evento: según su type, data.object es la factura, la constancia o el lote. */
|
|
3111
|
-
export type Event = EventBase<"invoice.stamped", Invoice> | EventBase<"invoice.failed", Invoice> | EventBase<"invoice.canceled", Invoice> | EventBase<"invoice.cancellation_pending", Invoice> | EventBase<"invoice.cancellation_rejected", Invoice> | EventBase<"invoice.paid", Invoice> | EventBase<"invoice.partially_paid", Invoice> | EventBase<"invoice.email_bounced", Invoice> | EventBase<"invoice.email_complained", Invoice> | EventBase<"retention.stamped", Retention> | EventBase<"retention.failed", Retention> | EventBase<"retention.canceled", Retention> | EventBase<"invoice_batch.completed", InvoiceBatch> | EventBase<"payroll_batch.completed", PayrollBatch> | EventBase<"customer_data_request.completed", CustomerDataRequest> | EventBase<"sat_download.completed", SatDownload> | EventBase<"sat_download.failed", SatDownload> | EventBase<"sat_declaration.created", SatDeclaration> | EventBase<"sat_declaration.updated", SatDeclaration> | EventBase<"ticket.invoiced", Ticket> | EventBase<"ticket.included_in_global", Ticket> | EventBase<"recurring_invoice.failed", RecurringInvoice> | EventBase<"quote.viewed", Quote> | EventBase<"quote.accepted", Quote> | EventBase<"quote.changes_requested", Quote> | EventBase<"quote.rejected", Quote> | EventBase<"quote.withdrawn", Quote> | EventBase<"issuer.ready", Issuer> | EventBase<"balance.low", Balance> | EventBase<"test_clock.ready", TestClock>;
|
|
3667
|
+
export type Event = EventBase<"invoice.stamped", Invoice> | EventBase<"invoice.failed", Invoice> | EventBase<"invoice.canceled", Invoice> | EventBase<"invoice.cancellation_pending", Invoice> | EventBase<"invoice.cancellation_rejected", Invoice> | EventBase<"invoice.paid", Invoice> | EventBase<"invoice.partially_paid", Invoice> | EventBase<"invoice.email_bounced", Invoice> | EventBase<"invoice.email_complained", Invoice> | EventBase<"retention.stamped", Retention> | EventBase<"retention.failed", Retention> | EventBase<"retention.canceled", Retention> | EventBase<"invoice_batch.completed", InvoiceBatch> | EventBase<"payroll_batch.completed", PayrollBatch> | EventBase<"customer_data_request.completed", CustomerDataRequest> | EventBase<"sat_download.completed", SatDownload> | EventBase<"sat_download.failed", SatDownload> | EventBase<"sat_declaration.created", SatDeclaration> | EventBase<"sat_declaration.updated", SatDeclaration> | EventBase<"ticket.invoiced", Ticket> | EventBase<"ticket.included_in_global", Ticket> | EventBase<"recurring_invoice.failed", RecurringInvoice> | EventBase<"quote.viewed", Quote> | EventBase<"quote.accepted", Quote> | EventBase<"quote.changes_requested", Quote> | EventBase<"quote.rejected", Quote> | EventBase<"quote.withdrawn", Quote> | EventBase<"sales_order.confirmed", SalesOrder> | EventBase<"sales_order.customer_confirmed", SalesOrder> | EventBase<"sales_order.delivered", SalesOrder> | EventBase<"sales_order.paid", SalesOrder> | EventBase<"sales_order.canceled", SalesOrder> | EventBase<"issuer.ready", Issuer> | EventBase<"balance.low", Balance> | EventBase<"test_clock.ready", TestClock>;
|
|
3112
3668
|
/** Confirmación de que se borró. */
|
|
3113
3669
|
export interface Deleted {
|
|
3114
3670
|
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
@@ -3280,6 +3836,26 @@ export interface CostCenterList {
|
|
|
3280
3836
|
/** La ruta de esta lista. */
|
|
3281
3837
|
url: string;
|
|
3282
3838
|
}
|
|
3839
|
+
export interface ExpensePersonList {
|
|
3840
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
3841
|
+
object: "list";
|
|
3842
|
+
/** Los objetos de esta página. */
|
|
3843
|
+
data: ExpensePerson[];
|
|
3844
|
+
/** true si hay más: pida la siguiente con starting_after igual al id del último. */
|
|
3845
|
+
has_more: boolean;
|
|
3846
|
+
/** La ruta de esta lista. */
|
|
3847
|
+
url: string;
|
|
3848
|
+
}
|
|
3849
|
+
export interface ExpenseReportList {
|
|
3850
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
3851
|
+
object: "list";
|
|
3852
|
+
/** Los objetos de esta página. */
|
|
3853
|
+
data: ExpenseReport[];
|
|
3854
|
+
/** true si hay más: pida la siguiente con starting_after igual al id del último. */
|
|
3855
|
+
has_more: boolean;
|
|
3856
|
+
/** La ruta de esta lista. */
|
|
3857
|
+
url: string;
|
|
3858
|
+
}
|
|
3283
3859
|
export interface CustomerList {
|
|
3284
3860
|
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
3285
3861
|
object: "list";
|
|
@@ -3490,6 +4066,16 @@ export interface QuoteList {
|
|
|
3490
4066
|
/** La ruta de esta lista. */
|
|
3491
4067
|
url: string;
|
|
3492
4068
|
}
|
|
4069
|
+
export interface SalesOrderList {
|
|
4070
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
4071
|
+
object: "list";
|
|
4072
|
+
/** Los objetos de esta página. */
|
|
4073
|
+
data: SalesOrder[];
|
|
4074
|
+
/** true si hay más: pida la siguiente con starting_after igual al id del último. */
|
|
4075
|
+
has_more: boolean;
|
|
4076
|
+
/** La ruta de esta lista. */
|
|
4077
|
+
url: string;
|
|
4078
|
+
}
|
|
3493
4079
|
export interface WebhookEndpointList {
|
|
3494
4080
|
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
3495
4081
|
object: "list";
|
|
@@ -5718,6 +6304,204 @@ export interface DeleteCostCenterParams {
|
|
|
5718
6304
|
/** Otro centro de costo (ccn_…) que se queda con sus facturas. */
|
|
5719
6305
|
move_to?: string;
|
|
5720
6306
|
}
|
|
6307
|
+
export interface CreateExpensePersonParams {
|
|
6308
|
+
/** El emisor (iss_…). Por omisión, su único emisor. */
|
|
6309
|
+
issuer?: string;
|
|
6310
|
+
/** empleado (sus viáticos van en su recibo de nómina; sus facturas pueden ir a su nombre en un viaje) o honorarios (sus facturas deben ir a nombre del emisor). */
|
|
6311
|
+
kind: "empleado" | "honorarios";
|
|
6312
|
+
/** Un empleado de Nómina (emp_…): su nombre, RFC y correo se toman de ahí y sus viáticos van en su recibo. Solo con kind empleado. */
|
|
6313
|
+
employee?: string | null;
|
|
6314
|
+
/** Su nombre. Obligatorio sin employee. */
|
|
6315
|
+
name?: string | null;
|
|
6316
|
+
/** Su RFC. */
|
|
6317
|
+
tax_id?: string | null;
|
|
6318
|
+
/** Su correo: para mandarle su enlace y avisarle cuando se aprueba o se le paga. */
|
|
6319
|
+
email?: string | null;
|
|
6320
|
+
/** Dónde trabaja (por ejemplo «Guadalajara, Jal.»): un viaje a menos de 50 km no es deducible como viáticos. */
|
|
6321
|
+
base_city?: string | null;
|
|
6322
|
+
/** Su área. */
|
|
6323
|
+
department?: string | null;
|
|
6324
|
+
}
|
|
6325
|
+
/** Los parámetros de GET /v1/expense_people. */
|
|
6326
|
+
export interface ListExpensePeopleParams {
|
|
6327
|
+
/** Cuántos por página, de 1 a 100. Por omisión 10. */
|
|
6328
|
+
limit?: number;
|
|
6329
|
+
/** El id del último de la página anterior, para la siguiente. */
|
|
6330
|
+
starting_after?: string;
|
|
6331
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
6332
|
+
issuer?: string;
|
|
6333
|
+
/** true para incluir las archivadas. */
|
|
6334
|
+
include_archived?: boolean;
|
|
6335
|
+
}
|
|
6336
|
+
export interface UpdateExpensePersonParams {
|
|
6337
|
+
/** empleado (sus viáticos van en su recibo de nómina; sus facturas pueden ir a su nombre en un viaje) o honorarios (sus facturas deben ir a nombre del emisor). */
|
|
6338
|
+
kind?: "empleado" | "honorarios";
|
|
6339
|
+
/** Un empleado de Nómina (emp_…): su nombre, RFC y correo se toman de ahí y sus viáticos van en su recibo. Solo con kind empleado. */
|
|
6340
|
+
employee?: string | null;
|
|
6341
|
+
/** Su nombre. Obligatorio sin employee. */
|
|
6342
|
+
name?: string | null;
|
|
6343
|
+
/** Su RFC. */
|
|
6344
|
+
tax_id?: string | null;
|
|
6345
|
+
/** Su correo: para mandarle su enlace y avisarle cuando se aprueba o se le paga. */
|
|
6346
|
+
email?: string | null;
|
|
6347
|
+
/** Dónde trabaja (por ejemplo «Guadalajara, Jal.»): un viaje a menos de 50 km no es deducible como viáticos. */
|
|
6348
|
+
base_city?: string | null;
|
|
6349
|
+
/** Su área. */
|
|
6350
|
+
department?: string | null;
|
|
6351
|
+
/** true la archiva (y apaga su enlace): ya no se le abren comprobaciones. false la restaura. */
|
|
6352
|
+
archived?: boolean;
|
|
6353
|
+
}
|
|
6354
|
+
export interface CreateExpensePersonLinkParams {
|
|
6355
|
+
/** true le da un enlace nuevo: el anterior deja de funcionar en ese momento (por ejemplo, si se compartió por error). */
|
|
6356
|
+
renew?: boolean;
|
|
6357
|
+
}
|
|
6358
|
+
export interface CreateExpenseReportParams {
|
|
6359
|
+
/** La persona (exp_…). */
|
|
6360
|
+
person: string;
|
|
6361
|
+
/** viaje (por omisión) o gastos (gastos de oficina de un periodo que la empresa reembolsa). */
|
|
6362
|
+
kind?: "viaje" | "gastos";
|
|
6363
|
+
/** Su nombre. Por omisión, «Viaje a {destination}» o el periodo. */
|
|
6364
|
+
title?: string | null;
|
|
6365
|
+
/** Para qué fue: el SAT pide que el viaje sea por el negocio. */
|
|
6366
|
+
purpose?: string | null;
|
|
6367
|
+
/** A dónde. */
|
|
6368
|
+
destination?: string | null;
|
|
6369
|
+
/** Al extranjero: cambian los topes de alimentos y hospedaje. */
|
|
6370
|
+
abroad?: boolean;
|
|
6371
|
+
/** A más de 50 km de donde trabaja la persona (por omisión, true). Más cerca, no son viáticos deducibles. */
|
|
6372
|
+
far?: boolean;
|
|
6373
|
+
/** La salida (o el inicio del periodo). */
|
|
6374
|
+
start_date?: string | null;
|
|
6375
|
+
/** El regreso (o el fin del periodo). */
|
|
6376
|
+
end_date?: string | null;
|
|
6377
|
+
}
|
|
6378
|
+
/** Los parámetros de GET /v1/expense_reports. */
|
|
6379
|
+
export interface ListExpenseReportsParams {
|
|
6380
|
+
/** Cuántos por página, de 1 a 100. Por omisión 10. */
|
|
6381
|
+
limit?: number;
|
|
6382
|
+
/** El id del último de la página anterior, para la siguiente. */
|
|
6383
|
+
starting_after?: string;
|
|
6384
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
6385
|
+
issuer?: string;
|
|
6386
|
+
/** Solo las de un estado: draft, submitted, rejected, approved o closed. */
|
|
6387
|
+
status?: string;
|
|
6388
|
+
/** Solo las de una persona (exp_…). */
|
|
6389
|
+
person?: string;
|
|
6390
|
+
}
|
|
6391
|
+
export interface UpdateExpenseReportParams {
|
|
6392
|
+
/** Su nombre. Por omisión, «Viaje a {destination}» o el periodo. */
|
|
6393
|
+
title?: string | null;
|
|
6394
|
+
/** Para qué fue: el SAT pide que el viaje sea por el negocio. */
|
|
6395
|
+
purpose?: string | null;
|
|
6396
|
+
/** A dónde. */
|
|
6397
|
+
destination?: string | null;
|
|
6398
|
+
/** Al extranjero: cambian los topes de alimentos y hospedaje. */
|
|
6399
|
+
abroad?: boolean;
|
|
6400
|
+
/** A más de 50 km de donde trabaja la persona (por omisión, true). Más cerca, no son viáticos deducibles. */
|
|
6401
|
+
far?: boolean;
|
|
6402
|
+
/** La salida (o el inicio del periodo). */
|
|
6403
|
+
start_date?: string | null;
|
|
6404
|
+
/** El regreso (o el fin del periodo). */
|
|
6405
|
+
end_date?: string | null;
|
|
6406
|
+
}
|
|
6407
|
+
export interface ApproveExpenseReportParams {
|
|
6408
|
+
/** Una nota para la persona. */
|
|
6409
|
+
note?: string | null;
|
|
6410
|
+
}
|
|
6411
|
+
export interface ReturnExpenseReportParams {
|
|
6412
|
+
/** Qué debe corregir: se le manda a la persona. */
|
|
6413
|
+
note: string;
|
|
6414
|
+
}
|
|
6415
|
+
export interface CreateExpenseItemParams {
|
|
6416
|
+
/** El UUID de una factura recibida del emisor (GET /v1/sat_invoices): la fecha, el monto, el proveedor y la forma de pago salen de ella. */
|
|
6417
|
+
uuid?: string;
|
|
6418
|
+
/** De qué es: hospedaje, alimentos, avion, transporte, auto, combustible (gasolina, casetas y estacionamiento), comidas (en restaurante, fuera de viaje), papeleria, mensajeria, software u otros. */
|
|
6419
|
+
category: "hospedaje" | "alimentos" | "avion" | "transporte" | "auto" | "combustible" | "comidas" | "papeleria" | "mensajeria" | "software" | "otros";
|
|
6420
|
+
/** Cuándo se gastó. Con uuid, la fecha de la factura. */
|
|
6421
|
+
date?: string;
|
|
6422
|
+
/** Qué fue (el proveedor). Con uuid, su emisor. */
|
|
6423
|
+
description?: string | null;
|
|
6424
|
+
/** En pesos. Con uuid, el total de la factura. */
|
|
6425
|
+
amount?: number;
|
|
6426
|
+
/** En su moneda, si fue en otra. */
|
|
6427
|
+
foreign_amount?: number | null;
|
|
6428
|
+
/** La moneda (USD, EUR…). */
|
|
6429
|
+
foreign_currency?: string | null;
|
|
6430
|
+
/** En alimentos, cuántas personas comieron: el tope es por persona. */
|
|
6431
|
+
people?: number;
|
|
6432
|
+
/** Cómo se pagó: tarjeta_empresa (no se le reembolsa), tarjeta_propia, efectivo, transferencia u otro. */
|
|
6433
|
+
payment?: "tarjeta_empresa" | "tarjeta_propia" | "efectivo" | "transferencia" | "otro" | null;
|
|
6434
|
+
/** Su comprobante: cfdi, extranjero, ticket o ninguno. Con uuid, cfdi. */
|
|
6435
|
+
receipt?: "cfdi" | "extranjero" | "ticket" | "ninguno";
|
|
6436
|
+
/** Por qué, si pasa la política (la política puede pedirla). */
|
|
6437
|
+
note?: string | null;
|
|
6438
|
+
}
|
|
6439
|
+
export interface UpdateExpenseItemParams {
|
|
6440
|
+
/** De qué es: hospedaje, alimentos, avion, transporte, auto, combustible (gasolina, casetas y estacionamiento), comidas (en restaurante, fuera de viaje), papeleria, mensajeria, software u otros. */
|
|
6441
|
+
category?: "hospedaje" | "alimentos" | "avion" | "transporte" | "auto" | "combustible" | "comidas" | "papeleria" | "mensajeria" | "software" | "otros";
|
|
6442
|
+
/** Cuándo se gastó. Con uuid, la fecha de la factura. */
|
|
6443
|
+
date?: string;
|
|
6444
|
+
/** Qué fue (el proveedor). Con uuid, su emisor. */
|
|
6445
|
+
description?: string | null;
|
|
6446
|
+
/** En pesos. Con uuid, el total de la factura. */
|
|
6447
|
+
amount?: number;
|
|
6448
|
+
/** En su moneda, si fue en otra. */
|
|
6449
|
+
foreign_amount?: number | null;
|
|
6450
|
+
/** La moneda (USD, EUR…). */
|
|
6451
|
+
foreign_currency?: string | null;
|
|
6452
|
+
/** En alimentos, cuántas personas comieron: el tope es por persona. */
|
|
6453
|
+
people?: number;
|
|
6454
|
+
/** Cómo se pagó: tarjeta_empresa (no se le reembolsa), tarjeta_propia, efectivo, transferencia u otro. */
|
|
6455
|
+
payment?: "tarjeta_empresa" | "tarjeta_propia" | "efectivo" | "transferencia" | "otro" | null;
|
|
6456
|
+
/** Su comprobante: cfdi, extranjero, ticket o ninguno. Con uuid, cfdi. */
|
|
6457
|
+
receipt?: "cfdi" | "extranjero" | "ticket" | "ninguno";
|
|
6458
|
+
/** Por qué, si pasa la política (la política puede pedirla). */
|
|
6459
|
+
note?: string | null;
|
|
6460
|
+
/** Al aprobar: true lo rechaza (no se paga ni se deduce), false lo vuelve a incluir. Solo en una comprobación enviada. */
|
|
6461
|
+
rejected?: boolean;
|
|
6462
|
+
/** Por qué se rechaza. */
|
|
6463
|
+
reject_reason?: string | null;
|
|
6464
|
+
}
|
|
6465
|
+
export interface CreateExpenseMovementParams {
|
|
6466
|
+
/** anticipo (dinero que se le da antes o durante; hasta que se aprueba), reembolso (lo que la empresa le debe, ya aprobada) o devolucion (lo que le sobró, ya aprobada). */
|
|
6467
|
+
kind: "anticipo" | "reembolso" | "devolucion";
|
|
6468
|
+
/** En pesos. */
|
|
6469
|
+
amount: number;
|
|
6470
|
+
/** Cuándo se pagó. */
|
|
6471
|
+
date: string;
|
|
6472
|
+
/** transferencia (por omisión), efectivo, tarjeta o nomina (en el siguiente recibo de nómina del empleado; solo si está en Nómina). */
|
|
6473
|
+
method?: "transferencia" | "efectivo" | "tarjeta" | "nomina";
|
|
6474
|
+
/** Su referencia (folio de la transferencia). */
|
|
6475
|
+
reference?: string | null;
|
|
6476
|
+
}
|
|
6477
|
+
/** Los parámetros de GET /v1/expense_policy. */
|
|
6478
|
+
export interface GetExpensePolicyParams {
|
|
6479
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
6480
|
+
issuer?: string;
|
|
6481
|
+
}
|
|
6482
|
+
export interface UpdateExpensePolicyParams {
|
|
6483
|
+
/** El emisor (iss_…). Por omisión, su único emisor. */
|
|
6484
|
+
issuer?: string;
|
|
6485
|
+
/** Topes por categoría. Una categoría con null deja de tener tope; las que no manda no cambian. Un gasto que pase un tope no se rechaza: se marca para quien aprueba. */
|
|
6486
|
+
limits?: Record<string, {
|
|
6487
|
+
/** En México; null sin tope. */
|
|
6488
|
+
domestic: number | null;
|
|
6489
|
+
/** En el extranjero; null sin tope. */
|
|
6490
|
+
abroad: number | null;
|
|
6491
|
+
/** dia (al día y por persona) o gasto. */
|
|
6492
|
+
per: "dia" | "gasto";
|
|
6493
|
+
} | null>;
|
|
6494
|
+
/** Hasta cuánto se acepta un gasto sin factura; 0: todos la piden. */
|
|
6495
|
+
ticket_limit?: number;
|
|
6496
|
+
/** Días después del regreso para comprobar. */
|
|
6497
|
+
due_days?: number;
|
|
6498
|
+
/** Pedir una nota en cada gasto que pase un tope. */
|
|
6499
|
+
note_over_limit?: boolean;
|
|
6500
|
+
/** Avisar por correo a quien aprueba cuando le envían una comprobación. */
|
|
6501
|
+
notify_approvers?: boolean;
|
|
6502
|
+
/** Avisar a la persona cuando se aprueba, se devuelve o se le paga. */
|
|
6503
|
+
notify_people?: boolean;
|
|
6504
|
+
}
|
|
5721
6505
|
export interface CreateCustomerParams {
|
|
5722
6506
|
/** Emisor (iss_…). Si la llave tiene un solo emisor o la cuenta tiene uno solo, puede omitirse. */
|
|
5723
6507
|
issuer?: string;
|
|
@@ -6222,6 +7006,13 @@ export interface GetCrossChecksParams {
|
|
|
6222
7006
|
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
6223
7007
|
issuer?: string;
|
|
6224
7008
|
}
|
|
7009
|
+
/** Los parámetros de GET /v1/accounting/vat_refund. */
|
|
7010
|
+
export interface GetVatRefundParams {
|
|
7011
|
+
/** El mes del saldo a revisar (AAAA-MM). Sin él, solo los saldos. */
|
|
7012
|
+
month?: string;
|
|
7013
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
7014
|
+
issuer?: string;
|
|
7015
|
+
}
|
|
6225
7016
|
/** Los parámetros de GET /v1/accounting/cross_checks/cfdi. */
|
|
6226
7017
|
export interface GetCrossCheckCfdiParams {
|
|
6227
7018
|
/** El mes (AAAA-MM), cuya declaración ya venció. */
|
|
@@ -6732,14 +7523,383 @@ export interface RejectQuoteParams {
|
|
|
6732
7523
|
/** Por qué (queda en customer_comment; el cliente no la ve). */
|
|
6733
7524
|
note?: string;
|
|
6734
7525
|
}
|
|
6735
|
-
export interface
|
|
6736
|
-
/**
|
|
6737
|
-
|
|
6738
|
-
/**
|
|
6739
|
-
|
|
6740
|
-
/**
|
|
6741
|
-
|
|
6742
|
-
|
|
7526
|
+
export interface CreateSalesOrderParams {
|
|
7527
|
+
/** Emisor (iss_…). Si la llave tiene un solo emisor o la cuenta tiene uno solo, puede omitirse. */
|
|
7528
|
+
issuer?: string;
|
|
7529
|
+
/** Hacerlo de una cotización (quo_…): toma su cliente y sus conceptos, y la cotización queda aceptada. Sin customer ni items. */
|
|
7530
|
+
quote?: string;
|
|
7531
|
+
/** Un cliente de su catálogo (cus_…) o uno con sus datos fiscales (como en POST /v1/invoices: se agrega a sus clientes). */
|
|
7532
|
+
customer?: string | {
|
|
7533
|
+
/** RFC (Rfc), 12 caracteres una persona moral y 13 una física. */
|
|
7534
|
+
tax_id: string;
|
|
7535
|
+
/** Nombre o razón social tal como está en la constancia de situación fiscal, sin el régimen de capital (sin «S.A. de C.V.»). */
|
|
7536
|
+
legal_name: string;
|
|
7537
|
+
/** Régimen fiscal (RegimenFiscal), clave de c_RegimenFiscal: 601, 612, 626… */
|
|
7538
|
+
tax_system: string;
|
|
7539
|
+
/** Código postal del domicilio fiscal del cliente (DomicilioFiscalReceptor), 5 dígitos. */
|
|
7540
|
+
zip: string;
|
|
7541
|
+
/** Correo a donde se envía (varios separados por comas). Solo se usa si se pide enviarlo. */
|
|
7542
|
+
email?: string | null;
|
|
7543
|
+
/** Si es extranjero: su país de residencia (ResidenciaFiscal, c_Pais) y su número de registro tributario (NumRegIdTrib), con el RFC genérico XEXX010101000. */
|
|
7544
|
+
foreign?: {
|
|
7545
|
+
/** País de residencia fiscal, clave de 3 letras de c_Pais (USA, CAN…). */
|
|
7546
|
+
country: string;
|
|
7547
|
+
/** Número de registro de identidad fiscal en su país (NumRegIdTrib). */
|
|
7548
|
+
tax_id: string;
|
|
7549
|
+
};
|
|
7550
|
+
/** true si el cliente es contribuyente de IEPS: el IEPS va desglosado en vez de sumado al precio. */
|
|
7551
|
+
ieps_taxpayer?: boolean;
|
|
7552
|
+
};
|
|
7553
|
+
/** Los conceptos, como en POST /v1/invoices (hasta 200). */
|
|
7554
|
+
items?: {
|
|
7555
|
+
/** Un producto de su catálogo (prd_…): toma su clave, unidad, precio e impuestos. */
|
|
7556
|
+
product?: string;
|
|
7557
|
+
/** Descripción del concepto (Descripcion), hasta 1,000 caracteres. */
|
|
7558
|
+
description?: string;
|
|
7559
|
+
/** Clave del producto o servicio (ClaveProdServ), 8 dígitos de c_ClaveProdServ. Búsquela con GET /v1/sat_catalogs/product_keys?q=… */
|
|
7560
|
+
product_key?: string;
|
|
7561
|
+
/** Clave de unidad (ClaveUnidad) de c_ClaveUnidad: E48 unidad de servicio (por omisión), H87 pieza, ACT actividad… */
|
|
7562
|
+
unit_key?: string;
|
|
7563
|
+
/** Nombre de la unidad (Unidad), hasta 20 caracteres. */
|
|
7564
|
+
unit_name?: string | null;
|
|
7565
|
+
/** Número de identificación o SKU (NoIdentificacion). */
|
|
7566
|
+
sku?: string | null;
|
|
7567
|
+
/** Cantidad (Cantidad). Por omisión 1. */
|
|
7568
|
+
quantity?: number;
|
|
7569
|
+
/** Precio unitario antes de impuestos (ValorUnitario). */
|
|
7570
|
+
unit_price?: number;
|
|
7571
|
+
/** Descuento (Descuento). */
|
|
7572
|
+
discount?: number;
|
|
7573
|
+
/** Objeto de impuesto (ObjetoImp), c_ObjetoImp: 01 no objeto, 02 sí objeto (por omisión), 03 sin desglose, 04 no causa… */
|
|
7574
|
+
taxability?: "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08";
|
|
7575
|
+
/** Tasa de IVA trasladado: 0.16 (por omisión), 0.08 (región fronteriza), 0 o exento. */
|
|
7576
|
+
iva?: "0" | "0.16" | "0.08" | "exento";
|
|
7577
|
+
/** IEPS trasladado: tasa (0.265…) o cuota en pesos por unidad, según ieps_factor. */
|
|
7578
|
+
ieps?: number;
|
|
7579
|
+
/** Tasa o Cuota (TipoFactor del IEPS). */
|
|
7580
|
+
ieps_factor?: "Tasa" | "Cuota";
|
|
7581
|
+
/** Unidades de IEPS a cuota (litros, cigarros…), si no son la cantidad. */
|
|
7582
|
+
ieps_units?: number;
|
|
7583
|
+
/** Tasa de IVA retenido (por ejemplo 0.106667, dos terceras partes del 16%). */
|
|
7584
|
+
iva_retention?: number;
|
|
7585
|
+
/** Tasa de ISR retenido (por ejemplo 0.10 honorarios, 0.0125 RESICO). */
|
|
7586
|
+
isr_retention?: number;
|
|
7587
|
+
/** Números de cuenta predial (CuentaPredial) en arrendamiento. */
|
|
7588
|
+
predial?: string[];
|
|
7589
|
+
/** Números de pedimento (InformacionAduanera) de mercancía importada. */
|
|
7590
|
+
pedimentos?: string[];
|
|
7591
|
+
/** A cuenta de terceros (ACuentaTerceros): RFC, nombre, régimen y código postal. */
|
|
7592
|
+
third_party?: {
|
|
7593
|
+
/** RFC de a cuenta de quién (RfcACuentaTerceros). */
|
|
7594
|
+
tax_id: string;
|
|
7595
|
+
/** Nombre (NombreACuentaTerceros). */
|
|
7596
|
+
name: string;
|
|
7597
|
+
/** Régimen fiscal (RegimenFiscalACuentaTerceros), c_RegimenFiscal. */
|
|
7598
|
+
tax_system: string;
|
|
7599
|
+
/** Código postal de su domicilio fiscal (DomicilioFiscalACuentaTerceros). */
|
|
7600
|
+
zip: string;
|
|
7601
|
+
};
|
|
7602
|
+
/** Complemento de instituciones educativas privadas (IEDU): alumno, CURP, nivel y RVOE. */
|
|
7603
|
+
iedu?: {
|
|
7604
|
+
/** Nombre del alumno (nombreAlumno). */
|
|
7605
|
+
student_name: string;
|
|
7606
|
+
/** CURP, 18 caracteres. */
|
|
7607
|
+
curp: string;
|
|
7608
|
+
/** Nivel educativo (nivelEducativo). */
|
|
7609
|
+
level: "Preescolar" | "Primaria" | "Secundaria" | "Profesional técnico" | "Bachillerato o su equivalente";
|
|
7610
|
+
/** Reconocimiento de validez oficial de estudios (autRVOE). */
|
|
7611
|
+
rvoe: string;
|
|
7612
|
+
/** RFC de quien paga, si no es el receptor (rfcPago). */
|
|
7613
|
+
payer_tax_id?: string | null;
|
|
7614
|
+
};
|
|
7615
|
+
/** Complemento de vehículo usado. */
|
|
7616
|
+
used_vehicle?: {
|
|
7617
|
+
/** Monto de adquisición (montoAdquisicion). */
|
|
7618
|
+
purchase_amount: number;
|
|
7619
|
+
/** Monto de enajenación (montoEnajenacion). */
|
|
7620
|
+
sale_amount: number;
|
|
7621
|
+
/** Clave vehicular (claveVehicular). */
|
|
7622
|
+
vehicle_key: string;
|
|
7623
|
+
/** Marca (marca). */
|
|
7624
|
+
make: string;
|
|
7625
|
+
/** Tipo o versión (tipo). */
|
|
7626
|
+
type: string;
|
|
7627
|
+
/** Año del modelo (modelo), 4 dígitos. */
|
|
7628
|
+
model: string;
|
|
7629
|
+
/** Número de motor (numeroMotor). */
|
|
7630
|
+
engine_number?: string;
|
|
7631
|
+
/** Número de serie (numeroSerie). */
|
|
7632
|
+
serial_number?: string;
|
|
7633
|
+
/** Número de identificación vehicular (NIV). */
|
|
7634
|
+
niv?: string;
|
|
7635
|
+
/** Valor según la guía EBC o Libro Azul (valor). */
|
|
7636
|
+
guide_value: number;
|
|
7637
|
+
/** Información aduanera de la importación del vehículo (InformacionAduanera). */
|
|
7638
|
+
customs?: {
|
|
7639
|
+
/** Número del documento de importación (numero). */
|
|
7640
|
+
number: string;
|
|
7641
|
+
/** Fecha del documento (fecha), AAAA-MM-DD. */
|
|
7642
|
+
date: string;
|
|
7643
|
+
/** Aduana (aduana). */
|
|
7644
|
+
office?: string;
|
|
7645
|
+
}[];
|
|
7646
|
+
};
|
|
7647
|
+
/** Addenda del receptor (Walmart, Soriana…), con sus propios campos. */
|
|
7648
|
+
addenda?: Record<string, string>;
|
|
7649
|
+
}[];
|
|
7650
|
+
/** Confirmarlo en el mismo paso (por omisión false: queda en draft). Confirmado, aparta lo pedido en el almacén. */
|
|
7651
|
+
confirm?: boolean;
|
|
7652
|
+
/** Moneda, clave ISO 4217 de c_Moneda (MXN, USD, EUR…). Por omisión MXN. */
|
|
7653
|
+
currency?: string;
|
|
7654
|
+
/** Tipo de cambio a pesos (TipoCambio). Obligatorio si la moneda no es MXN; use el del DOF del día anterior. */
|
|
7655
|
+
exchange_rate?: number;
|
|
7656
|
+
/** Forma de pago (FormaPago), clave de c_FormaPago: 01 efectivo, 03 transferencia, 04 tarjeta de crédito, 28 débito, 99 por definir… Obligatoria con PUE; con PPD es 99. */
|
|
7657
|
+
payment_form?: string;
|
|
7658
|
+
/** Método de pago (MetodoPago): PUE (una sola exhibición, por omisión) o PPD (en parcialidades o diferido, se cobra con complementos de pago). */
|
|
7659
|
+
payment_method?: "PUE" | "PPD";
|
|
7660
|
+
/** Uso del CFDI (UsoCFDI), clave de c_UsoCFDI. Por omisión G03, o S01 con régimen 616. */
|
|
7661
|
+
use?: string;
|
|
7662
|
+
/** Observaciones que aparecen en el PDF (no van en el XML). */
|
|
7663
|
+
notes?: string;
|
|
7664
|
+
/** El número de orden de compra de su cliente (va en la nota de cada factura). */
|
|
7665
|
+
customer_po?: string;
|
|
7666
|
+
/** A dónde mandarle el pedido y sus remisiones (hasta 5 correos, separados por comas). Por omisión, el del cliente. */
|
|
7667
|
+
email?: string;
|
|
7668
|
+
/** Entrega estimada (AAAA-MM-DD). */
|
|
7669
|
+
expected_on?: string;
|
|
7670
|
+
/** Días de crédito (0: de contado). */
|
|
7671
|
+
payment_days?: number;
|
|
7672
|
+
/** Qué se factura: delivered (por omisión), lo ya entregado; ordered, todo lo pedido desde el inicio (por ejemplo con pago por adelantado). */
|
|
7673
|
+
invoice_policy?: "delivered" | "ordered";
|
|
7674
|
+
/** Dónde se entrega. */
|
|
7675
|
+
ship_to?: string;
|
|
7676
|
+
/** Condiciones del pedido. */
|
|
7677
|
+
terms?: string;
|
|
7678
|
+
/** Nota interna (su cliente no la ve). */
|
|
7679
|
+
internal_note?: string;
|
|
7680
|
+
}
|
|
7681
|
+
/** Los parámetros de GET /v1/sales_orders. */
|
|
7682
|
+
export interface ListSalesOrdersParams {
|
|
7683
|
+
/** Cuántos por página, de 1 a 100. Por omisión 10. */
|
|
7684
|
+
limit?: number;
|
|
7685
|
+
/** El id del último de la página anterior, para la siguiente. */
|
|
7686
|
+
starting_after?: string;
|
|
7687
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
7688
|
+
issuer?: string;
|
|
7689
|
+
/** Solo los que estén en este estado. */
|
|
7690
|
+
status?: "draft" | "confirmed" | "partially_delivered" | "delivered" | "invoiced" | "paid" | "closed" | "canceled";
|
|
7691
|
+
/** Solo los de este RFC. */
|
|
7692
|
+
customer?: string;
|
|
7693
|
+
}
|
|
7694
|
+
export interface UpdateSalesOrderParams {
|
|
7695
|
+
/** Un cliente de su catálogo (cus_…) o uno con sus datos fiscales (como en POST /v1/invoices: se agrega a sus clientes). */
|
|
7696
|
+
customer?: string | {
|
|
7697
|
+
/** RFC (Rfc), 12 caracteres una persona moral y 13 una física. */
|
|
7698
|
+
tax_id: string;
|
|
7699
|
+
/** Nombre o razón social tal como está en la constancia de situación fiscal, sin el régimen de capital (sin «S.A. de C.V.»). */
|
|
7700
|
+
legal_name: string;
|
|
7701
|
+
/** Régimen fiscal (RegimenFiscal), clave de c_RegimenFiscal: 601, 612, 626… */
|
|
7702
|
+
tax_system: string;
|
|
7703
|
+
/** Código postal del domicilio fiscal del cliente (DomicilioFiscalReceptor), 5 dígitos. */
|
|
7704
|
+
zip: string;
|
|
7705
|
+
/** Correo a donde se envía (varios separados por comas). Solo se usa si se pide enviarlo. */
|
|
7706
|
+
email?: string | null;
|
|
7707
|
+
/** Si es extranjero: su país de residencia (ResidenciaFiscal, c_Pais) y su número de registro tributario (NumRegIdTrib), con el RFC genérico XEXX010101000. */
|
|
7708
|
+
foreign?: {
|
|
7709
|
+
/** País de residencia fiscal, clave de 3 letras de c_Pais (USA, CAN…). */
|
|
7710
|
+
country: string;
|
|
7711
|
+
/** Número de registro de identidad fiscal en su país (NumRegIdTrib). */
|
|
7712
|
+
tax_id: string;
|
|
7713
|
+
};
|
|
7714
|
+
/** true si el cliente es contribuyente de IEPS: el IEPS va desglosado en vez de sumado al precio. */
|
|
7715
|
+
ieps_taxpayer?: boolean;
|
|
7716
|
+
};
|
|
7717
|
+
/** Los conceptos, como en POST /v1/invoices (hasta 200). */
|
|
7718
|
+
items?: {
|
|
7719
|
+
/** Un producto de su catálogo (prd_…): toma su clave, unidad, precio e impuestos. */
|
|
7720
|
+
product?: string;
|
|
7721
|
+
/** Descripción del concepto (Descripcion), hasta 1,000 caracteres. */
|
|
7722
|
+
description?: string;
|
|
7723
|
+
/** Clave del producto o servicio (ClaveProdServ), 8 dígitos de c_ClaveProdServ. Búsquela con GET /v1/sat_catalogs/product_keys?q=… */
|
|
7724
|
+
product_key?: string;
|
|
7725
|
+
/** Clave de unidad (ClaveUnidad) de c_ClaveUnidad: E48 unidad de servicio (por omisión), H87 pieza, ACT actividad… */
|
|
7726
|
+
unit_key?: string;
|
|
7727
|
+
/** Nombre de la unidad (Unidad), hasta 20 caracteres. */
|
|
7728
|
+
unit_name?: string | null;
|
|
7729
|
+
/** Número de identificación o SKU (NoIdentificacion). */
|
|
7730
|
+
sku?: string | null;
|
|
7731
|
+
/** Cantidad (Cantidad). Por omisión 1. */
|
|
7732
|
+
quantity?: number;
|
|
7733
|
+
/** Precio unitario antes de impuestos (ValorUnitario). */
|
|
7734
|
+
unit_price?: number;
|
|
7735
|
+
/** Descuento (Descuento). */
|
|
7736
|
+
discount?: number;
|
|
7737
|
+
/** Objeto de impuesto (ObjetoImp), c_ObjetoImp: 01 no objeto, 02 sí objeto (por omisión), 03 sin desglose, 04 no causa… */
|
|
7738
|
+
taxability?: "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08";
|
|
7739
|
+
/** Tasa de IVA trasladado: 0.16 (por omisión), 0.08 (región fronteriza), 0 o exento. */
|
|
7740
|
+
iva?: "0" | "0.16" | "0.08" | "exento";
|
|
7741
|
+
/** IEPS trasladado: tasa (0.265…) o cuota en pesos por unidad, según ieps_factor. */
|
|
7742
|
+
ieps?: number;
|
|
7743
|
+
/** Tasa o Cuota (TipoFactor del IEPS). */
|
|
7744
|
+
ieps_factor?: "Tasa" | "Cuota";
|
|
7745
|
+
/** Unidades de IEPS a cuota (litros, cigarros…), si no son la cantidad. */
|
|
7746
|
+
ieps_units?: number;
|
|
7747
|
+
/** Tasa de IVA retenido (por ejemplo 0.106667, dos terceras partes del 16%). */
|
|
7748
|
+
iva_retention?: number;
|
|
7749
|
+
/** Tasa de ISR retenido (por ejemplo 0.10 honorarios, 0.0125 RESICO). */
|
|
7750
|
+
isr_retention?: number;
|
|
7751
|
+
/** Números de cuenta predial (CuentaPredial) en arrendamiento. */
|
|
7752
|
+
predial?: string[];
|
|
7753
|
+
/** Números de pedimento (InformacionAduanera) de mercancía importada. */
|
|
7754
|
+
pedimentos?: string[];
|
|
7755
|
+
/** A cuenta de terceros (ACuentaTerceros): RFC, nombre, régimen y código postal. */
|
|
7756
|
+
third_party?: {
|
|
7757
|
+
/** RFC de a cuenta de quién (RfcACuentaTerceros). */
|
|
7758
|
+
tax_id: string;
|
|
7759
|
+
/** Nombre (NombreACuentaTerceros). */
|
|
7760
|
+
name: string;
|
|
7761
|
+
/** Régimen fiscal (RegimenFiscalACuentaTerceros), c_RegimenFiscal. */
|
|
7762
|
+
tax_system: string;
|
|
7763
|
+
/** Código postal de su domicilio fiscal (DomicilioFiscalACuentaTerceros). */
|
|
7764
|
+
zip: string;
|
|
7765
|
+
};
|
|
7766
|
+
/** Complemento de instituciones educativas privadas (IEDU): alumno, CURP, nivel y RVOE. */
|
|
7767
|
+
iedu?: {
|
|
7768
|
+
/** Nombre del alumno (nombreAlumno). */
|
|
7769
|
+
student_name: string;
|
|
7770
|
+
/** CURP, 18 caracteres. */
|
|
7771
|
+
curp: string;
|
|
7772
|
+
/** Nivel educativo (nivelEducativo). */
|
|
7773
|
+
level: "Preescolar" | "Primaria" | "Secundaria" | "Profesional técnico" | "Bachillerato o su equivalente";
|
|
7774
|
+
/** Reconocimiento de validez oficial de estudios (autRVOE). */
|
|
7775
|
+
rvoe: string;
|
|
7776
|
+
/** RFC de quien paga, si no es el receptor (rfcPago). */
|
|
7777
|
+
payer_tax_id?: string | null;
|
|
7778
|
+
};
|
|
7779
|
+
/** Complemento de vehículo usado. */
|
|
7780
|
+
used_vehicle?: {
|
|
7781
|
+
/** Monto de adquisición (montoAdquisicion). */
|
|
7782
|
+
purchase_amount: number;
|
|
7783
|
+
/** Monto de enajenación (montoEnajenacion). */
|
|
7784
|
+
sale_amount: number;
|
|
7785
|
+
/** Clave vehicular (claveVehicular). */
|
|
7786
|
+
vehicle_key: string;
|
|
7787
|
+
/** Marca (marca). */
|
|
7788
|
+
make: string;
|
|
7789
|
+
/** Tipo o versión (tipo). */
|
|
7790
|
+
type: string;
|
|
7791
|
+
/** Año del modelo (modelo), 4 dígitos. */
|
|
7792
|
+
model: string;
|
|
7793
|
+
/** Número de motor (numeroMotor). */
|
|
7794
|
+
engine_number?: string;
|
|
7795
|
+
/** Número de serie (numeroSerie). */
|
|
7796
|
+
serial_number?: string;
|
|
7797
|
+
/** Número de identificación vehicular (NIV). */
|
|
7798
|
+
niv?: string;
|
|
7799
|
+
/** Valor según la guía EBC o Libro Azul (valor). */
|
|
7800
|
+
guide_value: number;
|
|
7801
|
+
/** Información aduanera de la importación del vehículo (InformacionAduanera). */
|
|
7802
|
+
customs?: {
|
|
7803
|
+
/** Número del documento de importación (numero). */
|
|
7804
|
+
number: string;
|
|
7805
|
+
/** Fecha del documento (fecha), AAAA-MM-DD. */
|
|
7806
|
+
date: string;
|
|
7807
|
+
/** Aduana (aduana). */
|
|
7808
|
+
office?: string;
|
|
7809
|
+
}[];
|
|
7810
|
+
};
|
|
7811
|
+
/** Addenda del receptor (Walmart, Soriana…), con sus propios campos. */
|
|
7812
|
+
addenda?: Record<string, string>;
|
|
7813
|
+
}[];
|
|
7814
|
+
/** Moneda, clave ISO 4217 de c_Moneda (MXN, USD, EUR…). Por omisión MXN. */
|
|
7815
|
+
currency?: string;
|
|
7816
|
+
/** Tipo de cambio a pesos (TipoCambio). Obligatorio si la moneda no es MXN; use el del DOF del día anterior. */
|
|
7817
|
+
exchange_rate?: number;
|
|
7818
|
+
/** Forma de pago (FormaPago), clave de c_FormaPago: 01 efectivo, 03 transferencia, 04 tarjeta de crédito, 28 débito, 99 por definir… Obligatoria con PUE; con PPD es 99. */
|
|
7819
|
+
payment_form?: string;
|
|
7820
|
+
/** Método de pago (MetodoPago): PUE (una sola exhibición, por omisión) o PPD (en parcialidades o diferido, se cobra con complementos de pago). */
|
|
7821
|
+
payment_method?: "PUE" | "PPD";
|
|
7822
|
+
/** Uso del CFDI (UsoCFDI), clave de c_UsoCFDI. Por omisión G03, o S01 con régimen 616. */
|
|
7823
|
+
use?: string;
|
|
7824
|
+
/** Observaciones que aparecen en el PDF (no van en el XML). */
|
|
7825
|
+
notes?: string;
|
|
7826
|
+
/** El número de orden de compra de su cliente (va en la nota de cada factura). */
|
|
7827
|
+
customer_po?: string;
|
|
7828
|
+
/** A dónde mandarle el pedido y sus remisiones (hasta 5 correos, separados por comas). Por omisión, el del cliente. */
|
|
7829
|
+
email?: string;
|
|
7830
|
+
/** Entrega estimada (AAAA-MM-DD). */
|
|
7831
|
+
expected_on?: string;
|
|
7832
|
+
/** Días de crédito (0: de contado). */
|
|
7833
|
+
payment_days?: number;
|
|
7834
|
+
/** Qué se factura: delivered (por omisión), lo ya entregado; ordered, todo lo pedido desde el inicio (por ejemplo con pago por adelantado). */
|
|
7835
|
+
invoice_policy?: "delivered" | "ordered";
|
|
7836
|
+
/** Dónde se entrega. */
|
|
7837
|
+
ship_to?: string;
|
|
7838
|
+
/** Condiciones del pedido. */
|
|
7839
|
+
terms?: string;
|
|
7840
|
+
/** Nota interna (su cliente no la ve). */
|
|
7841
|
+
internal_note?: string;
|
|
7842
|
+
}
|
|
7843
|
+
export interface CreateSalesOrderDeliveryParams {
|
|
7844
|
+
/** Cuánto sale de cada concepto. Por omisión, todo lo que falta por entregar. */
|
|
7845
|
+
items?: {
|
|
7846
|
+
/** El id del concepto (items[].id). */
|
|
7847
|
+
line: number;
|
|
7848
|
+
/** Cantidad (Cantidad). Por omisión 1. */
|
|
7849
|
+
quantity: number;
|
|
7850
|
+
}[];
|
|
7851
|
+
/** Por omisión, hoy. */
|
|
7852
|
+
delivered_on?: string;
|
|
7853
|
+
/** Transporte. */
|
|
7854
|
+
carrier?: string;
|
|
7855
|
+
/** Número de guía. */
|
|
7856
|
+
tracking?: string;
|
|
7857
|
+
/** Una nota en la remisión. */
|
|
7858
|
+
note?: string;
|
|
7859
|
+
/** Quién recibió, si ya lo sabe (si no, su cliente lo firma en url). */
|
|
7860
|
+
received_by?: string;
|
|
7861
|
+
}
|
|
7862
|
+
export interface CancelSalesOrderDeliveryParams {
|
|
7863
|
+
/** Por qué (queda en el historial). */
|
|
7864
|
+
reason?: string;
|
|
7865
|
+
}
|
|
7866
|
+
export interface InvoiceSalesOrderParams {
|
|
7867
|
+
/** Cuánto facturar de cada concepto. Por omisión, lo entregado sin facturar (o todo lo pedido con invoice_policy ordered). */
|
|
7868
|
+
items?: {
|
|
7869
|
+
/** El id del concepto (items[].id). */
|
|
7870
|
+
line: number;
|
|
7871
|
+
/** Cantidad (Cantidad). Por omisión 1. */
|
|
7872
|
+
quantity: number;
|
|
7873
|
+
}[];
|
|
7874
|
+
/** Facturar también lo que aún no se entrega (con invoice_policy delivered). */
|
|
7875
|
+
include_undelivered?: boolean;
|
|
7876
|
+
/** Registrar también la entrega de lo que lleva la factura al timbrarla (venta de mostrador). */
|
|
7877
|
+
deliver?: boolean;
|
|
7878
|
+
}
|
|
7879
|
+
export interface SendSalesOrderParams {
|
|
7880
|
+
/** Mandarlo por correo, con su PDF y url (por omisión true). Con false solo contesta url, para que usted la mande. */
|
|
7881
|
+
send_email?: boolean;
|
|
7882
|
+
/** A quién (hasta 5 correos). Por omisión, el correo del pedido. */
|
|
7883
|
+
to?: string;
|
|
7884
|
+
/** Qué pasó y cómo corregirlo, para una persona. */
|
|
7885
|
+
message?: string;
|
|
7886
|
+
}
|
|
7887
|
+
export interface CloseSalesOrderParams {
|
|
7888
|
+
/** Por qué (queda en el historial). */
|
|
7889
|
+
reason?: string;
|
|
7890
|
+
}
|
|
7891
|
+
export interface CancelSalesOrderParams {
|
|
7892
|
+
/** Por qué (queda en el historial). */
|
|
7893
|
+
reason?: string;
|
|
7894
|
+
}
|
|
7895
|
+
export interface CreateWebhookEndpointParams {
|
|
7896
|
+
/** Dirección https de su servidor que recibe los avisos. */
|
|
7897
|
+
url: string;
|
|
7898
|
+
/** Eventos que quiere recibir, o ["*"] para todos (por omisión). La lista con cuándo llega cada uno: [Tipos de evento](https://fiscalisto.com/docs/api/webhooks#tipos-de-evento). */
|
|
7899
|
+
events?: string[] | null;
|
|
7900
|
+
/** Para qué es, para usted (no se manda en los eventos). */
|
|
7901
|
+
description?: string | null;
|
|
7902
|
+
/** La versión de la API en que llegan sus eventos (por ejemplo 2026-10-24); null o sin mandar: la de la cuenta. Así actualiza un endpoint a la vez. */
|
|
6743
7903
|
api_version?: string | null;
|
|
6744
7904
|
}
|
|
6745
7905
|
/** Los parámetros de GET /v1/webhook_endpoints. */
|
|
@@ -6767,7 +7927,7 @@ export interface RollWebhookSecretParams {
|
|
|
6767
7927
|
}
|
|
6768
7928
|
export interface TestWebhookEndpointParams {
|
|
6769
7929
|
/** El evento a mandar. Por omisión invoice.stamped. */
|
|
6770
|
-
type?: "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "invoice.email_bounced" | "invoice.email_complained" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "payroll_batch.completed" | "customer_data_request.completed" | "sat_download.completed" | "sat_download.failed" | "sat_declaration.created" | "sat_declaration.updated" | "ticket.invoiced" | "ticket.included_in_global" | "recurring_invoice.failed" | "quote.viewed" | "quote.accepted" | "quote.changes_requested" | "quote.rejected" | "quote.withdrawn" | "issuer.ready" | "balance.low" | "test_clock.ready";
|
|
7930
|
+
type?: "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "invoice.email_bounced" | "invoice.email_complained" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "payroll_batch.completed" | "customer_data_request.completed" | "sat_download.completed" | "sat_download.failed" | "sat_declaration.created" | "sat_declaration.updated" | "ticket.invoiced" | "ticket.included_in_global" | "recurring_invoice.failed" | "quote.viewed" | "quote.accepted" | "quote.changes_requested" | "quote.rejected" | "quote.withdrawn" | "sales_order.confirmed" | "sales_order.customer_confirmed" | "sales_order.delivered" | "sales_order.paid" | "sales_order.canceled" | "issuer.ready" | "balance.low" | "test_clock.ready";
|
|
6771
7931
|
}
|
|
6772
7932
|
/** Los parámetros de GET /v1/events. */
|
|
6773
7933
|
export interface ListEventsParams {
|
|
@@ -6776,7 +7936,7 @@ export interface ListEventsParams {
|
|
|
6776
7936
|
/** El id del último de la página anterior, para la siguiente. */
|
|
6777
7937
|
starting_after?: string;
|
|
6778
7938
|
/** Solo de este tipo (invoice.stamped), o todos los de un recurso con un comodín (invoice.*). */
|
|
6779
|
-
type?: "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "invoice.email_bounced" | "invoice.email_complained" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "payroll_batch.completed" | "customer_data_request.completed" | "sat_download.completed" | "sat_download.failed" | "sat_declaration.created" | "sat_declaration.updated" | "ticket.invoiced" | "ticket.included_in_global" | "recurring_invoice.failed" | "quote.viewed" | "quote.accepted" | "quote.changes_requested" | "quote.rejected" | "quote.withdrawn" | "issuer.ready" | "balance.low" | "test_clock.ready" | "invoice.*" | "invoice_batch.*" | "payroll_batch.*" | "recurring_invoice.*" | "quote.*" | "ticket.*" | "retention.*" | "customer_data_request.*" | "sat_download.*" | "sat_declaration.*" | "issuer.*" | "balance.*" | "test_clock.*";
|
|
7939
|
+
type?: "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "invoice.email_bounced" | "invoice.email_complained" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "payroll_batch.completed" | "customer_data_request.completed" | "sat_download.completed" | "sat_download.failed" | "sat_declaration.created" | "sat_declaration.updated" | "ticket.invoiced" | "ticket.included_in_global" | "recurring_invoice.failed" | "quote.viewed" | "quote.accepted" | "quote.changes_requested" | "quote.rejected" | "quote.withdrawn" | "sales_order.confirmed" | "sales_order.customer_confirmed" | "sales_order.delivered" | "sales_order.paid" | "sales_order.canceled" | "issuer.ready" | "balance.low" | "test_clock.ready" | "invoice.*" | "invoice_batch.*" | "payroll_batch.*" | "recurring_invoice.*" | "quote.*" | "sales_order.*" | "ticket.*" | "retention.*" | "customer_data_request.*" | "sat_download.*" | "sat_declaration.*" | "issuer.*" | "balance.*" | "test_clock.*";
|
|
6780
7940
|
/** Solo los de este objeto (inv_…, ret_…, bat_…). */
|
|
6781
7941
|
object?: string;
|
|
6782
7942
|
/** false: los que algún webhook no recibió (su último intento falló). true: los que recibieron todos los webhooks a los que se mandaron. */
|
|
@@ -7200,6 +8360,65 @@ export declare class ReceivablesResource {
|
|
|
7200
8360
|
*/
|
|
7201
8361
|
list(params?: ListReceivablesParams, options?: RequestOptions): List<Receivable>;
|
|
7202
8362
|
}
|
|
8363
|
+
/** Cuentas por cobrar: fiscalisto.customers. */
|
|
8364
|
+
export declare class CustomersResource {
|
|
8365
|
+
#private;
|
|
8366
|
+
constructor(client: Client);
|
|
8367
|
+
/**
|
|
8368
|
+
* Ver cómo paga un cliente
|
|
8369
|
+
*
|
|
8370
|
+
* Cuántos días tarda en pagar, qué parte llega a tiempo con sus días de crédito, si paga más lento que antes, cómo le paga y cuándo le llegaría lo que debe. De sus facturas a crédito (PPD) de los últimos 12 meses y sus complementos de pago, como «Cómo paga» en la app. No aplica a XAXX010101000 ni XEXX010101000.
|
|
8371
|
+
*
|
|
8372
|
+
* GET /v1/customers/{id}/payment_behavior
|
|
8373
|
+
* @see https://fiscalisto.com/docs/api/referencia/cuentas-por-cobrar/get-customer-payment-behavior
|
|
8374
|
+
*/
|
|
8375
|
+
paymentBehavior(id: string, options?: RequestOptions): Promise<CustomerPaymentBehavior>;
|
|
8376
|
+
/**
|
|
8377
|
+
* Crear un cliente
|
|
8378
|
+
*
|
|
8379
|
+
* Un cliente del catálogo del emisor, con sus datos fiscales como vienen en su constancia. Un RFC que ya está en el catálogo contesta customer_exists.
|
|
8380
|
+
*
|
|
8381
|
+
* POST /v1/customers
|
|
8382
|
+
* @see https://fiscalisto.com/docs/api/referencia/clientes/create-customer
|
|
8383
|
+
*/
|
|
8384
|
+
create(params: CreateCustomerParams, options?: RequestOptions): Promise<Customer>;
|
|
8385
|
+
/**
|
|
8386
|
+
* Listar clientes
|
|
8387
|
+
*
|
|
8388
|
+
* Los clientes del emisor, los más recientes primero. Con tax_id, el de ese RFC.
|
|
8389
|
+
*
|
|
8390
|
+
* GET /v1/customers
|
|
8391
|
+
* @see https://fiscalisto.com/docs/api/referencia/clientes/list-customers
|
|
8392
|
+
*/
|
|
8393
|
+
list(params?: ListCustomersParams, options?: RequestOptions): List<Customer>;
|
|
8394
|
+
/**
|
|
8395
|
+
* Ver un cliente
|
|
8396
|
+
*
|
|
8397
|
+
* Un cliente del catálogo.
|
|
8398
|
+
*
|
|
8399
|
+
* GET /v1/customers/{id}
|
|
8400
|
+
* @see https://fiscalisto.com/docs/api/referencia/clientes/get-customer
|
|
8401
|
+
*/
|
|
8402
|
+
get(id: string, options?: RequestOptions): Promise<Customer>;
|
|
8403
|
+
/**
|
|
8404
|
+
* Actualizar un cliente
|
|
8405
|
+
*
|
|
8406
|
+
* Cambia solo los campos que manda. Las facturas ya timbradas no cambian.
|
|
8407
|
+
*
|
|
8408
|
+
* POST /v1/customers/{id}
|
|
8409
|
+
* @see https://fiscalisto.com/docs/api/referencia/clientes/update-customer
|
|
8410
|
+
*/
|
|
8411
|
+
update(id: string, params?: UpdateCustomerParams, options?: RequestOptions): Promise<Customer>;
|
|
8412
|
+
/**
|
|
8413
|
+
* Borrar un cliente
|
|
8414
|
+
*
|
|
8415
|
+
* Lo quita del catálogo. Sus facturas timbradas siguen igual.
|
|
8416
|
+
*
|
|
8417
|
+
* DELETE /v1/customers/{id}
|
|
8418
|
+
* @see https://fiscalisto.com/docs/api/referencia/clientes/delete-customer
|
|
8419
|
+
*/
|
|
8420
|
+
delete(id: string, options?: RequestOptions): Promise<Deleted>;
|
|
8421
|
+
}
|
|
7203
8422
|
/** Conciliación bancaria: fiscalisto.bankTransactions. */
|
|
7204
8423
|
export declare class BankTransactionsResource {
|
|
7205
8424
|
#private;
|
|
@@ -7829,55 +9048,218 @@ export declare class CostCentersResource {
|
|
|
7829
9048
|
*/
|
|
7830
9049
|
delete(id: string, params?: DeleteCostCenterParams, options?: RequestOptions): Promise<Deleted>;
|
|
7831
9050
|
}
|
|
7832
|
-
/**
|
|
7833
|
-
export declare class
|
|
9051
|
+
/** Viáticos y gastos: fiscalisto.expensePeople. */
|
|
9052
|
+
export declare class ExpensePeopleResource {
|
|
7834
9053
|
#private;
|
|
7835
9054
|
constructor(client: Client);
|
|
7836
9055
|
/**
|
|
7837
|
-
*
|
|
9056
|
+
* Agregar a una persona
|
|
7838
9057
|
*
|
|
7839
|
-
*
|
|
9058
|
+
* Alguien que viaja o gasta por el emisor: un empleado (employee, emp_…: sus anticipos y reembolsos «En la nómina» van en su siguiente recibo) o alguien por honorarios (name y tax_id). Con email, Fiscalisto le puede mandar su enlace.
|
|
7840
9059
|
*
|
|
7841
|
-
* POST /v1/
|
|
7842
|
-
* @see https://fiscalisto.com/docs/api/referencia/
|
|
9060
|
+
* POST /v1/expense_people
|
|
9061
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/create-expense-person
|
|
7843
9062
|
*/
|
|
7844
|
-
create(params:
|
|
9063
|
+
create(params: CreateExpensePersonParams, options?: RequestOptions): Promise<ExpensePerson>;
|
|
7845
9064
|
/**
|
|
7846
|
-
* Listar
|
|
9065
|
+
* Listar personas
|
|
7847
9066
|
*
|
|
7848
|
-
*
|
|
9067
|
+
* Las personas que comprueban gastos del emisor, las más recientes primero. Las archivadas solo con include_archived=true.
|
|
7849
9068
|
*
|
|
7850
|
-
* GET /v1/
|
|
7851
|
-
* @see https://fiscalisto.com/docs/api/referencia/
|
|
9069
|
+
* GET /v1/expense_people
|
|
9070
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/list-expense-people
|
|
7852
9071
|
*/
|
|
7853
|
-
list(params?:
|
|
9072
|
+
list(params?: ListExpensePeopleParams, options?: RequestOptions): List<ExpensePerson>;
|
|
7854
9073
|
/**
|
|
7855
|
-
* Ver
|
|
9074
|
+
* Ver una persona
|
|
7856
9075
|
*
|
|
7857
|
-
*
|
|
9076
|
+
* Una persona que comprueba gastos del emisor.
|
|
7858
9077
|
*
|
|
7859
|
-
* GET /v1/
|
|
7860
|
-
* @see https://fiscalisto.com/docs/api/referencia/
|
|
9078
|
+
* GET /v1/expense_people/{id}
|
|
9079
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/get-expense-person
|
|
7861
9080
|
*/
|
|
7862
|
-
get(id: string, options?: RequestOptions): Promise<
|
|
9081
|
+
get(id: string, options?: RequestOptions): Promise<ExpensePerson>;
|
|
7863
9082
|
/**
|
|
7864
|
-
* Actualizar
|
|
9083
|
+
* Actualizar una persona
|
|
7865
9084
|
*
|
|
7866
|
-
* Cambia solo
|
|
9085
|
+
* Cambia solo lo que manda. archived: true la archiva (ya no se le abren comprobaciones y su enlace deja de funcionar), false la restaura.
|
|
7867
9086
|
*
|
|
7868
|
-
* POST /v1/
|
|
7869
|
-
* @see https://fiscalisto.com/docs/api/referencia/
|
|
9087
|
+
* POST /v1/expense_people/{id}
|
|
9088
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/update-expense-person
|
|
7870
9089
|
*/
|
|
7871
|
-
update(id: string, params?:
|
|
9090
|
+
update(id: string, params?: UpdateExpensePersonParams, options?: RequestOptions): Promise<ExpensePerson>;
|
|
7872
9091
|
/**
|
|
7873
|
-
*
|
|
9092
|
+
* Dar su enlace a una persona
|
|
7874
9093
|
*
|
|
7875
|
-
*
|
|
9094
|
+
* El enlace donde la persona ve solo sus comprobaciones y sube sus facturas desde el teléfono, sin cuenta. Con renew: true le da uno nuevo y el anterior deja de funcionar.
|
|
7876
9095
|
*
|
|
7877
|
-
*
|
|
7878
|
-
* @see https://fiscalisto.com/docs/api/referencia/
|
|
9096
|
+
* POST /v1/expense_people/{id}/link
|
|
9097
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/create-expense-person-link
|
|
9098
|
+
*/
|
|
9099
|
+
createLink(id: string, params?: CreateExpensePersonLinkParams, options?: RequestOptions): Promise<ExpensePersonLink>;
|
|
9100
|
+
/**
|
|
9101
|
+
* Apagar el enlace de una persona
|
|
9102
|
+
*
|
|
9103
|
+
* Su enlace deja de funcionar (url: null). Puede darle uno nuevo después con POST /v1/expense_people/{id}/link.
|
|
9104
|
+
*
|
|
9105
|
+
* DELETE /v1/expense_people/{id}/link
|
|
9106
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/delete-expense-person-link
|
|
9107
|
+
*/
|
|
9108
|
+
deleteLink(id: string, options?: RequestOptions): Promise<ExpensePersonLink>;
|
|
9109
|
+
}
|
|
9110
|
+
/** Viáticos y gastos: fiscalisto.expenseReports. */
|
|
9111
|
+
export declare class ExpenseReportsResource {
|
|
9112
|
+
#private;
|
|
9113
|
+
constructor(client: Client);
|
|
9114
|
+
/**
|
|
9115
|
+
* Abrir una comprobación
|
|
9116
|
+
*
|
|
9117
|
+
* Una por viaje (kind viaje) o una por periodo de gastos de oficina que la empresa reembolsa (kind gastos). Queda abierta (draft): se le agregan gastos y anticipos, y se envía con POST /v1/expense_reports/{id}/submit.
|
|
9118
|
+
*
|
|
9119
|
+
* POST /v1/expense_reports
|
|
9120
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/create-expense-report
|
|
9121
|
+
*/
|
|
9122
|
+
create(params: CreateExpenseReportParams, options?: RequestOptions): Promise<ExpenseReport>;
|
|
9123
|
+
/**
|
|
9124
|
+
* Listar comprobaciones
|
|
9125
|
+
*
|
|
9126
|
+
* Las comprobaciones del emisor, las más recientes primero, con sus gastos y movimientos.
|
|
9127
|
+
*
|
|
9128
|
+
* GET /v1/expense_reports
|
|
9129
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/list-expense-reports
|
|
9130
|
+
*/
|
|
9131
|
+
list(params?: ListExpenseReportsParams, options?: RequestOptions): List<ExpenseReport>;
|
|
9132
|
+
/**
|
|
9133
|
+
* Ver una comprobación
|
|
9134
|
+
*
|
|
9135
|
+
* Una comprobación con sus gastos, lo deducible de cada uno, sus avisos (issues) contra la ley y la política, y su saldo.
|
|
9136
|
+
*
|
|
9137
|
+
* GET /v1/expense_reports/{id}
|
|
9138
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/get-expense-report
|
|
9139
|
+
*/
|
|
9140
|
+
get(id: string, options?: RequestOptions): Promise<ExpenseReport>;
|
|
9141
|
+
/**
|
|
9142
|
+
* Actualizar una comprobación
|
|
9143
|
+
*
|
|
9144
|
+
* Cambia solo lo que manda: su nombre, el propósito, el destino y las fechas. Mientras no esté aprobada.
|
|
9145
|
+
*
|
|
9146
|
+
* POST /v1/expense_reports/{id}
|
|
9147
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/update-expense-report
|
|
9148
|
+
*/
|
|
9149
|
+
update(id: string, params?: UpdateExpenseReportParams, options?: RequestOptions): Promise<ExpenseReport>;
|
|
9150
|
+
/**
|
|
9151
|
+
* Borrar una comprobación
|
|
9152
|
+
*
|
|
9153
|
+
* Una que no esté aprobada y no tenga anticipos ni pagos (quítelos antes). No se puede deshacer.
|
|
9154
|
+
*
|
|
9155
|
+
* DELETE /v1/expense_reports/{id}
|
|
9156
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/delete-expense-report
|
|
7879
9157
|
*/
|
|
7880
9158
|
delete(id: string, options?: RequestOptions): Promise<Deleted>;
|
|
9159
|
+
/**
|
|
9160
|
+
* Enviar a aprobar
|
|
9161
|
+
*
|
|
9162
|
+
* La persona termina: pasa a submitted (por aprobar). Contesta expense_report_invalid si un gasto tiene un error (issues con level error).
|
|
9163
|
+
*
|
|
9164
|
+
* POST /v1/expense_reports/{id}/submit
|
|
9165
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/submit-expense-report
|
|
9166
|
+
*/
|
|
9167
|
+
submit(id: string, options?: RequestOptions): Promise<ExpenseReport>;
|
|
9168
|
+
/**
|
|
9169
|
+
* Aprobar una comprobación
|
|
9170
|
+
*
|
|
9171
|
+
* Pasa a approved (por liquidar): sus facturas se deducen en los impuestos del emisor y entra en las pólizas contra 107.01 Funcionarios y empleados. Con el saldo en cero se cierra sola; si no, liquide con un reembolso o una devolución.
|
|
9172
|
+
*
|
|
9173
|
+
* POST /v1/expense_reports/{id}/approve
|
|
9174
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/approve-expense-report
|
|
9175
|
+
*/
|
|
9176
|
+
approve(id: string, params?: ApproveExpenseReportParams, options?: RequestOptions): Promise<ExpenseReport>;
|
|
9177
|
+
/**
|
|
9178
|
+
* Devolver para corregir
|
|
9179
|
+
*
|
|
9180
|
+
* Regresa a la persona (rejected, «Devuelta») con una nota de qué corregir. La corrige y la vuelve a enviar.
|
|
9181
|
+
*
|
|
9182
|
+
* POST /v1/expense_reports/{id}/return
|
|
9183
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/return-expense-report
|
|
9184
|
+
*/
|
|
9185
|
+
sendBack(id: string, params: ReturnExpenseReportParams, options?: RequestOptions): Promise<ExpenseReport>;
|
|
9186
|
+
/**
|
|
9187
|
+
* Reabrir una comprobación
|
|
9188
|
+
*
|
|
9189
|
+
* Una aprobada vuelve a abierta: sus facturas dejan de deducirse y sale de las pólizas. No si ya se reportó en la nómina.
|
|
9190
|
+
*
|
|
9191
|
+
* POST /v1/expense_reports/{id}/reopen
|
|
9192
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/reopen-expense-report
|
|
9193
|
+
*/
|
|
9194
|
+
reopen(id: string, options?: RequestOptions): Promise<ExpenseReport>;
|
|
9195
|
+
/**
|
|
9196
|
+
* Agregar un gasto
|
|
9197
|
+
*
|
|
9198
|
+
* Con uuid, una factura recibida del emisor (GET /v1/sat_invoices): la fecha, el monto y el proveedor salen de ella. Sin uuid, un gasto con su category, date y amount (un ticket, un comprobante del extranjero). Contesta la comprobación revisada.
|
|
9199
|
+
*
|
|
9200
|
+
* POST /v1/expense_reports/{id}/items
|
|
9201
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/create-expense-item
|
|
9202
|
+
*/
|
|
9203
|
+
createItem(id: string, params: CreateExpenseItemParams, options?: RequestOptions): Promise<ExpenseReport>;
|
|
9204
|
+
/**
|
|
9205
|
+
* Actualizar un gasto
|
|
9206
|
+
*
|
|
9207
|
+
* Cambia solo lo que manda. Al revisarla, rejected: true con reject_reason rechaza el gasto (no se paga ni se deduce) y false lo vuelve a incluir.
|
|
9208
|
+
*
|
|
9209
|
+
* POST /v1/expense_reports/{id}/items/{item}
|
|
9210
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/update-expense-item
|
|
9211
|
+
*/
|
|
9212
|
+
updateItem(id: string, item: string, params?: UpdateExpenseItemParams, options?: RequestOptions): Promise<ExpenseReport>;
|
|
9213
|
+
/**
|
|
9214
|
+
* Quitar un gasto
|
|
9215
|
+
*
|
|
9216
|
+
* Lo quita de la comprobación mientras no esté aprobada. Contesta la comprobación.
|
|
9217
|
+
*
|
|
9218
|
+
* DELETE /v1/expense_reports/{id}/items/{item}
|
|
9219
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/delete-expense-item
|
|
9220
|
+
*/
|
|
9221
|
+
deleteItem(id: string, item: string, options?: RequestOptions): Promise<ExpenseReport>;
|
|
9222
|
+
/**
|
|
9223
|
+
* Registrar dinero dado o devuelto
|
|
9224
|
+
*
|
|
9225
|
+
* Un anticipo (antes de aprobarla), un reembolso o una devolución (ya aprobada). Con method nomina va en el siguiente recibo de nómina del empleado. Con el saldo en cero, una aprobada se cierra.
|
|
9226
|
+
*
|
|
9227
|
+
* POST /v1/expense_reports/{id}/movements
|
|
9228
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/create-expense-movement
|
|
9229
|
+
*/
|
|
9230
|
+
createMovement(id: string, params: CreateExpenseMovementParams, options?: RequestOptions): Promise<ExpenseReport>;
|
|
9231
|
+
/**
|
|
9232
|
+
* Deshacer un movimiento
|
|
9233
|
+
*
|
|
9234
|
+
* Lo quita (una cerrada vuelve a por liquidar). No uno que ya se pagó en la nómina.
|
|
9235
|
+
*
|
|
9236
|
+
* DELETE /v1/expense_reports/{id}/movements/{movement}
|
|
9237
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/delete-expense-movement
|
|
9238
|
+
*/
|
|
9239
|
+
deleteMovement(id: string, movement: string, options?: RequestOptions): Promise<ExpenseReport>;
|
|
9240
|
+
}
|
|
9241
|
+
/** Viáticos y gastos: fiscalisto.expensePolicy. */
|
|
9242
|
+
export declare class ExpensePolicyResource {
|
|
9243
|
+
#private;
|
|
9244
|
+
constructor(client: Client);
|
|
9245
|
+
/**
|
|
9246
|
+
* Ver la política
|
|
9247
|
+
*
|
|
9248
|
+
* La política de viáticos y gastos del emisor: topes por categoría, hasta cuánto sin factura y los días para comprobar.
|
|
9249
|
+
*
|
|
9250
|
+
* GET /v1/expense_policy
|
|
9251
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/get-expense-policy
|
|
9252
|
+
*/
|
|
9253
|
+
get(params?: GetExpensePolicyParams, options?: RequestOptions): Promise<ExpensePolicy>;
|
|
9254
|
+
/**
|
|
9255
|
+
* Cambiar la política
|
|
9256
|
+
*
|
|
9257
|
+
* Cambia solo lo que manda; en limits, una categoría con null deja de tener tope. Un gasto que pasa un tope no se rechaza: se marca para quien aprueba.
|
|
9258
|
+
*
|
|
9259
|
+
* POST /v1/expense_policy
|
|
9260
|
+
* @see https://fiscalisto.com/docs/api/referencia/viaticos-y-gastos/update-expense-policy
|
|
9261
|
+
*/
|
|
9262
|
+
update(params?: UpdateExpensePolicyParams, options?: RequestOptions): Promise<ExpensePolicy>;
|
|
7881
9263
|
}
|
|
7882
9264
|
/** Clientes: fiscalisto.customerDataRequests. */
|
|
7883
9265
|
export declare class CustomerDataRequestsResource {
|
|
@@ -8385,6 +9767,15 @@ export declare class AccountingResource {
|
|
|
8385
9767
|
* @see https://fiscalisto.com/docs/api/referencia/contabilidad/get-cross-checks
|
|
8386
9768
|
*/
|
|
8387
9769
|
crossChecks(params?: GetCrossChecksParams, options?: RequestOptions): Promise<CrossChecks>;
|
|
9770
|
+
/**
|
|
9771
|
+
* Ver el IVA a favor y preparar su devolución
|
|
9772
|
+
*
|
|
9773
|
+
* El IVA a favor de cada mes de los últimos cinco años (de las declaraciones leídas con POST /v1/sat_declarations/refresh o, sin ellas, de sus CFDI, con estimated en true), cuánto se acreditó después (del saldo más antiguo primero), cuánto queda, qué está en devolución y cuándo prescribe. Con `month`, la revisión de ese mes antes de pedirlo en el SAT: declaración, cruce con CFDI, DIOT, opinión de cumplimiento, Buzón Tributario, e.firma, listas del SAT, CFDI de proveedores con hallazgos y CLABE, con el monto a pedir. No presenta nada en el SAT. Gratis.
|
|
9774
|
+
*
|
|
9775
|
+
* GET /v1/accounting/vat_refund
|
|
9776
|
+
* @see https://fiscalisto.com/docs/api/referencia/contabilidad/get-vat-refund
|
|
9777
|
+
*/
|
|
9778
|
+
vatRefund(params?: GetVatRefundParams, options?: RequestOptions): Promise<VatRefund>;
|
|
8388
9779
|
/**
|
|
8389
9780
|
* Ver los CFDI de una cifra del cruce
|
|
8390
9781
|
*
|
|
@@ -8662,6 +10053,146 @@ export declare class QuotesResource {
|
|
|
8662
10053
|
*/
|
|
8663
10054
|
pdf(id: string, options?: RequestOptions): Promise<Uint8Array>;
|
|
8664
10055
|
}
|
|
10056
|
+
/** Pedidos: fiscalisto.salesOrders. */
|
|
10057
|
+
export declare class SalesOrdersResource {
|
|
10058
|
+
#private;
|
|
10059
|
+
constructor(client: Client);
|
|
10060
|
+
/**
|
|
10061
|
+
* Crear un pedido
|
|
10062
|
+
*
|
|
10063
|
+
* Lo que su cliente le pidió, con los conceptos y las condiciones de pago de una factura (se revisan con las mismas reglas, así que cada factura que sale de él timbra). customer es un cliente de su catálogo o uno con sus datos fiscales (se agrega a sus clientes). Con quote (quo_…) lo hace de una cotización. Queda en draft, o confirmado con confirm: true (llega sales_order.confirmed y se aparta lo pedido en el almacén).
|
|
10064
|
+
*
|
|
10065
|
+
* POST /v1/sales_orders
|
|
10066
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/create-sales-order
|
|
10067
|
+
*/
|
|
10068
|
+
create(params?: CreateSalesOrderParams, options?: RequestOptions): Promise<SalesOrder>;
|
|
10069
|
+
/**
|
|
10070
|
+
* Listar pedidos
|
|
10071
|
+
*
|
|
10072
|
+
* Los más recientes primero.
|
|
10073
|
+
*
|
|
10074
|
+
* GET /v1/sales_orders
|
|
10075
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/list-sales-orders
|
|
10076
|
+
*/
|
|
10077
|
+
list(params?: ListSalesOrdersParams, options?: RequestOptions): List<SalesOrder>;
|
|
10078
|
+
/**
|
|
10079
|
+
* Ver un pedido
|
|
10080
|
+
*
|
|
10081
|
+
* Con sus entregas, sus facturas y lo que se ha pagado de ellas.
|
|
10082
|
+
*
|
|
10083
|
+
* GET /v1/sales_orders/{id}
|
|
10084
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/get-sales-order
|
|
10085
|
+
*/
|
|
10086
|
+
get(id: string, options?: RequestOptions): Promise<SalesOrder>;
|
|
10087
|
+
/**
|
|
10088
|
+
* Cambiar un pedido
|
|
10089
|
+
*
|
|
10090
|
+
* Solo lo que mande cambia. Los conceptos cambian mientras no tengan entregas ni facturas; si no, 400 sales_order_invalid.
|
|
10091
|
+
*
|
|
10092
|
+
* POST /v1/sales_orders/{id}
|
|
10093
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/update-sales-order
|
|
10094
|
+
*/
|
|
10095
|
+
update(id: string, params?: UpdateSalesOrderParams, options?: RequestOptions): Promise<SalesOrder>;
|
|
10096
|
+
/**
|
|
10097
|
+
* Borrar un pedido
|
|
10098
|
+
*
|
|
10099
|
+
* Solo un borrador. Uno confirmado se cancela con POST /v1/sales_orders/{id}/cancel: 400 sales_order_not_deletable.
|
|
10100
|
+
*
|
|
10101
|
+
* DELETE /v1/sales_orders/{id}
|
|
10102
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/delete-sales-order
|
|
10103
|
+
*/
|
|
10104
|
+
delete(id: string, options?: RequestOptions): Promise<Deleted>;
|
|
10105
|
+
/**
|
|
10106
|
+
* Confirmar un pedido
|
|
10107
|
+
*
|
|
10108
|
+
* Es un pedido en firme: se aparta lo pedido en el almacén y ya se puede entregar y facturar. Llega sales_order.confirmed.
|
|
10109
|
+
*
|
|
10110
|
+
* POST /v1/sales_orders/{id}/confirm
|
|
10111
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/confirm-sales-order
|
|
10112
|
+
*/
|
|
10113
|
+
confirm(id: string, options?: RequestOptions): Promise<SalesOrder>;
|
|
10114
|
+
/**
|
|
10115
|
+
* Registrar una entrega
|
|
10116
|
+
*
|
|
10117
|
+
* Lo que salió, con su remisión (REM-1, REM-2…): la mercancía sale del almacén con la entrega, no con la factura. Por omisión, todo lo que falta. Si el emisor no vende sin existencias, no sale más de lo que hay (400 sales_order_invalid). Cuando ya salió todo llega sales_order.delivered.
|
|
10118
|
+
*
|
|
10119
|
+
* POST /v1/sales_orders/{id}/deliveries
|
|
10120
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/create-sales-order-delivery
|
|
10121
|
+
*/
|
|
10122
|
+
deliver(id: string, params?: CreateSalesOrderDeliveryParams, options?: RequestOptions): Promise<SalesOrder>;
|
|
10123
|
+
/**
|
|
10124
|
+
* Cancelar una entrega
|
|
10125
|
+
*
|
|
10126
|
+
* La mercancía regresa al almacén y lo entregado vuelve a quedar pendiente.
|
|
10127
|
+
*
|
|
10128
|
+
* POST /v1/sales_orders/{id}/deliveries/{delivery}/cancel
|
|
10129
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/cancel-sales-order-delivery
|
|
10130
|
+
*/
|
|
10131
|
+
cancelDelivery(id: string, delivery: string, params?: CancelSalesOrderDeliveryParams, options?: RequestOptions): Promise<SalesOrder>;
|
|
10132
|
+
/**
|
|
10133
|
+
* Facturar un pedido
|
|
10134
|
+
*
|
|
10135
|
+
* Timbra una factura con lo entregado y no facturado (o lo que diga items; con invoice_policy ordered, lo pedido), con los datos fiscales del cliente de hoy y la nota «Pedido PED-…» con su orden de compra. Se factura en varias partes: cada llamada, con su Idempotency-Key, timbra la que sigue. Si no queda nada, 400 sales_order_invalid. Cuando sus facturas se pagan llega sales_order.paid.
|
|
10136
|
+
*
|
|
10137
|
+
* POST /v1/sales_orders/{id}/invoice
|
|
10138
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/invoice-sales-order
|
|
10139
|
+
*/
|
|
10140
|
+
invoice(id: string, params?: InvoiceSalesOrderParams, options?: RequestOptions): Promise<Invoice>;
|
|
10141
|
+
/**
|
|
10142
|
+
* Mandar un pedido
|
|
10143
|
+
*
|
|
10144
|
+
* Por correo, con su PDF y la liga donde su cliente lo confirma (llega sales_order.customer_confirmed), firma cada entrega y abre sus facturas. Con send_email: false solo contesta url. En borrador, 400 sales_order_draft.
|
|
10145
|
+
*
|
|
10146
|
+
* POST /v1/sales_orders/{id}/send
|
|
10147
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/send-sales-order
|
|
10148
|
+
*/
|
|
10149
|
+
send(id: string, params?: SendSalesOrderParams, options?: RequestOptions): Promise<SalesOrder>;
|
|
10150
|
+
/**
|
|
10151
|
+
* Ya no entregar lo pendiente
|
|
10152
|
+
*
|
|
10153
|
+
* El pedido se queda con lo ya entregado (lo demás pasa a canceled en cada concepto) y se libera lo apartado.
|
|
10154
|
+
*
|
|
10155
|
+
* POST /v1/sales_orders/{id}/cancel_remaining
|
|
10156
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/cancel-sales-order-remaining
|
|
10157
|
+
*/
|
|
10158
|
+
cancelRemaining(id: string, options?: RequestOptions): Promise<SalesOrder>;
|
|
10159
|
+
/**
|
|
10160
|
+
* Cerrar un pedido
|
|
10161
|
+
*
|
|
10162
|
+
* Lo da por terminado aunque quede algo pendiente, y libera lo apartado.
|
|
10163
|
+
*
|
|
10164
|
+
* POST /v1/sales_orders/{id}/close
|
|
10165
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/close-sales-order
|
|
10166
|
+
*/
|
|
10167
|
+
close(id: string, params?: CloseSalesOrderParams, options?: RequestOptions): Promise<SalesOrder>;
|
|
10168
|
+
/**
|
|
10169
|
+
* Cancelar un pedido
|
|
10170
|
+
*
|
|
10171
|
+
* Solo sin entregas ni facturas timbradas (cancele primero las entregas, y las facturas con POST /v1/invoices/{id}/cancel). Borra sus facturas en borrador y libera lo apartado. Llega sales_order.canceled.
|
|
10172
|
+
*
|
|
10173
|
+
* POST /v1/sales_orders/{id}/cancel
|
|
10174
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/cancel-sales-order
|
|
10175
|
+
*/
|
|
10176
|
+
cancel(id: string, params?: CancelSalesOrderParams, options?: RequestOptions): Promise<SalesOrder>;
|
|
10177
|
+
/**
|
|
10178
|
+
* Reabrir un pedido
|
|
10179
|
+
*
|
|
10180
|
+
* Uno cerrado o cancelado vuelve a estar abierto.
|
|
10181
|
+
*
|
|
10182
|
+
* POST /v1/sales_orders/{id}/reopen
|
|
10183
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/reopen-sales-order
|
|
10184
|
+
*/
|
|
10185
|
+
reopen(id: string, options?: RequestOptions): Promise<SalesOrder>;
|
|
10186
|
+
/**
|
|
10187
|
+
* Descargar el PDF
|
|
10188
|
+
*
|
|
10189
|
+
* El PDF del pedido, con el diseño de PDF del emisor.
|
|
10190
|
+
*
|
|
10191
|
+
* GET /v1/sales_orders/{id}/pdf
|
|
10192
|
+
* @see https://fiscalisto.com/docs/api/referencia/pedidos/get-sales-order-pdf
|
|
10193
|
+
*/
|
|
10194
|
+
pdf(id: string, options?: RequestOptions): Promise<Uint8Array>;
|
|
10195
|
+
}
|
|
8665
10196
|
/** Webhooks: fiscalisto.webhookEndpoints. */
|
|
8666
10197
|
export declare class WebhookEndpointsResource {
|
|
8667
10198
|
#private;
|
|
@@ -8763,6 +10294,7 @@ export declare class FiscalistoApi extends Core {
|
|
|
8763
10294
|
readonly issuers: IssuersResource;
|
|
8764
10295
|
readonly invoices: InvoicesResource;
|
|
8765
10296
|
readonly receivables: ReceivablesResource;
|
|
10297
|
+
readonly customers: CustomersResource;
|
|
8766
10298
|
readonly bankTransactions: BankTransactionsResource;
|
|
8767
10299
|
readonly purchaseReceipts: PurchaseReceiptsResource;
|
|
8768
10300
|
readonly payments: PaymentsResource;
|
|
@@ -8779,7 +10311,9 @@ export declare class FiscalistoApi extends Core {
|
|
|
8779
10311
|
readonly taxIds: TaxIdsResource;
|
|
8780
10312
|
readonly branches: BranchesResource;
|
|
8781
10313
|
readonly costCenters: CostCentersResource;
|
|
8782
|
-
readonly
|
|
10314
|
+
readonly expensePeople: ExpensePeopleResource;
|
|
10315
|
+
readonly expenseReports: ExpenseReportsResource;
|
|
10316
|
+
readonly expensePolicy: ExpensePolicyResource;
|
|
8783
10317
|
readonly customerDataRequests: CustomerDataRequestsResource;
|
|
8784
10318
|
readonly products: ProductsResource;
|
|
8785
10319
|
readonly satMailboxMessages: SatMailboxMessagesResource;
|
|
@@ -8798,6 +10332,7 @@ export declare class FiscalistoApi extends Core {
|
|
|
8798
10332
|
readonly storeConnections: StoreConnectionsResource;
|
|
8799
10333
|
readonly recurringInvoices: RecurringInvoicesResource;
|
|
8800
10334
|
readonly quotes: QuotesResource;
|
|
10335
|
+
readonly salesOrders: SalesOrdersResource;
|
|
8801
10336
|
readonly webhookEndpoints: WebhookEndpointsResource;
|
|
8802
10337
|
readonly events: EventsResource;
|
|
8803
10338
|
}
|