GET
/
tax-retentions
/
{id}
Retrieve a tax retention
curl --request GET \
  --url https://api.syntage.com/tax-retentions/{id} \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/TaxRetention",
  "@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"
}

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Response

Tax retention resource response

​
@context
string
default:/contexts/TaxRetention
​
@id
string<iri-reference>

Invoice IRI reference

Example:

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

​
@type
string
default:TaxRetention
​
id
string<uuid>

Tax retention ID

Example:

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

​
uuid
string<uuid>

Tax retention UUID (Folio fiscal)

Example:

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

​
version
number | null

CFDI version

Example:

1

​
code
string | null

Tax retention code

Example:

25

​
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"

​
issuer
object
Example:
{
  "rfc": "AOM920820BEA",
  "name": "APPLE OPERATIONS MEXICO S.A. DE C.V."
}
​
receiver
object
​
pac
string

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

Required string length: 12
Example:

"SAT970701NN3"

​
internalIdentifier
string | null

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

Maximum length: 40
Example:

"00001"

​
issuedAt
string<date-time>

Tax retention issue date

Example:

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

​
certifiedAt
string<date-time>

Tax return certification date

Example:

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

​
canceledAt
string<date-time> | null

Set when the tax retention is canceled.

​
items
object[]
​
totalOperationAmount
number

Operation amount

Example:

53249.8

​
totalTaxableAmount
number

Subtraction between totalOperationAmount and totalExemptAmount

Example:

43249

​
totalExemptAmount
number

Exempt amount

Example:

1000.8

​
totalRetainedAmount
number

Tax reteined amount

Example:

1550.7

​
periodFrom
string<date-time> | null

Date when starts the tax retention period

​
periodTo
string<date-time> | null

Date when finishes the tax retention period

​
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

​
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

​
createdAt
string

Date and time the resource was created

Example:

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

​
updatedAt
string

Date and time the resource was last updated

Example:

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