Create an extraction

curl --request POST \
  --url https://api.syntage.com/extractions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
  "options": {
    "types": [
      "I",
      "E",
      "P"
    ],
    "period": {
      "from": "2020-01-01T00:00:00.000Z",
      "to": "2020-03-31T23:59:59.000Z"
    }
  }
}
'

import requests

url = "https://api.syntage.com/extractions"

payload = {
    "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
    "options": {
        "types": ["I", "E", "P"],
        "period": {
            "from": "2020-01-01T00:00:00.000Z",
            "to": "2020-03-31T23:59:59.000Z"
        }
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entity: '/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d',
    options: {
      types: ['I', 'E', 'P'],
      period: {from: '2020-01-01T00:00:00.000Z', to: '2020-03-31T23:59:59.000Z'}
    }
  })
};

fetch('https://api.syntage.com/extractions', 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/extractions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'entity' => '/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d',
    'options' => [
        'types' => [
                'I',
                'E',
                'P'
        ],
        'period' => [
                'from' => '2020-01-01T00:00:00.000Z',
                'to' => '2020-03-31T23:59:59.000Z'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syntage.com/extractions"

	payload := strings.NewReader("{\n  \"entity\": \"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d\",\n  \"options\": {\n    \"types\": [\n      \"I\",\n      \"E\",\n      \"P\"\n    ],\n    \"period\": {\n      \"from\": \"2020-01-01T00:00:00.000Z\",\n      \"to\": \"2020-03-31T23:59:59.000Z\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.syntage.com/extractions")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entity\": \"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d\",\n  \"options\": {\n    \"types\": [\n      \"I\",\n      \"E\",\n      \"P\"\n    ],\n    \"period\": {\n      \"from\": \"2020-01-01T00:00:00.000Z\",\n      \"to\": \"2020-03-31T23:59:59.000Z\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/extractions")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entity\": \"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d\",\n  \"options\": {\n    \"types\": [\n      \"I\",\n      \"E\",\n      \"P\"\n    ],\n    \"period\": {\n      \"from\": \"2020-01-01T00:00:00.000Z\",\n      \"to\": \"2020-03-31T23:59:59.000Z\"\n    }\n  }\n}"

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

{
  "@context": "/contexts/Extraction",
  "@id": "/extractions/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "Extraction",
  "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
  "taxpayer": {
    "@id": "/taxpayers/PEIC211118IS0",
    "@type": "Taxpayer",
    "id": "PEIC211118IS0",
    "personType": "physical",
    "registrationDate": "2023-12-25",
    "name": "Pedro Infante Cruz"
  },
  "options": {
    "types": [
      "I",
      "E",
      "P"
    ],
    "period": {
      "from": "2020-01-01T00:00:00.000Z",
      "to": "2020-03-31T23:59:59.000Z"
    }
  },
  "startedAt": "2023-11-07T05:31:56Z",
  "finishedAt": "2023-11-07T05:31:56Z",
  "rateLimitedAt": "2019-01-03T21:10:40.000Z",
  "errorCode": null,
  "createdDataPoints": 3,
  "updatedDataPoints": 2,
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}

{
  "@context": "/contexts/ConstraintViolation",
  "@type": "ConstraintViolation",
  "hydra:title": "An error occurred",
  "hydra:description": "exampleField: This value should not be blank.",
  "violations": [
    {
      "propertyPath": "exampleField",
      "message": "This value should not be blank."
    }
  ]
}

{
  "message": "<string>"
}

{
  "conflictingExtractors": []
}

POST

extractions

Create an extraction

curl --request POST \
  --url https://api.syntage.com/extractions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
  "options": {
    "types": [
      "I",
      "E",
      "P"
    ],
    "period": {
      "from": "2020-01-01T00:00:00.000Z",
      "to": "2020-03-31T23:59:59.000Z"
    }
  }
}
'

import requests

url = "https://api.syntage.com/extractions"

payload = {
    "entity": "/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d",
    "options": {
        "types": ["I", "E", "P"],
        "period": {
            "from": "2020-01-01T00:00:00.000Z",
            "to": "2020-03-31T23:59:59.000Z"
        }
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entity: '/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d',
    options: {
      types: ['I', 'E', 'P'],
      period: {from: '2020-01-01T00:00:00.000Z', to: '2020-03-31T23:59:59.000Z'}
    }
  })
};

