Extraction extractors
The following extractors are currently available:
invoice
Pulls issued and received Invoices, including the CFDI files.
You can customize the data pull process by using the following options:
| Option | Description | Type | Default Value |
|---|---|---|---|
| types | Filter by invoice type | array | ['I','E','P','N','T'] |
| period.from | Filter by issuing date (greater than) | string | 2014-01-01 |
| period.to | Filter by issuing date (less than) | string | now |
| issued | Include invoices issued by the taxpayer | bool | true |
| received | Include invoices received by the taxpayer | bool | true |
| xml | Include the invoice CFDI XML file | bool | true |
| Include the invoice CFDI PDF file | bool | true | |
| complement | Filter by complement | int | -1 |
annual_tax_return
Pulls annual Tax Returns, including the PDF files and payment data.
You can customize the data pull process by using the following options:
| Option | Description | Type | Default Value |
|---|---|---|---|
| period.from | Filter by filing date (greater than) | string | 2014-01-01 |
| period.to | Filter by filing date (less than) | string | now |
monthly_tax_return
Pulls provisional Tax Returns, including the PDF files and payment data.
You can customize the data pull process by using the following options:
| Option | Description | Type | Default Value |
|---|---|---|---|
| period.from | Filter by filing date (greater than) | string | 2014-01-01 |
| period.to | Filter by filing date (less than) | string | now |
electronic_accounting
Pulls trial balance and account catalogs.
You can customize the data pull process by using the following options:
| Option | Description | Type | Default Value |
|---|---|---|---|
| period.from | Filter by filing date (greater than) | string | 2014-01-01 |
| period.to | Filter by filing date (less than) | string | now |
rif_tax_return
Pulls Tax incorporation regime (RIF) Tax Returns which only aplies for physical person, including the PDF files and payment data.
You can customize the data pull process by using the following options:
| Option | Description | Type | Default Value |
|---|---|---|---|
| period.from | Filter by filing date (greater than) | string | 2014-01-01 |
| period.to | Filter by filing date (less than) | string | now |
tax_status
Pulls the taxpayer Tax Status.
No options available.
tax_compliance
Pulls the taxpayer Tax Compliance Check.
No options available.
rpc
Pulls the RPC data.
No options available.
tax_retention
Pulls issued and received Tax Retention, including the CFDI files.
You can customize the data pull process by using the following options:
| Option | Description | Type | Default Value |
|---|---|---|---|
| period.from | Filter by issuing date (greater than) | string | 2014-01-01 |
| period.to | Filter by issuing date (less than) | string | now |
| issued | Include tax retentions issued by the taxpayer | bool | true |
| received | Include tax retentions received by the taxpayer | bool | true |
| xml | Include the tax retention CFDI XML file | bool | true |
| Include the tax retention CFDI PDF file | bool | true | |
| complement | Filter by complement | int | -1 |
Extraction status
| Status | Description |
|---|---|
| pending | The initial extraction status. The extraction request is enqueued and waiting to be processed. |
| running | The extraction process started and is currently running. The running time varies depending on the extractor type and the taxpayer transactional volume. You may find partial data available in our API endpoints during this status. |
| finished | The extraction finished successfully, and all data is available to be pulled from our API endpoints. This is a final status. |
| failed | The extraction couldn't start or failed during the process, and our internal retry policies weren't able to finish the extraction successfully. We may have partial data available in our API endpoints, but new extractions should be created to ensure all taxpayer data is available. You can check the extraction error code to understand why it failed and determine whether it can be retried or not. This is a final status. |
| stopping | The extraction was requested to be stopped by the user. It is in the process of being stopped. |
| stopped | The extraction was stopped by the user. |
Extraction error codes
| Code | Description | Retryable |
|---|---|---|
| invalid_credentials | The taxpayer Credential is no longer valid. | No |
| login_failed | We couldn't log in the taxpayer account. | Yes |
| unrecoverable | The extraction process failed many times, and we reached a maximum number of retries. | Yes |
| sat_unavailable | We detected that SAT itself is down or unresponsive. | Yes |
| internal_error | We detected an internal error in our own infrastructure. | Yes |
| undefined | We couldn't determine the error cause and our internal team will investigate it. | Yes |