> ## Documentation Index
> Fetch the complete documentation index at: https://docs.syntage.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ejemplos de solicitudes de extracción

> Cuerpos de solicitud de extracción de ejemplo para recursos comunes de Syntage.

Usa estos ejemplos al crear extracciones a través de la API. Cada solicitud utiliza una IRI de entidad y un nombre de extractor. Algunos extractores también aceptan opciones que controlan el periodo, la dirección, los tipos de archivo o el producto del proveedor.

Para detalles del endpoint, consulta [Crear una extracción](https://docs.syntage.com/api-reference/extractions/create-an-extraction.md).

## SAT

### Facturas

```json theme={null}
{
  "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
  "extractor": "invoice",
  "options": {
    "period": {
      "from": "2024-01-01",
      "to": "2024-12-31"
    },
    "issued": true,
    "received": true,
    "xml": true,
    "pdf": true
  }
}
```

Establece `period.from` y `period.to` explícitamente con el rango que quieres extraer. Si se omiten, `period.from` toma como valor por defecto el inicio del año de hace tres años y `period.to`, la fecha y hora actuales. Usa `issued` y `received` para controlar la dirección (CFDIs que la entidad emitió, recibió o ambos), y `xml` y `pdf` para controlar qué tipos de archivo se descargan. Mantén `xml` y `pdf` habilitados. Las descargas de XML cuentan para los límites diarios de descarga del SAT; deshabilita `xml` solo si tienes la certeza de que tu caso de uso requiere deshabilitarlo. Las descargas de PDF no cuentan para esos límites.

Los pagos de facturas, pagos en lote, conceptos, relaciones y notas de crédito se derivan de los datos de CFDI de las facturas. Incluye facturas tipo `P` para registros de pago y facturas tipo `E` para notas de crédito al seleccionar los tipos de factura.

### Retenciones de impuestos

```json theme={null}
{
  "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
  "extractor": "tax_retention",
  "options": {
    "period": {
      "from": "2024-01-01",
      "to": "2024-12-31"
    },
    "issued": true,
    "received": true,
    "xml": true,
    "pdf": true
  }
}
```

### Declaraciones de impuestos

Usa el extractor para el tipo de declaración que necesites.

| Datos de declaración | Extractor |
| - | - |
| Declaraciones anuales | `annual_tax_return` |
| Declaraciones provisionales mensuales | `monthly_tax_return` |
| Declaraciones de RIF | `rif_tax_return` |

```json theme={null}
{
  "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
  "extractor": "annual_tax_return",
  "options": {
    "period": {
      "from": "2020-01-01",
      "to": "2024-12-31"
    }
  }
}
```

Usa `monthly_tax_return` o `rif_tax_return` con la misma forma de solicitud cuando necesites esos tipos de declaración.

### Situación fiscal

```json theme={null}
{
  "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
  "extractor": "tax_status"
}
```

### Verificación de cumplimiento fiscal

```json theme={null}
{
  "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
  "extractor": "tax_compliance"
}
```

### Contabilidad electrónica

```json theme={null}
{
  "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
  "extractor": "electronic_accounting",
  "options": {
    "period": {
      "from": "2023-01-01",
      "to": "2024-12-31"
    }
  }
}
```

### Certificados del SAT

```json theme={null}
{
  "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
  "extractor": "sat_certificates"
}
```

## RPC

```json theme={null}
{
  "entity": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "extractor": "rpc"
}
```

El extractor `rpc` crea entidades, actos y socios del RPC cuando el registro devuelve datos coincidentes.

## RUG

```json theme={null}
{
  "entity": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "extractor": "rug"
}
```

El extractor `rug` crea garantías y operaciones del RUG cuando el registro devuelve datos coincidentes.

## BIL

```json theme={null}
{
  "entity": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "extractor": "bil"
}
```

## Buró de Crédito

La entidad debe tener datos de contribuyente y una autorización válida de Buró de Crédito antes de que la extracción pueda ejecutarse.

```json theme={null}
{
  "entity": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "extractor": "buro_de_credito_report",
  "options": {
    "productType": "007"
  }
}
```

La opción `productType` controla qué producto de Buró de Crédito se solicita.

| Tipo de entidad | Valores soportados de `productType` | Predeterminado |
| - | - | - |
| Persona | `007`, `004`, `INFORME_BURO` | `007` |
| Empresa | `INFORME_BURO`, `RCO` | `INFORME_BURO` |

## Verificación de antecedentes

Ejecuta una verificación de antecedentes para una entidad. El extractor `background_check` puede usarse en extracciones puntuales y en reglas de planificadores recurrentes para mantener actualizados los resultados de las entidades monitoreadas.

```json theme={null}
{
  "entity": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "extractor": "background_check"
}
```

Para los registros y el reporte PDF resultantes, consulta [Verificación de antecedentes](https://docs.syntage.com/es/resources/other/background-checks.md).

## Infonavit

Verifica si el registro patronal de una entidad aparece en la lista Créditos Firmes de Infonavit de obligaciones de crédito de vivienda firmes (vencidas). El extractor `infonavit` coteja por el nombre de la entidad, por lo que no se requieren credenciales del SAT.

```json theme={null}
{
  "entity": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "extractor": "infonavit",
  "options": {}
}
```

El extractor `infonavit` no acepta ninguna opción. Envía un objeto `options` vacío u omite el campo por completo. Si la entidad no aparece en la lista, la extracción termina exitosamente y no devuelve registros.

Para los registros resultantes, consulta [Créditos firmes de Infonavit](https://docs.syntage.com/es/resources/datasources/infonavit/overdue-credits.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.