GET
/
tax-returns
/
{id}
Retrieve a tax return
curl --request GET \
  --url https://api.syntage.com/tax-returns/{id} \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/TaxReturn",
  "@id": "/tax-returns/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "TaxReturn",
  "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
  "taxpayer": {
    "@id": "/taxpayers/PEIC211118IS0",
    "@type": "Taxpayer",
    "id": "PEIC211118IS0",
    "personType": "physical",
    "registrationDate": "2023-12-25",
    "name": "Pedro Infante Cruz"
  },
  "operationNumber": 200100172932,
  "intervalUnit": "Mensual",
  "period": "Diciembre",
  "fiscalYear": 2019,
  "type": "Complementaria",
  "complementary": "Modificación de Obligaciones",
  "presentedAt": "2023-11-07T05:31:56Z",
  "captureLine": "042007HZ795527888246",
  "files": [
    {
      "@id": "/files/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "File",
      "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
      "type": "<string>",
      "resource": "<string>",
      "mimeType": "<string>",
      "extension": "<string>",
      "size": 40544,
      "filename": "<string>",
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "payment": {
    "dueAmount": 53249.8,
    "dueDate": "2019-01-03T21:10:40.000Z",
    "code": "0777555544443332222",
    "bank": "BBVA Bancomer, S.A.",
    "paidAmount": 123,
    "date": "2023-11-07T05:31:56Z",
    "operationNumber": "123456"
  },
  "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

Tax Return ID

Example:

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

Response

Tax return resource response

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

Tax Return IRI reference

Example:

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

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

Tax Return ID

Example:

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

​
taxpayer
object
​
operationNumber
number

Tax return operation code generated by SAT (Número de operación)

Example:

200100172932

​
intervalUnit
enum<string>
Available options:
Anual,
Mensual,
RIF
Example:

"Mensual"

​
period
string

Fiscal period. For an annual tax return, it is a year and for monthly tax return it is a month

Example:

"Diciembre"

​
fiscalYear
string

Fiscal year

Example:

2019

​
type
enum<string>
Available options:
Complementaria,
Complementaria Corrección Fiscal,
Complementaria Dictamen,
Normal,
Normal por Corrección Fiscal
Example:

"Complementaria"

​
complementary
enum<string> | null

Set when type is complementaria*

Available options:
Declaración no Presentada,
Dejar sin Efecto Declaración,
Dejar sin Efecto Obligación,
Esquema Anterior,
Modificación de Declaración,
Modificación de Obligaciones,
Obligación no presentada
Example:

"Modificación de Obligaciones"

​
presentedAt
string<date-time>

Tax return filing date

​
captureLine
string | null

Set when the an amount should be paid back to SAT

Example:

"042007HZ795527888246"

​
files
object[]

Tax return PDF files (ack receipt, transcript and payment receipt)

​
payment
object

Payment

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