List tax retentions

Authorizations

X-API-Key

string

header

required

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

Path Parameters

string

required

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

Query Parameters

uuid

string<uuid>

Filter by UUID/Folio Fiscal (exact match) Tax retention UUID (Folio fiscal)

Example:

"def404af-5eef-4112-aa99-d1ec8493b89a"

version

number<float> | null

CFDI version

Example:

1

internalIdentifier

string | null

Internal identifier (exact match) It is an open field for internal identification. Communly it is used to identify a tax retention

Maximum string length: 40

Example:

"00001"

pac

string

Filter by certification provider (partial match) Certification provider tax ID (Proveedor Autorizado de Certificación)

Required string length: 12

Example:

"SAT970701NN3"

code

string | null

Filter by code (exact match) Tax retention code

Example:

25

issuer.rfc

string

Filter by issuer RFC (partial match) RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

issuer.name

string

Filter by issuer name (partial match) Taxpayer name

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

issuer.curp

string

Filter by issuer CURP (partial match) Unique Population Registry Code (CURP)

Required string length: 18

Example:

"PEIC123456ABCDEF12"

receiver.rfc

string

Filter by receiver RFC (partial match) RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

receiver.name

string

Filter by receiver name (partial match) Taxpayer name

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

receiver.curp

string

Filter by receiver CURP (partial match) Unique Population Registry Code (CURP)

Required string length: 18

Example:

"PEIC123456ABCDEF12"

receiver.nationality

enum<string>

Filter by receiver nationality (exact match) Indicator to know if the taxpayer is Mexican or from other countries.

Available options:

national,

foreign

Example:

"national"

totalOperationAmount[between]

string

Filter by total operation amount between two values

totalOperationAmount[gt]

number

Filter by total operation amount (greater than >)

totalOperationAmount[gte]

number

Filter by total operation amount (greater than or equal >=)

totalOperationAmount[lt]

number

Filter by total operation amount (less than <)

totalOperationAmount[lte]

number

Filter by total operation amount (less than or equal <=)

totalTaxableAmount[between]

string

Filter by total taxable amount between two values

totalTaxableAmount[gt]

number

Filter by total taxable amount (greater than >)

totalTaxableAmount[gte]

number

Filter by total taxable amount (greater than or equal >=)

totalTaxableAmount[lt]

number

Filter by total taxable amount (less than <)

totalTaxableAmount[lte]

number

Filter by total taxable amount (less than or equal <=)

totalExemptAmount[between]

string

Filter by total exempt amount between two values

totalExemptAmount[gt]

number

Filter by total exempt amount (greater than >)

totalExemptAmount[gte]

number

Filter by total exempt amount (greater than or equal >=)

totalExemptAmount[lt]

number

Filter by total exempt amount (less than <)

totalExemptAmount[lte]

number

Filter by total exempt amount (less than or equal <=)

totalRetainedAmount[between]

string

Filter by total retained amount between two values

totalRetainedAmount[gt]

number

Filter by total retained amount (greater than >)

totalRetainedAmount[gte]

number

Filter by total retained amount (greater than or equal >=)

totalRetainedAmount[lt]

number

Filter by total retained amount (less than <)

totalRetainedAmount[lte]

number

Filter by total retained amount (less than or equal <=)

issuedAt[before]

string<date-time>

Filter by issue date (less than or equal <=) Tax retention issue date

Example:

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

issuedAt[strictly_before]

string<date-time>

Filter by issue date (less than <) Tax retention issue date

Example:

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

issuedAt[after]

string<date-time>

Filter by issue date (greater than or equal >=) Tax retention issue date

Example:

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

issuedAt[strictly_after]

string<date-time>

Filter by issue date (greater than >) Tax retention issue date

Example:

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

canceledAt[before]

string<date-time> | null

Filter by cancellation date (less than or equal <=) Set when the tax retention is canceled.

canceledAt[strictly_before]

string<date-time> | null

Filter by cancellation date (less than <) Set when the tax retention is canceled.

canceledAt[after]

string<date-time> | null

Filter by cancellation date (greater than or equal >=) Set when the tax retention is canceled.

canceledAt[strictly_after]

string<date-time> | null

Filter by cancellation date (greater than >) Set when the tax retention is canceled.

certifiedAt[before]

string<date-time>

Filter by certification date (less than or equal <=) Tax return certification date

Example:

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

certifiedAt[strictly_before]

string<date-time>

Filter by certification date (less than <) Tax return certification date

Example:

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

certifiedAt[after]

string<date-time>

Filter by certification date (greater than or equal >=) Tax return certification date

Example:

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

certifiedAt[strictly_after]

string<date-time>

Filter by certification date (greater than >) Tax return certification date

Example:

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

periodFrom[before]

string<date-time> | null

Filter by "period from" date (less than or equal <=) Date when starts the tax retention period

periodFrom[strictly_before]

string<date-time> | null

Filter by "period from" date (less than <) Date when starts the tax retention period

periodFrom[after]

string<date-time> | null

Filter by "period from" date (greater than or equal >=) Date when starts the tax retention period

periodFrom[strictly_after]

string<date-time> | null

Filter by "period from" date (greater than >) Date when starts the tax retention period

periodTo[before]

string<date-time> | null

Filter by "period to" date (less than or equal <=) Date when finishes the tax retention period

periodTo[strictly_before]

string<date-time> | null

Filter by "period to" date (less than <) Date when finishes the tax retention period

