List tax retentions

curl --request GET \
  --url https://api.syntage.com/taxpayers/{id}/tax-retentions \
  --header 'X-API-Key: <api-key>'

{
  "@context": "<string>",
  "@id": "/taxpayers/PEIC211118IS0/tax-retentions",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/tax-retentions/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "TaxRetention",
      "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
      "uuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
      "version": 1,
      "code": 25,
      "description": "Información referente a la fiduciaria",
      "issuer": {
        "rfc": "AOM920820BEA",
        "name": "APPLE OPERATIONS MEXICO S.A. DE C.V."
      },
      "receiver": {
        "rfc": "PEIC211118IS0",
        "name": "Pedro Infante Cruz",
        "nationality": "national",
        "curp": "PEIC123456ABCDEF12"
      },
      "pac": "SAT970701NN3",
      "internalIdentifier": "00001",
      "issuedAt": "2019-01-03T21:10:40.000Z",
      "certifiedAt": "2019-01-03T21:10:41.000Z",
      "canceledAt": "2023-11-07T05:31:56Z",
      "items": [
        {
          "baseAmount": 45905,
          "taxType": "002",
          "retainedAmount": 7344,
          "paymentType": "provisional"
        }
      ],
      "totalOperationAmount": 53249.8,
      "totalTaxableAmount": 43249,
      "totalExemptAmount": 1000.8,
      "totalRetainedAmount": 1550.7,
      "periodFrom": "2023-11-07T05:31:56Z",
      "periodTo": "2023-11-07T05:31:56Z",
      "pdf": true,
      "xml": true,
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
    "hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

GET

taxpayers

{id}

tax-retentions

List tax retentions

curl --request GET \
  --url https://api.syntage.com/taxpayers/{id}/tax-retentions \
  --header 'X-API-Key: <api-key>'

{
  "@context": "<string>",
  "@id": "/taxpayers/PEIC211118IS0/tax-retentions",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/tax-retentions/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "TaxRetention",
      "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
      "uuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
      "version": 1,
      "code": 25,
      "description": "Información referente a la fiduciaria",
      "issuer": {
        "rfc": "AOM920820BEA",
        "name": "APPLE OPERATIONS MEXICO S.A. DE C.V."
      },
      "receiver": {
        "rfc": "PEIC211118IS0",
        "name": "Pedro Infante Cruz",
        "nationality": "national",
        "curp": "PEIC123456ABCDEF12"
      },
      "pac": "SAT970701NN3",
      "internalIdentifier": "00001",
      "issuedAt": "2019-01-03T21:10:40.000Z",
      "certifiedAt": "2019-01-03T21:10:41.000Z",
      "canceledAt": "2023-11-07T05:31:56Z",
      "items": [
        {
          "baseAmount": 45905,
          "taxType": "002",
          "retainedAmount": 7344,
          "paymentType": "provisional"
        }
      ],
      "totalOperationAmount": 53249.8,
      "totalTaxableAmount": 43249,
      "totalExemptAmount": 1000.8,
      "totalRetainedAmount": 1550.7,
      "periodFrom": "2023-11-07T05:31:56Z",
      "periodTo": "2023-11-07T05:31:56Z",
      "pdf": true,
      "xml": true,
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
    "hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

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)

Example:

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

version

number | null

Filter by CFDI version (exact match)

Example:

1

internalIdentifier

string | null

Internal identifier (exact match)

Maximum length: 40

Example:

"00001"

pac

string

Filter by certification provider (partial match)

Required string length: 12

Example:

"SAT970701NN3"

code

string | null

Filter by code (exact match)

Example:

25

issuer.rfc

string

Filter by issuer RFC (partial match)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

issuer.name

string

Filter by issuer name (partial match)

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

issuer.curp

string

Filter by issuer CURP (partial match)

Required string length: 18

Example:

"PEIC123456ABCDEF12"

receiver.rfc

string

Filter by receiver RFC (partial match)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

receiver.name

string

Filter by receiver name (partial match)

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

receiver.curp

string

Filter by receiver CURP (partial match)

Required string length: 18

Example:

"PEIC123456ABCDEF12"

receiver.nationality

enum<string>

Filter by receiver nationality (exact match)

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 <=)

Example:

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

issuedAt[strictly_before]

string<date-time>

Filter by issue date (less than <)

Example:

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

issuedAt[after]

string<date-time>

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

Example:

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

issuedAt[strictly_after]

string<date-time>

Filter by issue date (greater than >)

Example:

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

canceledAt[before]

string<date-time> | null

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

canceledAt[strictly_before]

string<date-time> | null

Filter by cancellation date (less than <)

canceledAt[after]

string<date-time> | null

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

canceledAt[strictly_after]

string<date-time> | null

Filter by cancellation date (greater than >)

certifiedAt[before]

string<date-time>

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

Example:

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

certifiedAt[strictly_before]

string<date-time>

Filter by certification date (less than <)

Example:

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

certifiedAt[after]

string<date-time>

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

Example:

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

certifiedAt[strictly_after]

string<date-time>

Filter by certification date (greater than >)

Example:

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

periodFrom[before]

string<date-time> | null

Filter by "period from" date (less than or equal <=)

periodFrom[strictly_before]

string<date-time> | null

Filter by "period from" date (less than <)

periodFrom[after]

string<date-time> | null

Filter by "period from" date (greater than or equal >=)

periodFrom[strictly_after]

string<date-time> | null

Filter by "period from" date (greater than >)

periodTo[before]

string<date-time> | null

Filter by "period to" date (less than or equal <=)

periodTo[strictly_before]

string<date-time> | null

Filter by "period to" date (less than <)

periodTo[after]

string<date-time> | null

Filter by "period to" date (greater than or equal >=)

periodTo[strictly_after]

string<date-time> | null

Filter by "period to" date (greater than >)

hasXml

boolean

Filter by tax retentions that have the CFDI available in XML format

hasPdf

boolean

Filter by tax retentions that have the CFDI available in PDF format

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:view

object

Pagination information

Show child attributes

hydra:search

object

Show child attributes

Retrieve a tax retention CFDI Retrieve a tax return

⌘I

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