List an entity's tax returns

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

import requests

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

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/entities/{entityId}/tax-returns', 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/entities/{entityId}/tax-returns",
  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/entities/{entityId}/tax-returns"

	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/entities/{entityId}/tax-returns")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

entities

{entityId}

tax-returns

List an entity's tax returns

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

import requests

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

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/entities/{entityId}/tax-returns', 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/entities/{entityId}/tax-returns",
  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/entities/{entityId}/tax-returns"

	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/entities/{entityId}/tax-returns")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "message": "<string>"
}

{
  "message": "<string>"
}

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

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

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 return collection response

@context

string

default:/contexts/TaxReturn

@id

string

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

Example:

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

@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 tax return data Retrieve a tax compliance check

⌘I

Core Resources

Other Resources

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Datasource: BIL

Insights

Reports

Webhooks

List an entity's tax returns

Authorizations

Path Parameters

Query Parameters

Response