Skip to main content
GET
/
electronic-accounting-records
/
{id}
Retrieve an electronic accounting record
curl --request GET \
  --url https://api.syntage.com/electronic-accounting-records/{id} \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/ElectronicAccountingRecord",
  "@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"
}

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Response

Electronic Accounting Record resource response

​
@context
string
default:/contexts/ElectronicAccountingRecord
​
@id
string<iri-reference>

Electronic Accounting Record IRI reference

Example:

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

​
@type
string
default:ElectronicAccountingRecord
​
id
string<uuid>

Electronic Accounting Record ID

Example:

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

​
year
integer

Fiscal year

Example:

2022

​
month
enum<integer>
Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
Example:

3

​
type
enum<string> | null
Available options:
N,
C
Example:

"N"

​
reason
enum<string>
Available options:
AF,
DE,
CO,
FC,
EM
Example:

"EM"

​
fileType
enum<string>
Available options:
CT,
B,
PL,
XF,
XC
Example:

"B"

​
filename
string
Example:

"PEIC211118IS0202203BN.zip"

​
code
string
Example:

"0002220300000000124236"

​
receivedAt
string<date-time>
​
status
enum<string>
Available options:
received,
accepted,
rejected
Example:

"accepted"

​
files
object[]

Electronic accounting record files: (ack receipt, ack processing, XML and digital stamp)

​
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"