Skip to main content
GET
/
taxpayers
/
{id}
/
electronic-accounting-records
List electronic accounting records
curl --request GET \
  --url https://api.syntage.com/taxpayers/{id}/electronic-accounting-records \
  --header 'X-API-Key: <api-key>'
{
  "@context": "<string>",
  "@id": "/taxpayers/PEIC211118IS0/electronic-accounting-records",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/electronic-accounting-records/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "ElectronicAccountingRecord",
      "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
      "year": 2022,
      "month": 3,
      "type": "N",
      "reason": "EM",
      "fileType": "B",
      "filename": "PEIC211118IS0202203BN.zip",
      "code": "0002220300000000124236",
      "receivedAt": "2023-11-07T05:31:56Z",
      "status": "accepted",
      "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"
        }
      ],
      "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

​
year
integer

Filter by year (exact match)

Example:

2022

​
month
enum<integer>

Filter by month (exact match)

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
Example:

3

​
type
enum<string> | null

Filter by type (exact match)

Available options:
N,
C
Example:

"N"

​
reason
enum<string>

Filter by reason (exact match)

Available options:
AF,
DE,
CO,
FC,
EM
Example:

"EM"

​
fileType
enum<string>

Filter by file type (exact match)

Available options:
CT,
B,
PL,
XF,
XC
Example:

"B"

​
filename
string

Filter by filename (partial match)

Example:

"PEIC211118IS0202203BN.zip"

​
code
string

Filter by code (exact match)

Example:

"0002220300000000124236"

​
receivedAt[before]
string<date-time>

Filter by date received (less than or equal <=)

​
receivedAt[strictly_before]
string<date-time>

Filter by date received (less than <)

​
receivedAt[after]
string<date-time>

Filter by date received (greater than or equal >=)

​
receivedAt[strictly_after]
string<date-time>

Filter by date received (greater than >)

​
status
enum<string>

Filter by status (exact match)

Available options:
received,
accepted,
rejected
Example:

"accepted"

​
order[year]
enum<string>

Order by year

Available options:
asc,
desc
Example:

"asc"

​
order[month]
enum<string>

Order by month

Available options:
asc,
desc
Example:

"asc"

​
order[receivedAt]
enum<string>

Order by date received

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

Electronic accounting record collection response

​
@context
string
default:/contexts/ElectronicAccountingRecord
​
@id
string
default:/taxpayers/{id}/electronic-accounting-records
Example:

"/taxpayers/PEIC211118IS0/electronic-accounting-records"

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

Pagination information

​
hydra:search
object