fiscalisto 0.1.36 → 0.1.38
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 +3 -2
- package/dist/core.d.ts +1 -1
- package/dist/core.js +1 -1
- package/dist/error-codes.d.ts +2 -0
- package/dist/error-codes.js +2 -0
- package/dist/generated.d.ts +415 -5
- package/dist/generated.js +134 -0
- package/dist/mock-routes.gen.js +1 -1
- package/package.json +1 -1
package/dist/agent-guide.d.ts
CHANGED
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
* Written by hand; keep it short (an agent reads all of it) and true to the docs it links.
|
|
6
6
|
*/
|
|
7
7
|
export declare const AGENT_SKILL_DESCRIPTION = "Agregar facturaci\u00F3n electr\u00F3nica mexicana (CFDI 4.0) a una app con la API y los SDKs de Fiscalisto: timbrar facturas, pagos (PPD), notas de cr\u00E9dito, n\u00F3mina y retenciones, cancelar, webhooks. Use it whenever the user wants to issue Mexican invoices (CFDI, SAT, timbrado, factura electr\u00F3nica) or integrate Fiscalisto.";
|
|
8
|
-
export declare const AGENT_GUIDE = "# Facturar con Fiscalisto (CFDI 4.0)\n\nFiscalisto es una API REST que timbra comprobantes fiscales mexicanos (CFDI 4.0): revisa las reglas\ndel SAT antes de gastar un timbre, sella con el certificado del emisor y timbra con el PAC. Los\nnombres de la API est\u00E1n en ingl\u00E9s (`customer`, `items`, `unit_price`); la documentaci\u00F3n, los\nmensajes de error y los textos, en espa\u00F1ol (`Accept-Language: en` los da en ingl\u00E9s).\n\n- Base: `https://api.fiscalisto.com/v1`, JSON, `Authorization: Bearer <llave>`.\n- Llaves: `fk_test_\u2026` timbra en el ambiente de pruebas del SAT, gratis; `fk_live_\u2026` timbra CFDI\n reales y usa un timbre cada uno. Se crean en **Desarrolladores \u203A Llaves**.\n- Costo en producci\u00F3n: paquetes de timbres prepagados, sin mensualidad. Cada CFDI timbrado usa 1;\n las consultas al SAT tambi\u00E9n (1 por cada 10 RFC en listas o constancias al
|
|
8
|
+
export declare const AGENT_GUIDE = "# Facturar con Fiscalisto (CFDI 4.0)\n\nFiscalisto es una API REST que timbra comprobantes fiscales mexicanos (CFDI 4.0): revisa las reglas\ndel SAT antes de gastar un timbre, sella con el certificado del emisor y timbra con el PAC. Los\nnombres de la API est\u00E1n en ingl\u00E9s (`customer`, `items`, `unit_price`); la documentaci\u00F3n, los\nmensajes de error y los textos, en espa\u00F1ol (`Accept-Language: en` los da en ingl\u00E9s).\n\n- Base: `https://api.fiscalisto.com/v1`, JSON, `Authorization: Bearer <llave>`.\n- Llaves: `fk_test_\u2026` timbra en el ambiente de pruebas del SAT, gratis; `fk_live_\u2026` timbra CFDI\n reales y usa un timbre cada uno. Se crean en **Desarrolladores \u203A Llaves**.\n- Costo en producci\u00F3n: paquetes de timbres prepagados, sin mensualidad. Cada CFDI timbrado usa 1;\n las consultas al SAT tambi\u00E9n (1 por cada 10 RFC en listas o constancias de clientes con `cif_id` al\n mes, 1 por cada 100 CFDI descargados, 1 por consulta de opini\u00F3n, constancia de situaci\u00F3n\n fiscal, buz\u00F3n o declaraciones del emisor; validar sin `cif_id` no cuesta). Cancelar, leer, PDF/XML, correos y\n webhooks no cuestan. Sin timbres: `402` `insufficient_balance`. Precios:\n https://fiscalisto.com/docs/api/pruebas-y-produccion.md\n- Documentaci\u00F3n para agentes: https://fiscalisto.com/docs/api/llms.txt (\u00EDndice; cada p\u00E1gina tambi\u00E9n en `.md`), la\n referencia OpenAPI 3.1 en https://api.fiscalisto.com/v1/openapi.json y el servidor MCP\n https://fiscalisto.com/docs/api/mcp (sin llave) con search_docs, describe_operation, describe_object, explain_error y\n call_api.\n\n## Antes de escribir c\u00F3digo\n\n1. **La llave.** P\u00EDdasela a la persona y gu\u00E1rdela en `FISCALISTO_API_KEY` (en `.env`, nunca en el\n repositorio). Si no tiene: `npx fiscalisto login` abre el navegador y guarda su llave de\n pruebas; `npx fiscalisto init` instala el SDK y deja la llave en `.env`. Nunca invente una.\n2. **Sin llave todav\u00EDa:** `npx fiscalisto mock` levanta la API en http://127.0.0.1:12111, sin\n internet (`new Fiscalisto(\"fk_test_mock\", { baseUrl: \"http://127.0.0.1:12111\" })`). Contesta\n como la API pero no revisa reglas del SAT: pruebe despu\u00E9s con una `fk_test_`.\n3. **El SDK de su lenguaje** (los seis tienen cada ruta, tipos e Idempotency-Key autom\u00E1tica):\n\n| Lenguaje | Instalar | Cliente |\n| --- | --- | --- |\n| TypeScript / JavaScript | `npm install fiscalisto` | `new Fiscalisto()` |\n| Python | `pip install fiscalisto` | `Fiscalisto()` |\n| PHP | `composer require fiscalisto/fiscalisto` | `new Fiscalisto\\Fiscalisto()` |\n| Go | `go get fiscalisto.com/go` | `fiscalisto.NewClient(\"\")` |\n| Java | Maven `com.fiscalisto:fiscalisto` | `new FiscalistoClient()` |\n| C# / .NET | `dotnet add package Fiscalisto` | `new FiscalistoClient()` |\n\nSin argumento, cada cliente lee `FISCALISTO_API_KEY`. El c\u00F3digo de cada operaci\u00F3n en cada lenguaje:\n`describe_operation` del MCP (con `language`) o la p\u00E1gina `.md` de la referencia.\n\n## Timbrar una factura\n\n```ts\nimport { Fiscalisto } from \"fiscalisto\";\n\nconst fiscalisto = new Fiscalisto(); // FISCALISTO_API_KEY\n\nconst invoice = await fiscalisto.invoices.create(\n {\n customer: { tax_id: \"ICV060329BY0\", legal_name: \"INMOBILIARIA CVA\", tax_system: \"601\", zip: \"33826\" },\n payment_form: \"03\", // transferencia\n items: [{ description: \"Mensualidad\", product_key: \"86121700\", quantity: 2, unit_price: 2500 }],\n },\n { idempotencyKey: `pedido-${order.id}` },\n);\n// Guarde invoice.id (inv_\u2026) y invoice.uuid (el folio fiscal) con su pedido.\n```\n\n- **Idempotency-Key = el id de su pedido.** Si la respuesta se pierde, repetir con la misma nunca\n timbra dos veces. No use una al azar en cada intento.\n- **El cliente (Receptor) va exactamente como en su constancia de situaci\u00F3n fiscal:** RFC\n (`tax_id`), nombre sin r\u00E9gimen de capital (sin \u00ABS.A. de C.V.\u00BB), r\u00E9gimen (`tax_system`, c_RegimenFiscal)\n y c\u00F3digo postal (`zip`). Si su app no tiene esos datos, p\u00EDdalos con una liga\n (`POST /v1/customer_data_requests`) o rev\u00EDselos con `POST /v1/tax_ids/validate`; guarde clientes\n frecuentes con `/v1/customers` y mande su `cus_\u2026`.\n- Lo que omite toma el valor usual: PUE, MXN, uso G03 (S01 con r\u00E9gimen 616), objeto de impuesto 02,\n IVA 16 %, cantidad 1, unidad E48. `unit_price` es sin IVA, en pesos.\n- **Claves del SAT:** no las invente. B\u00FAsquelas en los cat\u00E1logos (`/v1/sat_catalogs/{name}`, por ejemplo\n `product_keys`) o guarde productos (`/v1/products`, `prd_\u2026`) con su clave.\n- **La respuesta** trae `status: \"valid\"` con UUID, PDF y XML. Si el PAC tarda llega\n `processing`: no repita con otra llave de idempotencia; espere el webhook `invoice.stamped`\n (o `invoice.failed`).\n- **PDF y XML:** `invoices.pdf(id)`, `invoices.xml(id)`; `invoices.send(id)` lo manda por correo.\n- **A cr\u00E9dito (PPD):** `payment_method: \"PPD\"`, `payment_form: \"99\"`; cada cobro lleva su\n complemento de pago (`POST /v1/payments`) a m\u00E1s tardar el d\u00EDa 5 del mes siguiente.\n- Otros comprobantes: notas de cr\u00E9dito (`/v1/credit_notes`), anticipos (`/v1/advances`), n\u00F3mina\n (`/v1/payroll_receipts`; toda la n\u00F3mina en una solicitud con `/v1/payroll_batches`),\n retenciones (`/v1/retentions`), lotes de hasta 1,000 (`/v1/invoice_batches`), factura global\n y autofactura por ticket (`/v1/tickets`).\n\n## Errores\n\nCada error trae `error.type`, `error.code`, `error.message` (en espa\u00F1ol) y `error.param` (el\ncampo a corregir). Un rechazo del SAT llega como `invoice_rejected` con su regla en\n`error.sat_code` (CFDI40\u2026): muestre el mensaje a la persona y corrija el dato; no reintente igual.\nEl SDK solo reintenta lo que es seguro repetir. `explain_error` del MCP dice qu\u00E9 hacer con cada\nc\u00F3digo; la lista completa est\u00E1 en https://fiscalisto.com/docs/api/errores.md.\n\n## Webhooks\n\nLo que pasa despu\u00E9s (timbrado tard\u00EDo, cancelaci\u00F3n aceptada d\u00EDas despu\u00E9s, lotes) llega a su endpoint\ncomo evento firmado. Cr\u00E9elo en **Desarrolladores \u203A Webhooks** o con `POST /v1/webhook_endpoints`\ny guarde su secreto `whsec_\u2026` en `FISCALISTO_WEBHOOK_SECRET`.\n\n```ts\nimport { FiscalistoWebhookError, verifyWebhook } from \"fiscalisto\";\n\nexport async function POST(request: Request) {\n try {\n // El cuerpo tal como lleg\u00F3 (texto), sin interpretarlo antes.\n const event = await verifyWebhook(await request.text(), request.headers, process.env.FISCALISTO_WEBHOOK_SECRET!);\n if (event.type === \"invoice.stamped\") await marcarFacturado(event.data.object);\n return new Response(null, { status: 200 });\n } catch (error) {\n if (error instanceof FiscalistoWebhookError) return new Response(null, { status: 400 });\n throw error;\n }\n}\n```\n\nConteste 2xx r\u00E1pido y procese aparte; un evento puede llegar m\u00E1s de una vez: ignore el `evt_\u2026` que\nya proces\u00F3. En desarrollo, `npx fiscalisto listen --forward-to http://localhost:3000/webhooks` le\nreenv\u00EDa los eventos de pruebas y `npx fiscalisto trigger invoice.stamped` provoca uno.\n\n## Cancelar\n\n`invoices.cancel(id, { motive: \"02\" })`: 02 con errores y sin sustituir (el usual), 01 con errores y sustituida\n(`substitution: \"inv_\u2026\"`, o `invoices.substitute` timbra la nueva y cancela la anterior), 03 no\nse llev\u00F3 a cabo y 04 solo en una factura global (una venta se factur\u00F3 despu\u00E9s a nombre del\ncliente). Si el cliente debe aceptar llega\n`invoice.cancellation_pending` y despu\u00E9s `invoice.canceled` o `invoice.cancellation_rejected`.\n\n## Probar\n\n- Las llaves `fk_test_` aplican las mismas revisiones del SAT que producci\u00F3n; una cuenta nueva ya\n tiene un emisor de pruebas listo.\n- En pruebas el cliente o empleado debe estar en la lista de RFC de prueba del PAC (si no,\n `CFDI40143`): use `ICV060329BY0` INMOBILIARIA CVA, r\u00E9gimen 601, CP 33826 (persona moral) o\n `MASO451221PM4` MARIA OLIVIA MARTINEZ SAGAZ, CP 80290 (persona f\u00EDsica y n\u00F3mina).\n- En pruebas los correos solo llegan a las personas de la cuenta API (a otro, `send_email` timbra\n igual y la respuesta trae `email_error`), y cada emisor timbra hasta 5 comprobantes cada 10\n segundos (`429` `stamp_rate_limit`: espere `Retry-After` y repita con la misma llave).\n- RFC de prueba que provocan cada rechazo del SAT (por ejemplo `NOM010101FK9` \u2192 `CFDI40145`):\n https://fiscalisto.com/docs/api/pruebas-y-produccion.md#provocar-cada-rechazo-del-sat.\n- `call_api` del MCP prueba un cuerpo real con la llave de pruebas antes de escribirlo en c\u00F3digo.\n- Pruebas autom\u00E1ticas: `POST /v1/test_data/reset` deja el modo de pruebas como nuevo.\n\n## Nunca\n\n- Poner la llave en el navegador o en una app m\u00F3vil: la API rechaza el navegador\n (`browser_not_supported`). Llame desde su servidor.\n- Usar una `fk_live_` para probar: timbra CFDI reales con valor fiscal.\n- Inventar folios, UUID, RFC, reg\u00EDmenes o claves del SAT: cons\u00FAltelos.\n\n## Pasar a producci\u00F3n\n\nEmisor real (`POST /v1/issuers`), su CSD (`/certificates`), la firma con e.firma del contrato\ncon el PAC (`/efirma`) o, m\u00E1s f\u00E1cil, una liga para que el due\u00F1o lo haga\n(`POST /v1/issuers/{id}/onboarding_links`); timbres en **Desarrolladores \u203A Timbres**; y la llave\n`fk_live_` en el servidor. Detalle: https://fiscalisto.com/docs/api/pruebas-y-produccion.md#pasar-a-produccion.\n";
|
|
9
9
|
/** The guide as an Agent Skill (agentskills.io): SKILL.md with its name and description. */
|
|
10
10
|
export declare const AGENT_SKILL: string;
|
package/dist/agent-guide.js
CHANGED
|
@@ -17,8 +17,9 @@ mensajes de error y los textos, en español (\`Accept-Language: en\` los da en i
|
|
|
17
17
|
- Llaves: \`fk_test_…\` timbra en el ambiente de pruebas del SAT, gratis; \`fk_live_…\` timbra CFDI
|
|
18
18
|
reales y usa un timbre cada uno. Se crean en **Desarrolladores › Llaves**.
|
|
19
19
|
- Costo en producción: paquetes de timbres prepagados, sin mensualidad. Cada CFDI timbrado usa 1;
|
|
20
|
-
las consultas al SAT también (1 por cada 10 RFC en listas o constancias
|
|
21
|
-
|
|
20
|
+
las consultas al SAT también (1 por cada 10 RFC en listas o constancias de clientes con \`cif_id\` al
|
|
21
|
+
mes, 1 por cada 100 CFDI descargados, 1 por consulta de opinión, constancia de situación
|
|
22
|
+
fiscal, buzón o declaraciones del emisor; validar sin \`cif_id\` no cuesta). Cancelar, leer, PDF/XML, correos y
|
|
22
23
|
webhooks no cuestan. Sin timbres: \`402\` \`insufficient_balance\`. Precios:
|
|
23
24
|
${DOCS}/pruebas-y-produccion.md
|
|
24
25
|
- Documentación para agentes: ${DOCS}/llms.txt (índice; cada página también en \`.md\`), la
|
package/dist/core.d.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* llamar.
|
|
5
5
|
*/
|
|
6
6
|
import type { ErrorCode } from "./error-codes.js";
|
|
7
|
-
export declare const VERSION = "0.1.
|
|
7
|
+
export declare const VERSION = "0.1.38";
|
|
8
8
|
/**
|
|
9
9
|
* La versión de la API para la que se hizo este SDK: la manda en cada solicitud
|
|
10
10
|
* (Fiscalisto-Version), así actualizar la API no cambia lo que recibe hasta que actualice el SDK.
|
package/dist/core.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* errores y las listas que se recorren solas. Los recursos (generated.ts) solo dicen qué ruta
|
|
4
4
|
* llamar.
|
|
5
5
|
*/
|
|
6
|
-
export const VERSION = "0.1.
|
|
6
|
+
export const VERSION = "0.1.38";
|
|
7
7
|
/**
|
|
8
8
|
* La versión de la API para la que se hizo este SDK: la manda en cada solicitud
|
|
9
9
|
* (Fiscalisto-Version), así actualizar la API no cambia lo que recibe hasta que actualice el SDK.
|
package/dist/error-codes.d.ts
CHANGED
|
@@ -193,6 +193,8 @@ export declare const ErrorCode: {
|
|
|
193
193
|
readonly StorePlatformUnavailable: "store_platform_unavailable";
|
|
194
194
|
/** Los complementos de pago y las notas de crédito no se sustituyen: se cancelan y se emite otro. Un recibo de nómina se sustituye con POST /v1/payroll_receipts/external y replaces. */
|
|
195
195
|
readonly SubstitutionUnsupported: "substitution_unsupported";
|
|
196
|
+
/** La factura del proveedor no admite eso en su estado (por ejemplo, programar una que no está aprobada, una fecha de pago pasada o marcar pagada una ya pagada), o el SAT la reporta cancelada. El mensaje dice por qué. */
|
|
197
|
+
readonly SupplierInvoiceInvalid: "supplier_invoice_invalid";
|
|
196
198
|
/** El reloj se está adelantando en otra solicitud (409, con Retry-After). Espere a test_clock.ready y repita. */
|
|
197
199
|
readonly TestClockAdvancing: "test_clock_advancing";
|
|
198
200
|
/** El emisor ya tiene un reloj de prueba: adelántelo, o bórrelo para volver a la hora real. */
|
package/dist/error-codes.js
CHANGED
|
@@ -194,6 +194,8 @@ export const ErrorCode = {
|
|
|
194
194
|
StorePlatformUnavailable: "store_platform_unavailable",
|
|
195
195
|
/** Los complementos de pago y las notas de crédito no se sustituyen: se cancelan y se emite otro. Un recibo de nómina se sustituye con POST /v1/payroll_receipts/external y replaces. */
|
|
196
196
|
SubstitutionUnsupported: "substitution_unsupported",
|
|
197
|
+
/** La factura del proveedor no admite eso en su estado (por ejemplo, programar una que no está aprobada, una fecha de pago pasada o marcar pagada una ya pagada), o el SAT la reporta cancelada. El mensaje dice por qué. */
|
|
198
|
+
SupplierInvoiceInvalid: "supplier_invoice_invalid",
|
|
197
199
|
/** El reloj se está adelantando en otra solicitud (409, con Retry-After). Espere a test_clock.ready y repita. */
|
|
198
200
|
TestClockAdvancing: "test_clock_advancing",
|
|
199
201
|
/** El emisor ya tiene un reloj de prueba: adelántelo, o bórrelo para volver a la hora real. */
|
package/dist/generated.d.ts
CHANGED
|
@@ -1603,6 +1603,80 @@ export interface SatInvoice {
|
|
|
1603
1603
|
/** Cuándo llegó. */
|
|
1604
1604
|
downloaded_at: string | null;
|
|
1605
1605
|
}
|
|
1606
|
+
/** Un CFDI de retenciones e información de pagos del emisor, recibido (la constancia que le dio un banco, una plataforma o quien le pagó) o emitido, como lo muestra Facturas › Retenciones. */
|
|
1607
|
+
export interface SatRetention {
|
|
1608
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
1609
|
+
id: string;
|
|
1610
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
1611
|
+
livemode: boolean;
|
|
1612
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
1613
|
+
object: "sat_retention";
|
|
1614
|
+
/** El emisor de su cuenta (iss_…) a quien pertenece esta constancia. */
|
|
1615
|
+
issuer: string;
|
|
1616
|
+
/** El folio fiscal (UUID del timbre). */
|
|
1617
|
+
uuid: string;
|
|
1618
|
+
/** received (se la dieron al emisor: un banco, una plataforma, quien le pagó) o issued (la emitió). */
|
|
1619
|
+
direction: "received" | "issued";
|
|
1620
|
+
/** La fecha de expedición (FechaExp). */
|
|
1621
|
+
date: string;
|
|
1622
|
+
/** Folio interno (FolioInt), o null. */
|
|
1623
|
+
internal_folio: string | null;
|
|
1624
|
+
/** Clave de la retención (CveRetenc), como 14 dividendos, 16 intereses o 26 plataformas. */
|
|
1625
|
+
code: string | null;
|
|
1626
|
+
/** Descripción de la retención (DescRetenc), o null. */
|
|
1627
|
+
description: string | null;
|
|
1628
|
+
/** Quien retuvo (Emisor). */
|
|
1629
|
+
issued_by: {
|
|
1630
|
+
/** RFC (Rfc), 12 caracteres una persona moral y 13 una física. */
|
|
1631
|
+
tax_id: string | null;
|
|
1632
|
+
/** 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.»). */
|
|
1633
|
+
legal_name: string | null;
|
|
1634
|
+
};
|
|
1635
|
+
/** A quien le retuvieron (Receptor). */
|
|
1636
|
+
issued_to: {
|
|
1637
|
+
/** RFC (Rfc), 12 caracteres una persona moral y 13 una física. */
|
|
1638
|
+
tax_id: string | null;
|
|
1639
|
+
/** 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.»). */
|
|
1640
|
+
legal_name: string | null;
|
|
1641
|
+
};
|
|
1642
|
+
/** Los meses y el ejercicio que cubre (Periodo), o null si no se pudo leer. */
|
|
1643
|
+
period: {
|
|
1644
|
+
/** Ejercicio (Ejercicio). */
|
|
1645
|
+
year: number;
|
|
1646
|
+
/** Mes inicial (MesIni), 1 a 12. */
|
|
1647
|
+
month_start: number;
|
|
1648
|
+
/** Mes final (MesFin), 1 a 12. */
|
|
1649
|
+
month_end: number;
|
|
1650
|
+
} | null;
|
|
1651
|
+
/** Los montos de Totales. */
|
|
1652
|
+
totals: {
|
|
1653
|
+
/** Monto total de la operación (MontoTotOperacion). */
|
|
1654
|
+
operation: number | null;
|
|
1655
|
+
/** Monto gravado (MontoTotGrav). Por omisión, operation menos exempt. */
|
|
1656
|
+
taxed: number | null;
|
|
1657
|
+
/** Monto exento (MontoTotExent). Por omisión 0. */
|
|
1658
|
+
exempt: number | null;
|
|
1659
|
+
/** Total retenido (MontoTotRet). */
|
|
1660
|
+
withheld: number | null;
|
|
1661
|
+
};
|
|
1662
|
+
/** Cada impuesto retenido (ImpRetenidos). */
|
|
1663
|
+
withheld_taxes: {
|
|
1664
|
+
/** Base del impuesto retenido (BaseRet). */
|
|
1665
|
+
base: number | null;
|
|
1666
|
+
/** Impuesto: isr, iva o ieps (ImpuestoRet 001, 002, 003). */
|
|
1667
|
+
tax: string | null;
|
|
1668
|
+
/** Importe. */
|
|
1669
|
+
amount: number | null;
|
|
1670
|
+
/** Tipo de pago de la retención (TipoPagoRet): 01 definitivo IVA, 02 definitivo IEPS, 03 definitivo ISR, 04 provisional ISR. Por omisión el usual de cada impuesto. */
|
|
1671
|
+
payment_type: string | null;
|
|
1672
|
+
}[];
|
|
1673
|
+
/** active o canceled: la canceló el emisor en Fiscalisto, o el SAT la reporta cancelada (se revisa cada mes). Una cancelada ya no es impuesto retenido. */
|
|
1674
|
+
status: "active" | "canceled";
|
|
1675
|
+
/** Si su XML no se pudo leer, por qué; sus campos quedan en null. Si no, null. */
|
|
1676
|
+
read_error: string | null;
|
|
1677
|
+
/** Cuándo llegó a Fiscalisto. */
|
|
1678
|
+
downloaded_at: string | null;
|
|
1679
|
+
}
|
|
1606
1680
|
/** Una declaración que el emisor presentó ante el SAT (provisional o definitiva, anual o del servicio anterior Declaraciones y pagos), con sus cifras y sus archivos. */
|
|
1607
1681
|
export interface SatDeclaration {
|
|
1608
1682
|
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
@@ -3428,6 +3502,145 @@ export interface SalesOrder {
|
|
|
3428
3502
|
/** Cuándo se creó. */
|
|
3429
3503
|
created_at: string | null;
|
|
3430
3504
|
}
|
|
3505
|
+
/** Un proveedor del Portal de proveedores del emisor: su alta, sus documentos, la cuenta a la que se le paga y su calificación. */
|
|
3506
|
+
export interface PortalSupplier {
|
|
3507
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
3508
|
+
id: string;
|
|
3509
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
3510
|
+
livemode: boolean;
|
|
3511
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
3512
|
+
object: "portal_supplier";
|
|
3513
|
+
/** El emisor de su cuenta (iss_…) cuyo portal es. */
|
|
3514
|
+
issuer: string;
|
|
3515
|
+
/** El RFC del proveedor. */
|
|
3516
|
+
tax_id: string;
|
|
3517
|
+
/** Su nombre o razón social, o null si aún no lo da. */
|
|
3518
|
+
name: string | null;
|
|
3519
|
+
/** Los correos a los que le escribimos. */
|
|
3520
|
+
emails: string[];
|
|
3521
|
+
/** Su teléfono, o null. */
|
|
3522
|
+
phone: string | null;
|
|
3523
|
+
/** invited (invitado), onboarding (dando su alta), in_review (alta por revisar), approved (puede mandar facturas), rejected o suspended. */
|
|
3524
|
+
status: "invited" | "onboarding" | "in_review" | "approved" | "rejected" | "suspended";
|
|
3525
|
+
/** true si da servicios especializados (REPSE). */
|
|
3526
|
+
repse: boolean;
|
|
3527
|
+
/** Su alta: complete cuando todo lo obligatorio está aprobado y vigente, y cuántos documentos faltan, esperan revisión, vencieron o están por vencer. */
|
|
3528
|
+
documents: {
|
|
3529
|
+
/** true cuando todo lo obligatorio de su alta está aprobado y vigente. */
|
|
3530
|
+
complete: boolean;
|
|
3531
|
+
/** Cuántos documentos obligatorios no ha subido. */
|
|
3532
|
+
missing: number;
|
|
3533
|
+
/** Cuántos esperan revisión. */
|
|
3534
|
+
pending: number;
|
|
3535
|
+
/** Cuántos vencieron. */
|
|
3536
|
+
expired: number;
|
|
3537
|
+
/** Cuántos vencen en los próximos 7 días. */
|
|
3538
|
+
expiring: number;
|
|
3539
|
+
};
|
|
3540
|
+
/** La cuenta a la que se le paga, o null. Una nueva queda pending hasta que se aprueba en la app; mientras, se le paga a previous_clabe. */
|
|
3541
|
+
bank_account: {
|
|
3542
|
+
/** La CLABE de 18 dígitos. */
|
|
3543
|
+
clabe: string;
|
|
3544
|
+
/** El banco, o null. */
|
|
3545
|
+
bank: string | null;
|
|
3546
|
+
/** El titular de la cuenta, o null. */
|
|
3547
|
+
holder: string | null;
|
|
3548
|
+
/** Estado del objeto. */
|
|
3549
|
+
status: "pending" | "approved" | "rejected";
|
|
3550
|
+
/** Mientras una CLABE nueva está pending, la anterior, a la que se le sigue pagando; si no, null. */
|
|
3551
|
+
previous_clabe: string | null;
|
|
3552
|
+
} | null;
|
|
3553
|
+
/** Su calificación de 0 a 100 de los últimos 12 meses (value, null sin datos; level excellent, good, fair o poor) y cada parte: invoices (facturas a la primera), deliveries (entregas a tiempo), prices (precio y cantidad de la orden), documents (documentos al día) y complements (complementos de pago), con good de total casos. */
|
|
3554
|
+
score: {
|
|
3555
|
+
/** Valor de la mercancía (ValorMercancia); obligatorio en transporte aéreo. */
|
|
3556
|
+
value: number | null;
|
|
3557
|
+
/** Nivel educativo (nivelEducativo). */
|
|
3558
|
+
level: "excellent" | "good" | "fair" | "poor" | null;
|
|
3559
|
+
/** Partes del transporte que posee o arrienda (ParteTransporte), c_ParteTransporte. */
|
|
3560
|
+
parts: {
|
|
3561
|
+
/** invoices (facturas a la primera), deliveries (entregas a tiempo), prices (precio y cantidad de la orden), documents (documentos al día) o complements (complementos de pago). */
|
|
3562
|
+
part: "invoices" | "deliveries" | "prices" | "documents" | "complements";
|
|
3563
|
+
/** Valor de la mercancía (ValorMercancia); obligatorio en transporte aéreo. */
|
|
3564
|
+
value: number | null;
|
|
3565
|
+
/** En cuántos de los total casos lo hizo bien. */
|
|
3566
|
+
good: number;
|
|
3567
|
+
/** Total en la moneda del comprobante (Total). */
|
|
3568
|
+
total: number;
|
|
3569
|
+
}[];
|
|
3570
|
+
};
|
|
3571
|
+
/** La última vez que entró a su portal, o null. */
|
|
3572
|
+
last_seen_at: string | null;
|
|
3573
|
+
/** Cuándo se invitó o se registró. */
|
|
3574
|
+
created_at: string | null;
|
|
3575
|
+
/** Cuándo cambió por última vez. */
|
|
3576
|
+
updated_at: string | null;
|
|
3577
|
+
}
|
|
3578
|
+
/** Una factura que un proveedor le mandó al emisor por su Portal de proveedores, con lo que se revisó, su orden de compra, su contrarecibo y sus fechas de pago. */
|
|
3579
|
+
export interface SupplierInvoice {
|
|
3580
|
+
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
3581
|
+
id: string;
|
|
3582
|
+
/** true en producción (llaves fk_live_), false en pruebas (fk_test_). Lo de pruebas no vale ante el SAT. */
|
|
3583
|
+
livemode: boolean;
|
|
3584
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
3585
|
+
object: "supplier_invoice";
|
|
3586
|
+
/** El emisor de su cuenta (iss_…) que la recibió. */
|
|
3587
|
+
issuer: string;
|
|
3588
|
+
/** El proveedor (sup_…) que la mandó. */
|
|
3589
|
+
supplier: string;
|
|
3590
|
+
/** El RFC del proveedor. */
|
|
3591
|
+
supplier_tax_id: string;
|
|
3592
|
+
/** El folio fiscal (UUID del timbre). */
|
|
3593
|
+
uuid: string;
|
|
3594
|
+
/** La misma factura en sus facturas recibidas (sat_…), para su XML y su PDF, o null. */
|
|
3595
|
+
sat_invoice: string | null;
|
|
3596
|
+
/** Su serie, o null. */
|
|
3597
|
+
series: string | null;
|
|
3598
|
+
/** Su folio, o null. */
|
|
3599
|
+
folio: string | null;
|
|
3600
|
+
/** income (factura de ingreso) o credit_note (nota de crédito). */
|
|
3601
|
+
type: "income" | "credit_note";
|
|
3602
|
+
/** La fecha de la factura. */
|
|
3603
|
+
date: string;
|
|
3604
|
+
/** La moneda. */
|
|
3605
|
+
currency: string;
|
|
3606
|
+
/** El total de la factura. */
|
|
3607
|
+
total: number;
|
|
3608
|
+
/** Lo que se le paga: el total sin las diferencias con su orden ni el descuento de pronto pago aceptado. */
|
|
3609
|
+
payable: number;
|
|
3610
|
+
/** PUE o PPD. */
|
|
3611
|
+
payment_method: string | null;
|
|
3612
|
+
/** received (por revisar), approved, scheduled (con fecha de pago), paid o rejected. */
|
|
3613
|
+
status: "received" | "approved" | "scheduled" | "paid" | "rejected";
|
|
3614
|
+
/** La orden de compra que factura (OC-12), o null. */
|
|
3615
|
+
purchase_order: string | null;
|
|
3616
|
+
/** true si cuadró con su orden, false si tuvo diferencias, null sin orden. */
|
|
3617
|
+
matches_purchase_order: boolean | null;
|
|
3618
|
+
/** El folio de su contrarecibo, o null. */
|
|
3619
|
+
contrarecibo: string | null;
|
|
3620
|
+
/** El día en que vence por sus fechas de pago, o null. */
|
|
3621
|
+
due_on: string | null;
|
|
3622
|
+
/** El día programado para pagarla, o null. */
|
|
3623
|
+
scheduled_on: string | null;
|
|
3624
|
+
/** El día en que se pagó, o null. */
|
|
3625
|
+
paid_on: string | null;
|
|
3626
|
+
/** Lo que se pagó, o null. */
|
|
3627
|
+
paid_amount: number | null;
|
|
3628
|
+
/** La referencia del pago, o null. */
|
|
3629
|
+
payment_reference: string | null;
|
|
3630
|
+
/** Por qué se rechazó, o null. */
|
|
3631
|
+
rejection_reason: string | null;
|
|
3632
|
+
/** Lo que se revisó y quedó como aviso (code y message), para que su equipo lo vea. */
|
|
3633
|
+
warnings: {
|
|
3634
|
+
/** Clave de la retención (CveRetenc), c_CveRetenc: 01 servicios profesionales, 05 arrendamiento, 14 dividendos, 16 intereses, 18 pagos al extranjero… Las claves 14, 16, 17 y 18 a 24 llevan su complemento (dividends, interest, trust_lease, foreign_payment, share_sale, prize, trust, retirement_plan, mortgage_interest, financial_derivatives); la 26 (plataformas tecnológicas) lleva platform, y sus totals y taxes se calculan de las operaciones. */
|
|
3635
|
+
code: string;
|
|
3636
|
+
/** Qué pasó y cómo corregirlo, para una persona. */
|
|
3637
|
+
message: string;
|
|
3638
|
+
}[];
|
|
3639
|
+
/** Cuándo llegó. */
|
|
3640
|
+
received_at: string | null;
|
|
3641
|
+
/** Cuándo se aprobó, o null. */
|
|
3642
|
+
approved_at: string | null;
|
|
3643
|
+
}
|
|
3431
3644
|
/** Una entrega del pedido, con su remisión (REM-1): lo que salió del almacén. */
|
|
3432
3645
|
export interface SalesOrderDelivery {
|
|
3433
3646
|
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
@@ -3774,14 +3987,14 @@ export interface WebhookTest {
|
|
|
3774
3987
|
};
|
|
3775
3988
|
}
|
|
3776
3989
|
/** Lo que puede pasar: el tipo de cada evento. */
|
|
3777
|
-
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";
|
|
3990
|
+
export type EventType = "invoice.stamped" | "invoice.failed" | "invoice.canceled" | "invoice.cancellation_pending" | "invoice.cancellation_rejected" | "invoice.paid" | "invoice.partially_paid" | "invoice.email_bounced" | "invoice.email_complained" | "retention.stamped" | "retention.failed" | "retention.canceled" | "invoice_batch.completed" | "payroll_batch.completed" | "customer_data_request.completed" | "sat_download.completed" | "sat_download.failed" | "sat_declaration.created" | "sat_declaration.updated" | "ticket.invoiced" | "ticket.included_in_global" | "recurring_invoice.failed" | "quote.viewed" | "quote.accepted" | "quote.changes_requested" | "quote.rejected" | "quote.withdrawn" | "sales_order.confirmed" | "sales_order.customer_confirmed" | "sales_order.delivered" | "sales_order.paid" | "sales_order.canceled" | "supplier_invoice.received" | "supplier_invoice.approved" | "supplier_invoice.rejected" | "supplier_invoice.scheduled" | "supplier_invoice.paid" | "portal_supplier.approved" | "issuer.ready" | "balance.low" | "test_clock.ready";
|
|
3778
3991
|
/** Algo que pasó en su cuenta: el objeto completo como quedó. Se manda a sus webhooks firmado (Standard Webhooks). */
|
|
3779
3992
|
export interface EventBase<T extends EventType = EventType, O = unknown> {
|
|
3780
3993
|
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
3781
3994
|
id: string;
|
|
3782
3995
|
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
3783
3996
|
object: "event";
|
|
3784
|
-
/** 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. */
|
|
3997
|
+
/** 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, supplier_invoice.received, supplier_invoice.approved, supplier_invoice.rejected, supplier_invoice.scheduled, supplier_invoice.paid, portal_supplier.approved, issuer.ready, balance.low o test_clock.ready. */
|
|
3785
3998
|
type: T;
|
|
3786
3999
|
/** Versión de la API con que se armó el objeto. */
|
|
3787
4000
|
api_version: string;
|
|
@@ -3795,7 +4008,7 @@ export interface EventBase<T extends EventType = EventType, O = unknown> {
|
|
|
3795
4008
|
};
|
|
3796
4009
|
}
|
|
3797
4010
|
/** Un evento: según su type, data.object es la factura, la constancia o el lote. */
|
|
3798
|
-
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>;
|
|
4011
|
+
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<"supplier_invoice.received", SupplierInvoice> | EventBase<"supplier_invoice.approved", SupplierInvoice> | EventBase<"supplier_invoice.rejected", SupplierInvoice> | EventBase<"supplier_invoice.scheduled", SupplierInvoice> | EventBase<"supplier_invoice.paid", SupplierInvoice> | EventBase<"portal_supplier.approved", PortalSupplier> | EventBase<"issuer.ready", Issuer> | EventBase<"balance.low", Balance> | EventBase<"test_clock.ready", TestClock>;
|
|
3799
4012
|
/** Confirmación de que se borró. */
|
|
3800
4013
|
export interface Deleted {
|
|
3801
4014
|
/** Identificador del objeto, con su prefijo (iss_, inv_, ret_, cus_, prd_, emp_, bat_, brn_, whs_, stm_, adj_, evt_, whe_). */
|
|
@@ -4147,6 +4360,36 @@ export interface SatInvoiceList {
|
|
|
4147
4360
|
/** La ruta de esta lista. */
|
|
4148
4361
|
url: string;
|
|
4149
4362
|
}
|
|
4363
|
+
export interface SatRetentionList {
|
|
4364
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
4365
|
+
object: "list";
|
|
4366
|
+
/** Los objetos de esta página. */
|
|
4367
|
+
data: SatRetention[];
|
|
4368
|
+
/** true si hay más: pida la siguiente con starting_after igual al id del último. */
|
|
4369
|
+
has_more: boolean;
|
|
4370
|
+
/** La ruta de esta lista. */
|
|
4371
|
+
url: string;
|
|
4372
|
+
}
|
|
4373
|
+
export interface PortalSupplierList {
|
|
4374
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
4375
|
+
object: "list";
|
|
4376
|
+
/** Los objetos de esta página. */
|
|
4377
|
+
data: PortalSupplier[];
|
|
4378
|
+
/** true si hay más: pida la siguiente con starting_after igual al id del último. */
|
|
4379
|
+
has_more: boolean;
|
|
4380
|
+
/** La ruta de esta lista. */
|
|
4381
|
+
url: string;
|
|
4382
|
+
}
|
|
4383
|
+
export interface SupplierInvoiceList {
|
|
4384
|
+
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
4385
|
+
object: "list";
|
|
4386
|
+
/** Los objetos de esta página. */
|
|
4387
|
+
data: SupplierInvoice[];
|
|
4388
|
+
/** true si hay más: pida la siguiente con starting_after igual al id del último. */
|
|
4389
|
+
has_more: boolean;
|
|
4390
|
+
/** La ruta de esta lista. */
|
|
4391
|
+
url: string;
|
|
4392
|
+
}
|
|
4150
4393
|
export interface SatDeclarationList {
|
|
4151
4394
|
/** Qué tipo de objeto es («invoice», «customer»…). */
|
|
4152
4395
|
object: "list";
|
|
@@ -7172,6 +7415,65 @@ export interface UpdateSatInvoiceParams {
|
|
|
7172
7415
|
/** Su centro de costo (ccn_…), o null para quitárselo. Los complementos de pago y los traslados no llevan. */
|
|
7173
7416
|
cost_center?: string | null;
|
|
7174
7417
|
}
|
|
7418
|
+
/** Los parámetros de GET /v1/sat_retentions. */
|
|
7419
|
+
export interface ListSatRetentionsParams {
|
|
7420
|
+
/** Cuántos por página, de 1 a 100. Por omisión 10. */
|
|
7421
|
+
limit?: number;
|
|
7422
|
+
/** El id del último de la página anterior, para la siguiente. */
|
|
7423
|
+
starting_after?: string;
|
|
7424
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
7425
|
+
issuer?: string;
|
|
7426
|
+
/** received (por omisión) o issued. */
|
|
7427
|
+
direction?: "received" | "issued";
|
|
7428
|
+
/** active o canceled. Sin él, las dos. */
|
|
7429
|
+
status?: "active" | "canceled";
|
|
7430
|
+
/** El RFC de quien retuvo (recibidas) o a quien le retuvo (emitidas). */
|
|
7431
|
+
counterparty_tax_id?: string;
|
|
7432
|
+
/** Clave de la retención (CveRetenc) de dos dígitos, como 16 o 26. */
|
|
7433
|
+
code?: string;
|
|
7434
|
+
/** Solo las de un ejercicio, como 2025. */
|
|
7435
|
+
year?: number;
|
|
7436
|
+
/** Solo las que cubren este mes (1 a 12): una anual de enero a diciembre cubre todos. */
|
|
7437
|
+
month?: number;
|
|
7438
|
+
}
|
|
7439
|
+
/** Los parámetros de GET /v1/portal_suppliers. */
|
|
7440
|
+
export interface ListPortalSuppliersParams {
|
|
7441
|
+
/** Cuántos por página, de 1 a 100. Por omisión 10. */
|
|
7442
|
+
limit?: number;
|
|
7443
|
+
/** El id del último de la página anterior, para la siguiente. */
|
|
7444
|
+
starting_after?: string;
|
|
7445
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
7446
|
+
issuer?: string;
|
|
7447
|
+
/** Solo los que estén en este estado. */
|
|
7448
|
+
status?: "invited" | "onboarding" | "in_review" | "approved" | "rejected" | "suspended";
|
|
7449
|
+
/** Solo el de este RFC. */
|
|
7450
|
+
tax_id?: string;
|
|
7451
|
+
}
|
|
7452
|
+
/** Los parámetros de GET /v1/supplier_invoices. */
|
|
7453
|
+
export interface ListSupplierInvoicesParams {
|
|
7454
|
+
/** Cuántos por página, de 1 a 100. Por omisión 10. */
|
|
7455
|
+
limit?: number;
|
|
7456
|
+
/** El id del último de la página anterior, para la siguiente. */
|
|
7457
|
+
starting_after?: string;
|
|
7458
|
+
/** El emisor (iss_…). Puede omitirse si la llave o la cuenta tienen uno solo. */
|
|
7459
|
+
issuer?: string;
|
|
7460
|
+
/** Solo las que estén en este estado. */
|
|
7461
|
+
status?: "received" | "approved" | "scheduled" | "paid" | "rejected";
|
|
7462
|
+
/** Solo las de este proveedor (sup_…). */
|
|
7463
|
+
supplier?: string;
|
|
7464
|
+
/** Solo las que llegaron desde este día (AAAA-MM-DD). */
|
|
7465
|
+
received_since?: string;
|
|
7466
|
+
}
|
|
7467
|
+
export interface ScheduleSupplierInvoiceParams {
|
|
7468
|
+
/** El día en que la pagará (AAAA-MM-DD, hoy o después). El proveedor lo ve. */
|
|
7469
|
+
pay_on: string;
|
|
7470
|
+
}
|
|
7471
|
+
export interface MarkSupplierInvoicePaidParams {
|
|
7472
|
+
/** El día en que la pagó (AAAA-MM-DD, hoy o antes). */
|
|
7473
|
+
paid_on: string;
|
|
7474
|
+
/** La referencia del pago (la de la transferencia o del ERP), o null. */
|
|
7475
|
+
reference?: string | null;
|
|
7476
|
+
}
|
|
7175
7477
|
export interface RefreshSatDeclarationsParams {
|
|
7176
7478
|
/** El emisor (iss_…). Por omisión, su único emisor. */
|
|
7177
7479
|
issuer?: string;
|
|
@@ -8240,7 +8542,7 @@ export interface RollWebhookSecretParams {
|
|
|
8240
8542
|
}
|
|
8241
8543
|
export interface TestWebhookEndpointParams {
|
|
8242
8544
|
/** El evento a mandar. Por omisión invoice.stamped. */
|
|
8243
|
-
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";
|
|
8545
|
+
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" | "supplier_invoice.received" | "supplier_invoice.approved" | "supplier_invoice.rejected" | "supplier_invoice.scheduled" | "supplier_invoice.paid" | "portal_supplier.approved" | "issuer.ready" | "balance.low" | "test_clock.ready";
|
|
8244
8546
|
}
|
|
8245
8547
|
/** Los parámetros de GET /v1/events. */
|
|
8246
8548
|
export interface ListEventsParams {
|
|
@@ -8249,7 +8551,7 @@ export interface ListEventsParams {
|
|
|
8249
8551
|
/** El id del último de la página anterior, para la siguiente. */
|
|
8250
8552
|
starting_after?: string;
|
|
8251
8553
|
/** Solo de este tipo (invoice.stamped), o todos los de un recurso con un comodín (invoice.*). */
|
|
8252
|
-
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.*";
|
|
8554
|
+
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" | "supplier_invoice.received" | "supplier_invoice.approved" | "supplier_invoice.rejected" | "supplier_invoice.scheduled" | "supplier_invoice.paid" | "portal_supplier.approved" | "issuer.ready" | "balance.low" | "test_clock.ready" | "invoice.*" | "invoice_batch.*" | "payroll_batch.*" | "recurring_invoice.*" | "quote.*" | "sales_order.*" | "supplier_invoice.*" | "portal_supplier.*" | "ticket.*" | "retention.*" | "customer_data_request.*" | "sat_download.*" | "sat_declaration.*" | "issuer.*" | "balance.*" | "test_clock.*";
|
|
8253
8555
|
/** Solo los de este objeto (inv_…, ret_…, bat_…). */
|
|
8254
8556
|
object?: string;
|
|
8255
8557
|
/** false: los que algún webhook no recibió (su último intento falló). true: los que recibieron todos los webhooks a los que se mandaron. */
|
|
@@ -10045,6 +10347,111 @@ export declare class SatInvoicesResource {
|
|
|
10045
10347
|
*/
|
|
10046
10348
|
pdf(id: string, options?: RequestOptions): Promise<Uint8Array>;
|
|
10047
10349
|
}
|
|
10350
|
+
/** Descargas del SAT: fiscalisto.satRetentions. */
|
|
10351
|
+
export declare class SatRetentionsResource {
|
|
10352
|
+
#private;
|
|
10353
|
+
constructor(client: Client);
|
|
10354
|
+
/**
|
|
10355
|
+
* Listar constancias de retenciones
|
|
10356
|
+
*
|
|
10357
|
+
* Los CFDI de retenciones e información de pagos del emisor, como los muestra Facturas › Retenciones: los que recibió (descargados del SAT o subidos) o los que emitió, del más reciente al más antiguo, con las canceladas marcadas. Las que emite por la API también están en GET /v1/retentions.
|
|
10358
|
+
*
|
|
10359
|
+
* GET /v1/sat_retentions
|
|
10360
|
+
* @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/list-sat-retentions
|
|
10361
|
+
*/
|
|
10362
|
+
list(params?: ListSatRetentionsParams, options?: RequestOptions): List<SatRetention>;
|
|
10363
|
+
/**
|
|
10364
|
+
* Ver una constancia de retenciones
|
|
10365
|
+
*
|
|
10366
|
+
* Una constancia de retenciones del emisor, con sus montos, impuestos y estado.
|
|
10367
|
+
*
|
|
10368
|
+
* GET /v1/sat_retentions/{id}
|
|
10369
|
+
* @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/get-sat-retention
|
|
10370
|
+
*/
|
|
10371
|
+
get(id: string, options?: RequestOptions): Promise<SatRetention>;
|
|
10372
|
+
/**
|
|
10373
|
+
* Descargar el XML de una constancia de retenciones
|
|
10374
|
+
*
|
|
10375
|
+
* El CFDI de retenciones tal como llegó.
|
|
10376
|
+
*
|
|
10377
|
+
* GET /v1/sat_retentions/{id}/xml
|
|
10378
|
+
* @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/get-sat-retention-xml
|
|
10379
|
+
*/
|
|
10380
|
+
xml(id: string, options?: RequestOptions): Promise<string>;
|
|
10381
|
+
/**
|
|
10382
|
+
* Descargar el PDF de una constancia de retenciones
|
|
10383
|
+
*
|
|
10384
|
+
* La constancia en PDF, como la ofrece Facturas › Retenciones. El XML es el documento válido ante el SAT.
|
|
10385
|
+
*
|
|
10386
|
+
* GET /v1/sat_retentions/{id}/pdf
|
|
10387
|
+
* @see https://fiscalisto.com/docs/api/referencia/descargas-del-sat/get-sat-retention-pdf
|
|
10388
|
+
*/
|
|
10389
|
+
pdf(id: string, options?: RequestOptions): Promise<Uint8Array>;
|
|
10390
|
+
}
|
|
10391
|
+
/** Portal de proveedores: fiscalisto.portalSuppliers. */
|
|
10392
|
+
export declare class PortalSuppliersResource {
|
|
10393
|
+
#private;
|
|
10394
|
+
constructor(client: Client);
|
|
10395
|
+
/**
|
|
10396
|
+
* Listar proveedores del portal
|
|
10397
|
+
*
|
|
10398
|
+
* Los proveedores invitados o registrados en el Portal de proveedores del emisor, los más recientes primero: su alta, sus documentos, la cuenta a la que se le paga y su calificación.
|
|
10399
|
+
*
|
|
10400
|
+
* GET /v1/portal_suppliers
|
|
10401
|
+
* @see https://fiscalisto.com/docs/api/referencia/portal-de-proveedores/list-portal-suppliers
|
|
10402
|
+
*/
|
|
10403
|
+
list(params?: ListPortalSuppliersParams, options?: RequestOptions): List<PortalSupplier>;
|
|
10404
|
+
/**
|
|
10405
|
+
* Ver un proveedor del portal
|
|
10406
|
+
*
|
|
10407
|
+
* Su alta, sus documentos, su cuenta bancaria y su calificación por partes.
|
|
10408
|
+
*
|
|
10409
|
+
* GET /v1/portal_suppliers/{id}
|
|
10410
|
+
* @see https://fiscalisto.com/docs/api/referencia/portal-de-proveedores/get-portal-supplier
|
|
10411
|
+
*/
|
|
10412
|
+
get(id: string, options?: RequestOptions): Promise<PortalSupplier>;
|
|
10413
|
+
}
|
|
10414
|
+
/** Portal de proveedores: fiscalisto.supplierInvoices. */
|
|
10415
|
+
export declare class SupplierInvoicesResource {
|
|
10416
|
+
#private;
|
|
10417
|
+
constructor(client: Client);
|
|
10418
|
+
/**
|
|
10419
|
+
* Listar facturas de proveedores
|
|
10420
|
+
*
|
|
10421
|
+
* Las facturas que mandaron sus proveedores por el portal, las más recientes primero. Para llevar a su ERP lo aprobado: status=approved, o escuche supplier_invoice.approved.
|
|
10422
|
+
*
|
|
10423
|
+
* GET /v1/supplier_invoices
|
|
10424
|
+
* @see https://fiscalisto.com/docs/api/referencia/portal-de-proveedores/list-supplier-invoices
|
|
10425
|
+
*/
|
|
10426
|
+
list(params?: ListSupplierInvoicesParams, options?: RequestOptions): List<SupplierInvoice>;
|
|
10427
|
+
/**
|
|
10428
|
+
* Ver una factura de proveedor
|
|
10429
|
+
*
|
|
10430
|
+
* Con su estado, su orden de compra, su contrarecibo y sus fechas de pago. Su XML y su PDF: GET /v1/sat_invoices/{sat_invoice}/xml y /pdf.
|
|
10431
|
+
*
|
|
10432
|
+
* GET /v1/supplier_invoices/{id}
|
|
10433
|
+
* @see https://fiscalisto.com/docs/api/referencia/portal-de-proveedores/get-supplier-invoice
|
|
10434
|
+
*/
|
|
10435
|
+
get(id: string, options?: RequestOptions): Promise<SupplierInvoice>;
|
|
10436
|
+
/**
|
|
10437
|
+
* Programar el pago de una factura de proveedor
|
|
10438
|
+
*
|
|
10439
|
+
* El día en que la pagará, como «Programar pago» en la app: el proveedor lo ve en su portal y llega supplier_invoice.scheduled. Solo una aprobada o ya programada; si el SAT la reporta cancelada, 400 supplier_invoice_invalid.
|
|
10440
|
+
*
|
|
10441
|
+
* POST /v1/supplier_invoices/{id}/schedule
|
|
10442
|
+
* @see https://fiscalisto.com/docs/api/referencia/portal-de-proveedores/schedule-supplier-invoice
|
|
10443
|
+
*/
|
|
10444
|
+
schedule(id: string, params: ScheduleSupplierInvoiceParams, options?: RequestOptions): Promise<SupplierInvoice>;
|
|
10445
|
+
/**
|
|
10446
|
+
* Marcar pagada una factura de proveedor
|
|
10447
|
+
*
|
|
10448
|
+
* El pago que hizo su ERP o su banco, como «Marcar pagada» en la app: el proveedor lo ve, y si es PPD le pedimos su complemento de pago. Llega supplier_invoice.paid.
|
|
10449
|
+
*
|
|
10450
|
+
* POST /v1/supplier_invoices/{id}/mark_paid
|
|
10451
|
+
* @see https://fiscalisto.com/docs/api/referencia/portal-de-proveedores/mark-supplier-invoice-paid
|
|
10452
|
+
*/
|
|
10453
|
+
markPaid(id: string, params: MarkSupplierInvoicePaidParams, options?: RequestOptions): Promise<SupplierInvoice>;
|
|
10454
|
+
}
|
|
10048
10455
|
/** Declaraciones del SAT: fiscalisto.satDeclarations. */
|
|
10049
10456
|
export declare class SatDeclarationsResource {
|
|
10050
10457
|
#private;
|
|
@@ -10756,6 +11163,9 @@ export declare class FiscalistoApi extends Core {
|
|
|
10756
11163
|
readonly satLists: SatListsResource;
|
|
10757
11164
|
readonly satDownloads: SatDownloadsResource;
|
|
10758
11165
|
readonly satInvoices: SatInvoicesResource;
|
|
11166
|
+
readonly satRetentions: SatRetentionsResource;
|
|
11167
|
+
readonly portalSuppliers: PortalSuppliersResource;
|
|
11168
|
+
readonly supplierInvoices: SupplierInvoicesResource;
|
|
10759
11169
|
readonly satDeclarations: SatDeclarationsResource;
|
|
10760
11170
|
readonly tickets: TicketsResource;
|
|
10761
11171
|
readonly accounting: AccountingResource;
|