periodTo[after]

string<date-time> | null

Filter by "period to" date (greater than or equal >=) Date when finishes the tax retention period

periodTo[strictly_after]

string<date-time> | null

Filter by "period to" date (greater than >) Date when finishes the tax retention period

hasXml

boolean

Filter by tax retentions that have the CFDI available in XML format true when the CFDI is available in the XML format. The file can be downloaded through the retrieve a tax retention CFDI operation

hasPdf

boolean

Filter by tax retentions that have the CFDI available in PDF format true when the CFDI is available in the PDF format. The file can be downloaded through the retrieve a tax retention CFDI operation

order[issuedAt]

enum<string>

Order by issue date

Available options:

asc,

desc

Example:

"asc"

order[canceledAt]

enum<string>

Order by cancellation date

Available options:

asc,

desc

Example:

"asc"

order[certifiedAt]

enum<string>

Order by certification date

Available options:

asc,

desc

Example:

"asc"

order[periodFrom]

enum<string>

Order by "period from" date

Available options:

asc,

desc

Example:

"asc"

order[periodTo]

enum<string>

Order by "period to" date

Available options:

asc,

desc

Example:

"asc"

order[totalOperationAmount]

enum<string>

Order by total operation amount date

Available options:

asc,

desc

Example:

"asc"

order[totalTaxableAmount]

enum<string>

Order by total taxable amount date

Available options:

asc,

desc

Example:

"asc"

order[totalExemptAmount]

enum<string>

Order by total exempt amount date

Available options:

asc,

desc

Example:

"asc"

order[totalRetainedAmount]

enum<string>

Order by total retained amount 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

Taxpayer tax retention collection response

@context

string

default:/contexts/TaxRetention

@id

string

default:/taxpayers/{id}/tax-retentions

Example:

"/taxpayers/PEIC211118IS0/tax-retentions"

@type

string

default:hydra:Collection

hydra:member

object[]

Show child attributes

hydra:member.@id

string<iri-reference>

Invoice IRI reference

Example:

"/tax-retentions/91106968-1abd-4d64-85c1-4e73d96fb997"

hydra:member.@type

string

default:TaxRetention

hydra:member.id

string<uuid>

Tax retention ID

Example:

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

hydra:member.uuid

string<uuid>

Tax retention UUID (Folio fiscal)

Example:

"def404af-5eef-4112-aa99-d1ec8493b89a"

hydra:member.version

number<float> | null

CFDI version

Example:

1

hydra:member.code

string | null

Tax retention code

Example:

25

hydra:member.description

string | null

It describes a retention type that is not defined in the SAT's catalog. Only set when code is 25 (other retention types).

Example:

"Información referente a la fiduciaria"

hydra:member.issuer

object

Show child attributes

hydra:member.issuer.rfc

string

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

hydra:member.issuer.name

string

Taxpayer name

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

hydra:member.issuer.curp

string

Unique Population Registry Code (CURP)

Required string length: 18

Example:

"PEIC123456ABCDEF12"

Example:

{
  "rfc": "AOM920820BEA",
  "name": "APPLE OPERATIONS MEXICO S.A. DE C.V."
}

hydra:member.receiver

object

Show child attributes

hydra:member.receiver.rfc

string

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

hydra:member.receiver.name

string

Taxpayer name

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

hydra:member.receiver.nationality

enum<string>

Indicator to know if the taxpayer is Mexican or from other countries.

Available options:

national,

foreign

Example:

"national"

hydra:member.receiver.curp

string

Unique Population Registry Code (CURP)

Required string length: 18

Example:

"PEIC123456ABCDEF12"

hydra:member.pac

string

Certification provider tax ID (Proveedor Autorizado de Certificación)

Required string length: 12

Example:

"SAT970701NN3"

hydra:member.internalIdentifier

string | null

It is an open field for internal identification. Communly it is used to identify a tax retention

Maximum string length: 40

Example:

"00001"

hydra:member.issuedAt

string<date-time>

Tax retention issue date

Example:

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

hydra:member.certifiedAt

string<date-time>

Tax return certification date

Example:

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

hydra:member.canceledAt

string<date-time> | null

Set when the tax retention is canceled.

hydra:member.items

object[]

Show child attributes

hydra:member.items.baseAmount

number<float>

Example:

45905

hydra:member.items.taxType

string

Example:

"002"

hydra:member.items.retainedAmount

number<float>

Example:

7344

hydra:member.items.paymentType

enum<string>

Available options:

provisional,

definitive

Example:

"provisional"

hydra:member.totalOperationAmount

number<float>

Operation amount

Example:

53249.8

hydra:member.totalTaxableAmount

number<float>

Subtraction between totalOperationAmount and totalExemptAmount

Example:

43249

hydra:member.totalExemptAmount

number<float>

Exempt amount

Example:

1000.8

hydra:member.totalRetainedAmount

number<float>

Tax reteined amount

Example:

1550.7

hydra:member.periodFrom

string<date-time> | null

Date when starts the tax retention period

hydra:member.periodTo

string<date-time> | null

Date when finishes the tax retention period

hydra:member.pdf

boolean

true when the CFDI is available in the PDF format. The file can be downloaded through the retrieve a tax retention CFDI operation

hydra:member.xml

boolean

true when the CFDI is available in the XML format. The file can be downloaded through the retrieve a tax retention CFDI operation

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 tax retentions

Authorizations

Path Parameters

Query Parameters

Response