POST
/
extractions
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",
  "extractor": "invoice",
  "options": {
    "types": [
      "I",
      "E",
      "P"
    ],
    "period": {
      "from": "2020-01-01T00:00:00.000Z",
      "to": "2020-03-31T23:59:59.000Z"
    }
  }
}'
{
  "@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"
  },
  "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"
}

Authorizations

X-API-Key
string
header
required

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

Body

application/json

Response

202
application/ld+json

Extraction resource response

The response is of type object.