Extraction request examples

Use these examples when creating extractions through the API. Each request uses an entity IRI and an extractor name. Some extractors also accept options that control the period, direction, file types, or provider product. For endpoint details, see Create an extraction.

SAT

Invoices

{
  "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
  }
}

Set period.from and period.to explicitly to the range you want to extract. If omitted, period.from defaults to the start of the year three years ago and period.to defaults to the current date and time. Use issued and received to control the direction (CFDIs the entity emitted, received, or both), and xml and pdf to control which file types are downloaded. Keep xml and pdf enabled. XML downloads count toward SAT’s daily download limits; disable xml only when you are certain your use case requires it to be disabled. PDF downloads do not count toward those limits. Invoice payments, batch payments, line items, relations, and credit notes are derived from invoice CFDI data. Include type P invoices for payment records and type E invoices for credit notes when selecting invoice types.

Tax retentions

{
  "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
  }
}

Tax returns

Use the extractor for the tax return type you need.

Tax return data	Extractor
Annual returns	`annual_tax_return`
Provisional monthly returns	`monthly_tax_return`
RIF returns	`rif_tax_return`

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

Use monthly_tax_return or rif_tax_return in the same request shape when you need those return types.

Tax status

{
  "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
  "extractor": "tax_status"
}

Tax compliance checks

{
  "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
  "extractor": "tax_compliance"
}

Electronic accounting

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

SAT certificates

{
  "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
  "extractor": "sat_certificates"
}

RPC

{
  "entity": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "extractor": "rpc"
}

The rpc extractor creates RPC entidades, actos, and socios when the registry returns matching data.

RUG

{
  "entity": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "extractor": "rug"
}

The rug extractor creates RUG guarantees and operations when the registry returns matching data.

BIL

{
  "entity": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "extractor": "bil"
}

Buró de Crédito

The entity must have taxpayer data and a valid Buró de Crédito authorization before the extraction can run.

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

The productType option controls which Buró de Crédito product is requested.

Entity type	Supported `productType` values	Default
Person	`007`, `004`, `INFORME_BURO`	`007`
Company	`INFORME_BURO`, `RCO`	`INFORME_BURO`

Background checks

Run a background check for an entity. The background_check extractor can be used in one-off extractions and in recurring scheduler rules to keep screening results current for monitored entities.

{
  "entity": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "extractor": "background_check"
}

For the resulting records and PDF report, see Background checks.

Infonavit

Check whether an entity’s employer registration appears in the Infonavit Créditos Firmes list of firm (overdue) housing-credit obligations. The infonavit extractor matches on the entity name, so no SAT credentials are required.

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

The infonavit extractor does not accept any options. Send an empty options object or omit the field entirely. If the entity does not appear in the list, the extraction still finishes successfully and returns no records. For the resulting records, see Infonavit overdue credits.

Start here

API concepts

Integration guides

Extraction request examples

SAT

Invoices

Tax retentions

Tax returns

Tax status

Tax compliance checks

Electronic accounting

SAT certificates

RPC

RUG

BIL

Buró de Crédito

Background checks

Infonavit

​SAT

​Invoices

​Tax retentions

​Tax returns

​Tax status

​Tax compliance checks

​Electronic accounting

​SAT certificates

​RPC

​RUG

​BIL

​Buró de Crédito

​Background checks

​Infonavit

SAT

Invoices

Tax retentions

Tax returns

Tax status

Tax compliance checks

Electronic accounting

SAT certificates

RPC

RUG

BIL

Buró de Crédito

Background checks

Infonavit