List an entity's electronic accounting records

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

import requests

url = "https://api.syntage.com/entities/{entityId}/electronic-accounting-records"

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}/electronic-accounting-records', 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}/electronic-accounting-records",
  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}/electronic-accounting-records"

	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}/electronic-accounting-records")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/entities/{entityId}/electronic-accounting-records")

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

electronic-accounting-records

List an entity's electronic accounting records

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

import requests

url = "https://api.syntage.com/entities/{entityId}/electronic-accounting-records"

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}/electronic-accounting-records', 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}/electronic-accounting-records",
  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}/electronic-accounting-records"

	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}/electronic-accounting-records")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/entities/{entityId}/electronic-accounting-records")

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

year

integer

Filter by year (exact match) Fiscal year

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

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

Electronic accounting record collection response

@context

string

default:/contexts/ElectronicAccountingRecord

@id

string

default:/entities/{entityId}/electronic-accounting-records

Example:

"/entities/91106968-1abd-4d64-85c1-4e73d96fb997/electronic-accounting-records"

@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 an electronic accounting record Retrieve a SAT certificate

⌘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 electronic accounting records

Authorizations

Path Parameters

Query Parameters

Response