Retrieve a tax return

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

import requests

url = "https://api.syntage.com/tax-returns/{id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.syntage.com/tax-returns/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.syntage.com/tax-returns/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syntage.com/tax-returns/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.syntage.com/tax-returns/{id}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/tax-returns/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "@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": "invoice.cfdi.xml",
      "resource": "/invoices/7c45e9c6-8f7f-4d0e-b6e5-65fef6c8c2f9",
      "mimeType": "text/xml",
      "extension": "xml",
      "size": 40544,
      "filename": "6f3c5312-2849-4525-86f6-c48a54c64c60.xml",
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "issifObligation": false,
  "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"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

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>'

import requests

url = "https://api.syntage.com/tax-returns/{id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.syntage.com/tax-returns/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.syntage.com/tax-returns/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syntage.com/tax-returns/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.syntage.com/tax-returns/{id}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/tax-returns/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "@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": "invoice.cfdi.xml",
      "resource": "/invoices/7c45e9c6-8f7f-4d0e-b6e5-65fef6c8c2f9",
      "mimeType": "text/xml",
      "extension": "xml",
      "size": 40544,
      "filename": "6f3c5312-2849-4525-86f6-c48a54c64c60.xml",
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "issifObligation": false,
  "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"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

X-API-Key

string

header

required

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

Path Parameters

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

string<uuid>

Tax Return ID

Example:

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

taxpayer

object

Show child attributes

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)

Show child attributes

issifObligation

boolean | null

Indicates whether the taxpayer is obligated to file the Informative Statement on Tax Situation (ISSIF/DISIF) under Article 32-H of the Mexican Federal Tax Code (CFF). Derived from the annual return PDF, either from the 32-H obligation question or from a referenced ISSIF artifact (the ARCHIVO ISSIF section or a .sb2x filename).

When true, financial statements for this return are filed separately via SIPRED and therefore are not present in the standard annual-return Excel.

Only set on annual returns for Personas Morales filed from fiscal year 2018 onward; older returns always return false.

Example:

false

payment

object

Payment

Show child attributes

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"

List an entity's tax retentions Download a tax return PDF

⌘I

Core Resources

Other Resources

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Datasource: BIL

Datasource: Infonavit

Insights

Reports

Webhooks

Retrieve a tax return

Authorizations

Path Parameters

Response