fetch('https://api.syntage.com/extractions', 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/extractions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'entity' => '/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d',
    'options' => [
        'types' => [
                'I',
                'E',
                'P'
        ],
        'period' => [
                'from' => '2020-01-01T00:00:00.000Z',
                'to' => '2020-03-31T23:59:59.000Z'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syntage.com/extractions"

	payload := strings.NewReader("{\n  \"entity\": \"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d\",\n  \"options\": {\n    \"types\": [\n      \"I\",\n      \"E\",\n      \"P\"\n    ],\n    \"period\": {\n      \"from\": \"2020-01-01T00:00:00.000Z\",\n      \"to\": \"2020-03-31T23:59:59.000Z\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.syntage.com/extractions")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entity\": \"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d\",\n  \"options\": {\n    \"types\": [\n      \"I\",\n      \"E\",\n      \"P\"\n    ],\n    \"period\": {\n      \"from\": \"2020-01-01T00:00:00.000Z\",\n      \"to\": \"2020-03-31T23:59:59.000Z\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/extractions")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entity\": \"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d\",\n  \"options\": {\n    \"types\": [\n      \"I\",\n      \"E\",\n      \"P\"\n    ],\n    \"period\": {\n      \"from\": \"2020-01-01T00:00:00.000Z\",\n      \"to\": \"2020-03-31T23:59:59.000Z\"\n    }\n  }\n}"

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

{
  "@context": "/contexts/Extraction",
  "@id": "/extractions/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "Extraction",
  "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
  "taxpayer": {
    "@id": "/taxpayers/PEIC211118IS0",
    "@type": "Taxpayer",
    "id": "PEIC211118IS0",
    "personType": "physical",
    "registrationDate": "2023-12-25",
    "name": "Pedro Infante Cruz"
  },
  "options": {
    "types": [
      "I",
      "E",
      "P"
    ],
    "period": {
      "from": "2020-01-01T00:00:00.000Z",
      "to": "2020-03-31T23:59:59.000Z"
    }
  },
  "startedAt": "2023-11-07T05:31:56Z",
  "finishedAt": "2023-11-07T05:31:56Z",
  "rateLimitedAt": "2019-01-03T21:10:40.000Z",
  "errorCode": null,
  "createdDataPoints": 3,
  "updatedDataPoints": 2,
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}

{
  "@context": "/contexts/ConstraintViolation",
  "@type": "ConstraintViolation",
  "hydra:title": "An error occurred",
  "hydra:description": "exampleField: This value should not be blank.",
  "violations": [
    {
      "propertyPath": "exampleField",
      "message": "This value should not be blank."
    }
  ]
}

{
  "message": "<string>"
}

{
  "conflictingExtractors": []
}

Authorizations

X-API-Key

string

header

required

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

Body

application/json

Option 1
Option 2

entity

string<iri-reference>

required

Entity IRI reference

Example:

"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d"

extractor

enum<string>

required

Extractor to run, which retrieves resources from the corresponding datasource

Available options:

invoice,

monthly_tax_return,

annual_tax_return,

rif_tax_return,

tax_status,

tax_retention,

tax_compliance,

electronic_accounting,

sat_certificates,

rpc,

buro_de_credito_report,

bil,

rug,

background_check,

infonavit

options

object

Extractor options; check the available options for each extractor in Extractions

Example:

{
  "types": ["I", "E", "P"],
  "period": {
    "from": "2020-01-01T00:00:00.000Z",
    "to": "2020-03-31T23:59:59.000Z"
  }
}

Response

Extraction resource response

@context

string

default:/contexts/Extraction

@id

string<iri-reference>

Extraction IRI reference

Example:

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

@type

string

default:Extraction

JSON-LD resource type

string<uuid>

Unique extraction ID

Example:

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

taxpayer

object

Show child attributes

extractor

enum<string>

Extractor to run, which retrieves resources from the corresponding datasource

Available options:

invoice,

monthly_tax_return,

annual_tax_return,

rif_tax_return,

tax_status,

tax_retention,

tax_compliance,

electronic_accounting,

sat_certificates,

rpc,

buro_de_credito_report,

bil,

rug,

background_check,

infonavit

options

object

Extractor options; check the available options for each extractor in Extractions

Example:

{
  "types": ["I", "E", "P"],
  "period": {
    "from": "2020-01-01T00:00:00.000Z",
    "to": "2020-03-31T23:59:59.000Z"
  }
}

status

enum<string>

Available options:

pending,

running,

finished,

failed,

stopping,

stopped

startedAt

string<date-time> | null

Time when the status changed from pending to running

finishedAt

string<date-time> | null

Time when the status changed from running to finished or failed

rateLimitedAt

string<date-time>

This field returns a date when the taxpayer reached the max amount of downloaded CFDI files allowed by SAT in a range of 24hrs. You should retry this extraction 24hrs later. If your taxpayer has not reached the max amount this value should be NULL

Example:

"2019-01-03T21:10:40.000Z"

errorCode

enum<string> | null

Extraction error code

Available options:

invalid_credentials,

login_failed,

unrecoverable,

sat_unavailable,

internal_error,

undefined

Example:

null

createdDataPoints

integer

This is the number of created resources. For example, if 1 invoice was created with its XML and PDF file this value should be 3. And If you previously extracted all the resources and there are no more resources to create this value is 0.

Example:

3

updatedDataPoints

integer

When your taxpayer has resources by a previous extraction and new extraction found changes between our data and Sat data it would update this resource. For example, when a new extraction finds a Canceled invoice which you previously extracted as an Active invoice.

Example:

2

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 all extractions Retrieve an extraction

⌘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

Create an extraction

Authorizations

Body

Response