List an entity's tax retentions

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

{
  "@context": "/contexts/TaxRetention",
  "@id": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997/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

entities

{entityId}

tax-retentions

List an entity's tax retentions

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

{
  "@context": "/contexts/TaxRetention",
  "@id": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997/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

entityId

string<uuid>

required

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) An open field for internal identification. Commonly 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

enum<string> | null

Filter by code (exact match) Retention type code from the Clave de retenciones catalog

Available options:

01,

02,

03,

04,

05,

06,

07,

08,

09,

10,

11,

12,

13,

14,

15,

16,

17,

18,

19,

20,

21,

22,

23,

24,

25,

26

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 <=) Start date for the tax retention period

periodFrom[strictly_before]

string<date-time> | null

Filter by "period from" date (less than <) Start date for the tax retention period

periodFrom[after]

string<date-time> | null

Filter by "period from" date (greater than or equal >=) Start date for the tax retention period

periodFrom[strictly_after]

string<date-time> | null

Filter by "period from" date (greater than >) Start date for the tax retention period

periodTo[before]

string<date-time> | null

Filter by "period to" date (less than or equal <=) End date for the tax retention period

periodTo[strictly_before]

string<date-time> | null

Filter by "period to" date (less than <) End date for the tax retention period

periodTo[after]

string<date-time> | null

Filter by "period to" date (greater than or equal >=) End date for the tax retention period

periodTo[strictly_after]

string<date-time> | null

Filter by "period to" date (greater than >) End date for 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

Collection cursor pointer to the next page

id[gt]

string

Collection cursor pointer to the previous page

itemsPerPage

integer

default:20

Number of items per page

Required range: 1 <= x <= 1000

Response

Taxpayer tax retention collection response

@context

string

default:/contexts/TaxRetention

@id

string

default:/entities/{entityId}/tax-retentions

Example:

"/entities/91106968-1abd-4d64-85c1-4e73d96fb997/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