List all extractions

Authorizations

X-API-Key

string

header

required

Your API key is available in the Production and Sandbox dashboards.

Query Parameters

taxpayer.id

string

Filter by taxpayer ID (exact match) RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

extractor

enum<string>

Filter by extractor (partial match) The extractor to be executed. Extracts various resources from the corresponding datasources.

Available options:

invoice,

monthly_tax_return,

annual_tax_return,

rif_tax_return,

tax_status,

tax_retention,

tax_compliance,

electronic_accounting,

rpc,

buro_de_credito_report,

bil,

rug

status

enum<string>

Filter by status (exact match)

Available options:

pending,

running,

finished,

failed,

stopping,

stopped

startedAt[before]

string<date-time>

Filter by start date (less than or equal <=)

startedAt[strictly_before]

string<date-time>

Filter by start date (less than <)

startedAt[after]

string<date-time>

Filter by start date (greater than or equal >=)

startedAt[strictly_after]

string<date-time>

Filter by start date (greater than >)

finishedAt[before]

string<date-time>

Filter by finished date (less than or equal <=)

finishedAt[strictly_before]

string<date-time>

Filter by finished date (less than <)

finishedAt[after]

string<date-time>

Filter by finished date (greater than or equal >=)

finishedAt[strictly_after]

string<date-time>

Filter by finished date (greater than >)

exists[rateLimitedAt]

boolean

Filter extractions that was rate limited by SAT

Example:

true

createdAt[before]

string<date-time>

Filter by resource creation date (less than or equal <=)

createdAt[strictly_before]

string<date-time>

Filter by resource creation date (less than <)

createdAt[after]

string<date-time>

Filter by resource creation date (greater than or equal >=)

createdAt[strictly_after]

string<date-time>

Filter by resource creation date (greater than >)

order[startedAt]

enum<string>

Order by start date

Available options:

asc,

desc

Example:

"asc"

order[finishedAt]

enum<string>

Order by finished date

Available options:

asc,

desc

Example:

"asc"

order[createdAt]

enum<string>

Order by resource creation date

Available options:

asc,

desc

Example:

"asc"

order[updatedAt]

enum<string>

Order by resource update date

Available options:

asc,

desc

Example:

"asc"

id[lt]

string

The collection cursor pointer to the next page

id[gt]

string

The collection cursor pointer to the previous page

itemsPerPage

integer

default:20

The number of items per page

Required range: 1 <= x <= 1000

Response

Extraction collection response

@context

string

default:/contexts/Extraction

@id

string

default:/extractions

@type

string

default:hydra:Collection

hydra:member

object[]

Show child attributes

hydra:member.@id

string<iri-reference>

Extraction IRI reference

Example:

"/extractions/91106968-1abd-4d64-85c1-4e73d96fb997"

hydra:member.@type

string

default:Extraction

hydra:member.id

string<uuid>

Example:

"91106968-1abd-4d64-85c1-4e73d96fb997"

hydra:member.taxpayer

object

Show child attributes

hydra:member.taxpayer.@id

string<iri-reference>

Taxpayer IRI reference

Example:

"/taxpayers/PEIC211118IS0"

hydra:member.taxpayer.@type

string

default:Taxpayer

hydra:member.taxpayer.id

string

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

hydra:member.taxpayer.personType

enum<string>

Available options:

physical,

legal

Example:

"physical"

hydra:member.taxpayer.registrationDate

string<date>

hydra:member.taxpayer.name

string

Taxpayer name

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

hydra:member.extractor

enum<string>

The extractor to be executed. Extracts various resources from the corresponding datasources.

Available options:

invoice,

monthly_tax_return,

annual_tax_return,

rif_tax_return,

tax_status,

tax_retention,

tax_compliance,

electronic_accounting,

rpc,

buro_de_credito_report,

bil,

rug

hydra:member.options

object

The extractor options. Check the available options for each extractor in Extractions.

Example:

{
  "types": ["I", "E", "P"],
  "period": {
    "from": "2020-01-01T00:00:00.000Z",
    "to": "2020-03-31T23:59:59.000Z"
  }
}

hydra:member.status

enum<string>

Available options:

pending,

running,

finished,

failed,

stopping,

stopped

hydra:member.startedAt

string<date-time> | null

Time when the status changed from pending to running

hydra:member.finishedAt

string<date-time> | null

Time when the status changed from running to finished or failed

hydra:member.rateLimitedAt

string<date-time>

This field returns a date when the taxpayer reached the max amount of downloaded CFDI files allowed by SAT in a range of 24hrs. You should retry this extraction 24hrs later. If your taxpayer has not reached the max amount this value should be NULL

Example:

"2019-01-03T21:10:40.000Z"

hydra:member.errorCode

enum<string> | null

Extraction error code

Available options:

invalid_credentials,

login_failed,

unrecoverable,

sat_unavailable,

internal_error,

undefined

Example:

null

hydra:member.createdDataPoints

integer

This is the number of created resources. For example, if 1 invoice was created with its XML and PDF file this value should be 3. And If you previously extracted all the resources and there are no more resources to create this value is 0.

Example:

3

hydra:member.updatedDataPoints

integer

When your taxpayer has resources by a previous extraction and new extraction found changes between our data and Sat data it would update this resource. For example, when a new extraction finds a Canceled invoice which you previously extracted as an Active invoice.

Example:

2

hydra:member.createdAt

string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

hydra:member.updatedAt

string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"

hydra:view

object

Pagination information

Show child attributes

hydra:view.@id

string<iri-reference>

Current page IRI reference

hydra:view.@type

string

default:hydra:PartialCollectionView

hydra:view.hydra:next

string

Next page IRI reference. This property is omitted if there is no pagination.

Example:

"/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367"

hydra:view.hydra:last

string

Last page IRI reference. This property is omitted if there is no pagination.

Example:

"/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"

hydra:search

object

Show child attributes

hydra:search.@type

string

hydra:search.hydra:template

string

hydra:search.hydra:variableRepresentation

string

hydra:search.hydra:mapping

object[]

Show child attributes

hydra:search.hydra:mapping.@type

string

hydra:search.hydra:mapping.variable

string

hydra:search.hydra:mapping.property

string

hydra:search.hydra:mapping.required

boolean

Core Resources

Extractions

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Insights

Webhooks

Miscellaneous

List all extractions

Authorizations

Query Parameters

Response