# Syntage Extractions API **Canonical:** https://apis.io/apis/syntage/syntage-extractions-api/ **Provider:** Syntage — https://apis.io/providers/syntage/ **Base URL:** https://api.syntage.com **Documentation:** https://docs.syntage.com/ Syntage Extractions API is one of 65 APIs that [Syntage](https://apis.io/providers/syntage/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Extractions. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide. Extractions are tasks that retrieve data for an entity from a datasource. They are used to collect invoices, tax returns, tax status, tax compliance checks, RPC records, RUG guarantees, Buró de Crédito reports, BIL reports, and other datasource-backed records. An extraction runs asynchronously. Creating one starts or queues the work, and the returned Extraction resource tracks its status, options, timing, errors, and the number of resources created or updated. ## How Extractions Work 1. Create or retrieve the entity you want to extract data for. 2. Create an extraction with the entity IRI, extractor name, and extractor options. 3. Store the returned extraction ID. 4. Retrieve the extraction until its `status` is `finished` or `failed`. 5. Read the extracted data from the related resource endpoints, such as invoices or tax returns. If the same extraction is already pending or running for the same entity, extractor, and options, Syntage returns a duplicate extraction response instead of starting the same work again. ## Options Options containing a period (`.`) in the name like `period.from` are a way to denote object paths. For example, `period.from` should actually be sent as: ```json { "options": { "period": { "from": "2020-01-01", "to": "2020-12-31" } } } ``` Extractor names and options are specific to the data you are extracting. For extraction-backed resources, use the resource overview page for the extractor name, required credentials, supported options, and the endpoint where the extracted records can be read. # Extraction status | Status | Description | | ------ | ----------- | | pending | The initial extraction status. The extraction is enqueued and waiting to be processed. | | waiting | The extraction does not meet the requirements to begin. | | running | The extraction process started and is currently running. The running time varies depending on the extractor type and the entity's transactional volume. You may find partial data available in our API endpoints during this time. | | finished | The extraction finished successfully. All data is available to be retrieved from our API endpoints. | | failed | The extraction couldn't start or failed during the process. Our internal retry policies weren't able to finish the extraction successfully. We may have partial data available in our API endpoints, but new extractions should be created to ensure all the entity's data is available. You can check the [extraction error code](#section/Extraction-error-codes) to understand why it failed and determine whether it can be retried or not. | | stopping | The extraction was requested to be stopped by the user. It is in the process of being stopped. | | stopped | The extraction was stopped by the user after it started running. This extraction is included in billing. | | cancelled | The extraction was stopped by the user before it started running. This extraction is not included in billing. | # Extraction error codes | Code | Description | Retryable | | ---- | ----------- | --------- | | invalid_credentials | The SAT [Credential](#tag/Credentials) is no longer valid. | No | | login_failed | We couldn't log in with the SAT credential. | Yes | | unrecoverable | The extraction process failed many times, and we reached a maximum number of retries. | Yes | | sat_unavailable | We detected that SAT itself is down or unresponsive. | Yes | | internal_error | We detected an internal error in our own infrastructure. | Yes | | undefined | We couldn't determine the error cause and our internal team will investigate it. | Yes | ## Machine-readable artifacts (4) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/syntage/refs/heads/main/openapi/syntage-extractions-api-openapi.yml - **APIReference** — https://docs.syntage.com/api-reference/introduction - **Documentation** — https://docs.syntage.com/ - **GettingStarted** — https://docs.syntage.com/using-syntage/get-started/quick-start ## Other Syntage APIs (12) - [Syntage Accounts Payable Insight API](https://apis.io/apis/syntage/syntage-accounts-payable-insight-api/) - [Syntage Accounts Receivable Insight API](https://apis.io/apis/syntage/syntage-accounts-receivable-insight-api/) - [Syntage Background Checks API](https://apis.io/apis/syntage/syntage-background-checks-api/) - [Syntage Balance Sheet Insight API](https://apis.io/apis/syntage/syntage-balance-sheet-insight-api/) - [Syntage Cash Flow Insight API](https://apis.io/apis/syntage/syntage-cash-flow-insight-api/) - [Syntage Company Verification Reports API](https://apis.io/apis/syntage/syntage-company-verification-reports-api/) - [Syntage Corporate Structure Insight API](https://apis.io/apis/syntage/syntage-corporate-structure-insight-api/) - [Syntage Customer Concentration Insight API](https://apis.io/apis/syntage/syntage-customer-concentration-insight-api/) - [Syntage Customer Network Insight API](https://apis.io/apis/syntage/syntage-customer-network-insight-api/) - [Syntage DS MX BIL Reports API](https://apis.io/apis/syntage/syntage-ds-mx-bil-reports-api/) - [Syntage DS MX Buró de Crédito Authorizations API](https://apis.io/apis/syntage/syntage-ds-mx-bur-de-cr-dito-authorizations-api/) - [Syntage DS MX Buró de Crédito Reports API](https://apis.io/apis/syntage/syntage-ds-mx-bur-de-cr-dito-reports-api/) ## Tags Extractions --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/syntage/syntage-extractions-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/syntage/.