Skip to main content
GET
/
taxpayers
/
{id}
/
tax-returns
List tax returns
curl --request GET \
  --url https://api.syntage.com/taxpayers/{id}/tax-returns \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/TaxReturn",
  "@id": "/taxpayers/PEIC211118IS0/tax-returns",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@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"
    }
  ],
  "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

​
id
string
required

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13
Example:

"PEIC211118IS0"

Query Parameters

​
operationNumber
number

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

Example:

200100172932

​
type
enum<string>

Filter by type (exact match)

Available options:
Complementaria,
Complementaria Corrección Fiscal,
Complementaria Dictamen,
Normal,
Normal por Corrección Fiscal
Example:

"Complementaria"

​
intervalUnit
enum<string>

Filter by interval unit (exact match)

Available options:
Anual,
Mensual,
RIF
Example:

"Mensual"

​
complementary
enum<string> | null

Filter by interval unit (partial match) 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"

​
captureLine
string | null

Filter by payment code (partial match) Set when the an amount should be paid back to SAT

Example:

"042007HZ795527888246"

​
period
string

Filter by period (exact match) Fiscal period. For an annual tax return, it is a year and for monthly tax return it is a month

Example:

"Diciembre"

​
presentedAt[before]
string<date-time>

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

​
presentedAt[strictly_before]
string<date-time>

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

​
presentedAt[after]
string<date-time>

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

​
presentedAt[strictly_after]
string<date-time>

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

​
fiscalYear
string

Filter by fiscal year (exact match) Fiscal year

Example:

2019

​
order[period]
enum<string>

Order by period

Available options:
asc,
desc
Example:

"asc"

​
order[presentedAt]
enum<string>

Order by filing 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 return collection response

​
@context
string
default:/contexts/TaxReturn
​
@id
string
default:/taxpayers/{id}/tax-returns
Example:

"/taxpayers/PEIC211118IS0/tax-returns"

​
@type
string
default:hydra:Collection
​
hydra:member
object[]
​
hydra:view
object

Pagination information

​
hydra:search
object