Skip to main content
GET
/
extractions
List all extractions
curl --request GET \
  --url https://api.syntage.com/extractions \
  --header 'X-API-Key: <api-key>'
{
  "@context": "<string>",
  "@id": "<string>",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@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"
      },
      "extractor": "invoice",
      "options": {
        "types": [
          "I",
          "E",
          "P"
        ],
        "period": {
          "from": "2020-01-01T00:00:00.000Z",
          "to": "2020-03-31T23:59:59.000Z"
        }
      },
      "status": "pending",
      "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"
    }
  ],
  "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.

Query Parameters

​
taxpayer.id
string

Filter by taxpayer ID (exact match)

Required string length: 12 - 13
Example:

"PEIC211118IS0"

​
extractor
enum<string>

Filter by extractor (partial match)

Available options:
invoice,
monthly_tax_return,
annual_tax_return,
rif_tax_return,
tax_status,
tax_retention,
tax_compliance,
electronic_accounting,
rpc,
buro_de_credito_report,
bil,
rug
​
status
enum<string>

Filter by status (exact match)

Available options:
pending,
running,
finished,
failed,
stopping,
stopped
​
startedAt[before]
string<date-time>

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

​
startedAt[strictly_before]
string<date-time>

Filter by start date (less than <)

​
startedAt[after]
string<date-time>

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

​
startedAt[strictly_after]
string<date-time>

Filter by start date (greater than >)

​
finishedAt[before]
string<date-time>

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

​
finishedAt[strictly_before]
string<date-time>

Filter by finished date (less than <)

​
finishedAt[after]
string<date-time>

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

​
finishedAt[strictly_after]
string<date-time>

Filter by finished date (greater than >)

​
exists[rateLimitedAt]
boolean

Filter extractions that was rate limited by SAT

Example:

true

​
createdAt[before]
string<date-time>

Filter by resource creation date (less than or equal <=)

​
createdAt[strictly_before]
string<date-time>

Filter by resource creation date (less than <)

​
createdAt[after]
string<date-time>

Filter by resource creation date (greater than or equal >=)

​
createdAt[strictly_after]
string<date-time>

Filter by resource creation date (greater than >)

​
order[startedAt]
enum<string>

Order by start date

Available options:
asc,
desc
Example:

"asc"

​
order[finishedAt]
enum<string>

Order by finished date

Available options:
asc,
desc
Example:

"asc"

​
order[createdAt]
enum<string>

Order by resource creation date

Available options:
asc,
desc
Example:

"asc"

​
order[updatedAt]
enum<string>

Order by resource update date

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

Extraction collection response

​
@context
string
default:/contexts/Extraction
​
@id
string
default:/extractions
​
@type
string
default:hydra:Collection
​
hydra:member
object[]
​
hydra:view
object

Pagination information

​
hydra:search
object