# Syntage

## Docs

- [Accounts Payable Insight](https://docs.syntage.com/api-reference/accounts-payable-insight/get-accounts-payable.md): Returns accounts payable data showing amounts due and paid over time, including cumulative totals.
- [Accounts Receivable Insight](https://docs.syntage.com/api-reference/accounts-receivable-insight/get-accounts-receivable.md): Returns accounts receivable data showing amounts due and paid over time, including cumulative totals.
- [Get a specific background check](https://docs.syntage.com/api-reference/background-checks/get-a-specific-background-check.md): Retrieves detailed information about a specific background check, including scores, database statuses, and associated files.
- [Get all background checks](https://docs.syntage.com/api-reference/background-checks/get-all-background-checks.md)
- [Get an entity's background checks](https://docs.syntage.com/api-reference/background-checks/get-an-entitys-background-checks.md): Retrieves all background checks associated with a specific entity.
- [Get background check PDF report](https://docs.syntage.com/api-reference/background-checks/get-background-check-pdf-report.md): Generates and returns a PDF report for the background check. This endpoint returns the PDF file directly.
- [Get background check records](https://docs.syntage.com/api-reference/background-checks/get-background-check-records.md): Retrieves detailed records for a specific background check. Records contain the actual data found during the background check process, organized by category and database.
- [Balance Sheet Insight](https://docs.syntage.com/api-reference/balance-sheet-insight/get-balance-sheet-metric.md): Returns the entity's balance sheet organized in a tree of categories.
- [Cash Flow Insight](https://docs.syntage.com/api-reference/cash-flow-insight/get-cash-flow.md): Inflows and outflows over time, derived from issued and received invoices.
- [Get a specific company verification report](https://docs.syntage.com/api-reference/company-verification-reports/get-a-specific-company-verification-report.md)
- [Get all company verification reports](https://docs.syntage.com/api-reference/company-verification-reports/get-all-company-verification-reports.md)
- [Get an entity's company verification reports](https://docs.syntage.com/api-reference/company-verification-reports/get-an-entitys-company-verification-reports.md)
- [Customer Concentration Insight](https://docs.syntage.com/api-reference/customer-concentration-insight/get-customer-invoice-concentration.md): Returns the concentration of issued or received invoices by customers.
- [Customer Network Insight](https://docs.syntage.com/api-reference/customer-network-insight/get-customer-network-insight.md): Customers the entity has sold to, with invoiced totals and cancellation rates per counterparty.
- [Create a Buró de Crédito authorization](https://docs.syntage.com/api-reference/ds-mx-buro-de-credito-authorizations/create-a-buro-de-credito-authorization.md)
- [Delete a Buró de Crédito authorization](https://docs.syntage.com/api-reference/ds-mx-buro-de-credito-authorizations/delete-a-buro-de-credito-authorization.md)
- [Get a Buró de Crédito authorization](https://docs.syntage.com/api-reference/ds-mx-buro-de-credito-authorizations/get-a-buro-de-credito-authorization.md)
- [Get an entity's Buró de Crédito authorizations](https://docs.syntage.com/api-reference/ds-mx-buro-de-credito-authorizations/get-an-entitys-buro-de-credito-authorizations.md)
- [Get a Buró de Crédito report](https://docs.syntage.com/api-reference/ds-mx-buro-de-credito-reports/get-a-buro-de-credito-report.md)
- [Get an entity's Buró de Crédito reports](https://docs.syntage.com/api-reference/ds-mx-buro-de-credito-reports/get-an-entitys-buro-de-credito-reports.md)
- [List RPC entidades data (beta)](https://docs.syntage.com/api-reference/ds-mx-rpc-entidades/list-all-entities-rpc-entidades-data-beta.md)
- [Retrieve RPC entidades data (beta)](https://docs.syntage.com/api-reference/ds-mx-rpc-entidades/retrieve-rpc-entidades-data-beta.md)
- [List RUG garantias data (beta)](https://docs.syntage.com/api-reference/ds-mx-rug-garantias/list-all-entities-rug-garantias-data-beta.md)
- [List RUG operaciones data](https://docs.syntage.com/api-reference/ds-mx-rug-operaciones/list-all-entities-rug-operaciones-data.md)
- [Retrieve RUG operación data](https://docs.syntage.com/api-reference/ds-mx-rug-operaciones/retrieve-rug-operacion-data.md)
- [Get a SAT certificate](https://docs.syntage.com/api-reference/ds-mx-sat-certificates/get-a-sat-certificate.md): Retrieves a specific SAT certificate by its ID. The file property contains a reference to the certificate file - use the file download endpoint to retrieve the actual certificate content.
- [Get an entity's SAT certificates](https://docs.syntage.com/api-reference/ds-mx-sat-certificates/get-an-entitys-sat-certificates.md): Retrieves a collection of SAT certificates associated with the entity. These are digital certificates used for electronic signatures and sealing in Mexico's tax system.
- [Create a credential](https://docs.syntage.com/api-reference/ds-mx-sat-credentials/create-a-credential.md): Creating a SAT credential will register the taxpayer in your account if it does not already exist.
- [Delete a credential](https://docs.syntage.com/api-reference/ds-mx-sat-credentials/delete-a-credential.md)
- [List all credentials](https://docs.syntage.com/api-reference/ds-mx-sat-credentials/list-all-credentials.md)
- [Retrieve a credential](https://docs.syntage.com/api-reference/ds-mx-sat-credentials/retrieve-a-credential.md)
- [Revalidate a credential](https://docs.syntage.com/api-reference/ds-mx-sat-credentials/revalidate-a-credential.md): Revalidate a SAT credential that status is not already valid.
- [List all applied credit notes related to the requested invoice](https://docs.syntage.com/api-reference/ds-mx-sat-credit-notes/list-all-applied-credit-notes-related-to-the-requested-invoice.md)
- [List all issued credit notes related to the requested invoice](https://docs.syntage.com/api-reference/ds-mx-sat-credit-notes/list-all-issued-credit-notes-related-to-the-requested-invoice.md)
- [List credit notes](https://docs.syntage.com/api-reference/ds-mx-sat-credit-notes/list-credit-notes.md): List all credit notes related to invoices.
- [Retrieve an invoice credit note](https://docs.syntage.com/api-reference/ds-mx-sat-credit-notes/retrieve-an-invoice-credit-note.md)
- [List electronic accounting records](https://docs.syntage.com/api-reference/ds-mx-sat-electronic-accounting/list-all-entities-electronic-accounting-records.md)
- [Retrieve an electronic accounting record](https://docs.syntage.com/api-reference/ds-mx-sat-electronic-accounting/retrieve-an-electronic-accounting-record.md)
- [List all invoice batch payments](https://docs.syntage.com/api-reference/ds-mx-sat-invoice-batch-payments/list-all-invoice-batch-payments.md): List all batch payments related to your invoices
- [List an invoice's batch payments](https://docs.syntage.com/api-reference/ds-mx-sat-invoice-batch-payments/list-an-invoices-batch-payments.md): List all batch payments related to the requested invoice.
- [Retrieve an invoice batch payment](https://docs.syntage.com/api-reference/ds-mx-sat-invoice-batch-payments/retrieve-an-invoice-batch-payment.md)
- [List all line items for an entity](https://docs.syntage.com/api-reference/ds-mx-sat-invoice-line-items/list-all-entity-line-items.md): List all invoice line items related to the specified entity
- [List an invoice's line items](https://docs.syntage.com/api-reference/ds-mx-sat-invoice-line-items/list-an-invoices-line-items.md): List all line items related to the requested invoice
- [Retrieve an invoice line item](https://docs.syntage.com/api-reference/ds-mx-sat-invoice-line-items/retrieve-an-invoice-line-item.md)
- [List all invoice payments](https://docs.syntage.com/api-reference/ds-mx-sat-invoice-payments/list-all-invoice-payments.md): List all invoice payments related to deferred invoices.
- [List an invoice's payments](https://docs.syntage.com/api-reference/ds-mx-sat-invoice-payments/list-an-invoices-payments.md): List all payments related to the requested invoice
- [List taxpayers' invoice payments](https://docs.syntage.com/api-reference/ds-mx-sat-invoice-payments/list-entities-invoice-payments.md): List all invoice payments related to the specified taxpayer
- [Overview](https://docs.syntage.com/api-reference/ds-mx-sat-invoice-payments/overview.md)
- [Retrieve an invoice payment](https://docs.syntage.com/api-reference/ds-mx-sat-invoice-payments/retrieve-an-invoice-payment.md)
- [List invoices](https://docs.syntage.com/api-reference/ds-mx-sat-invoices/list-all-entities-invoices.md)
- [Overview](https://docs.syntage.com/api-reference/ds-mx-sat-invoices/overview.md)
- [Retrieve an invoice](https://docs.syntage.com/api-reference/ds-mx-sat-invoices/retrieve-an-invoice.md)
- [Retrieve an invoice's CFDI](https://docs.syntage.com/api-reference/ds-mx-sat-invoices/retrieve-an-invoices-cfdi.md): Returns the invoice CFDI (Comprobantes Fiscal Digital por Internet) file content in different formats.
- [Tag an invoice](https://docs.syntage.com/api-reference/ds-mx-sat-invoices/tag-an-invoice.md)
- [Untag an invoice](https://docs.syntage.com/api-reference/ds-mx-sat-invoices/untag-an-invoice.md)
- [List tax compliance checks](https://docs.syntage.com/api-reference/ds-mx-sat-tax-compliance-checks/list-all-entities-tax-compliance-checks.md)
- [Overview](https://docs.syntage.com/api-reference/ds-mx-sat-tax-compliance-checks/overview.md)
- [Retrieve a tax compliance check](https://docs.syntage.com/api-reference/ds-mx-sat-tax-compliance-checks/retrieve-a-tax-compliance-check.md)
- [List tax retentions](https://docs.syntage.com/api-reference/ds-mx-sat-tax-retentions/list-all-entities-tax-retentions.md)
- [Retrieve a tax retention](https://docs.syntage.com/api-reference/ds-mx-sat-tax-retentions/retrieve-a-tax-retention.md)
- [Retrieve a tax retention CFDI](https://docs.syntage.com/api-reference/ds-mx-sat-tax-retentions/retrieve-a-tax-retention-cfdi.md): Returns the tax retention CFDI (Comprobantes Fiscal Digital por Internet) file content in different formats.
- [List tax returns](https://docs.syntage.com/api-reference/ds-mx-sat-tax-returns/list-all-entities-tax-returns.md)
- [Retrieve a tax return](https://docs.syntage.com/api-reference/ds-mx-sat-tax-returns/retrieve-a-tax-return.md)
- [Retrieve a tax return data](https://docs.syntage.com/api-reference/ds-mx-sat-tax-returns/retrieve-a-tax-return-data.md): This endpoint returns the extracted data from tax returns.
- [List all taxpayer´s tax status](https://docs.syntage.com/api-reference/ds-mx-sat-tax-status/list-all-entities-tax-status.md)
- [Retrieve a tax status](https://docs.syntage.com/api-reference/ds-mx-sat-tax-status/retrieve-a-tax-status.md)
- [Calculate Syntage Score](https://docs.syntage.com/api-reference/ds-syntage-score/calculate-syntage-score.md)
- [Employees Insight](https://docs.syntage.com/api-reference/employees-insight/get-employees.md): Number of employees per period, derived from distinct payroll (CFDI Nómina) recipients.
- [Add an Entity](https://docs.syntage.com/api-reference/entities/add-an-entity.md): Add an entity to your organization. Extractions are automatically created for each selected datasource. For SAT for example, one extraction is created for each extractor utilizing first time rules if any are set for that extractor. To prevent any extractions from being created, leave datasources emp…
- [Create an Entity tag](https://docs.syntage.com/api-reference/entities/create-an-entity-tag.md)
- [Delete an Entity](https://docs.syntage.com/api-reference/entities/delete-an-entity.md)
- [Delete an Entity tag](https://docs.syntage.com/api-reference/entities/delete-an-entity-tag.md)
- [List all entities](https://docs.syntage.com/api-reference/entities/list-all-entities.md)
- [Retrieve an Entity](https://docs.syntage.com/api-reference/entities/retrieve-an-entity.md)
- [Update an Entity](https://docs.syntage.com/api-reference/entities/update-an-entity.md)
- [Update an Entity tag](https://docs.syntage.com/api-reference/entities/update-an-entity-tag.md)
- [Delete an event](https://docs.syntage.com/api-reference/events/delete-an-event.md)
- [List all events](https://docs.syntage.com/api-reference/events/list-all-events.md)
- [Overview](https://docs.syntage.com/api-reference/events/overview.md)
- [Retrieve an event](https://docs.syntage.com/api-reference/events/retrieve-an-event.md)
- [Expenditures Insight](https://docs.syntage.com/api-reference/expenditures-insight/get-expenditures.md): Money the entity has spent over time, aggregated from received income invoices.
- [Delete export resource](https://docs.syntage.com/api-reference/exports/delete-export-resource.md)
- [Export data](https://docs.syntage.com/api-reference/exports/export-data.md)
- [Retrieve an export](https://docs.syntage.com/api-reference/exports/retrieve-an-export.md)
- [Create an extraction](https://docs.syntage.com/api-reference/extractions/create-an-extraction.md): Create an extraction for a specific taxpayer, extractor, and options.
- [List all extractions](https://docs.syntage.com/api-reference/extractions/list-all-extractions.md)
- [Overview](https://docs.syntage.com/api-reference/extractions/overview.md)
- [Request the extraction to be stopped](https://docs.syntage.com/api-reference/extractions/request-the-extraction-to-be-stopped.md)
- [Retrieve an extraction](https://docs.syntage.com/api-reference/extractions/retrieve-an-extraction.md)
- [Download the file content](https://docs.syntage.com/api-reference/files/download-the-file-content.md): The response includes the `Location` header with the URL to download the file (make sure to follow the redirection).
- [Get a file](https://docs.syntage.com/api-reference/files/get-a-file.md)
- [Financial Institutions Insight](https://docs.syntage.com/api-reference/financial-institutions-insight/get-financial-institutions.md): Banks and other financial institutions the entity has transacted with, derived from CFDI payments and third-party accounts on invoices.
- [Financial Ratios Insight](https://docs.syntage.com/api-reference/financial-ratios-insight/get-financial-ratios.md): Liquidity, leverage, profitability, and efficiency ratios computed per fiscal year from the entity's annual tax filings.
- [Government Customers Insight](https://docs.syntage.com/api-reference/government-customers-insight/get-government-customers.md): The entity's customers that are Mexican federal, state, or municipal government bodies, with each one's share of total revenue.
- [Income Statement Insight](https://docs.syntage.com/api-reference/income-statement-insight/get-metrics-income-statement.md): Returns the entity's income statement organized in a tree of categories.
- [Introduction](https://docs.syntage.com/api-reference/introduction.md)
- [Invoicing Annual Comparison Insight](https://docs.syntage.com/api-reference/invoicing-annual-comparison-insight/get-invoicing-annual-comparison-insight.md): Year-over-year totals of issued and received invoicing activity, one row per fiscal year.
- [Invoicing Blacklist Insight](https://docs.syntage.com/api-reference/invoicing-blacklist-insight/get-invoicing-blacklist.md): Counterparties on the SAT's Artículo 69-B blacklist (EFOS/EDOS) that the entity has transacted with, split between issuers and receivers.
- [Invoicing Concentration Insight](https://docs.syntage.com/api-reference/invoicing-concentration-insight/get-invoicing-concentration.md): **Deprecated:** Use [Get Customer Invoice Concentration](/api-reference/customer-concentration-insight/get-customer-invoice-concentration) or [Get Vendor Invoice Concentration](/api-reference/vendor-concentration-insight/get-vendor-invoice-concentration) instead.
- [Retrieve MX addresses by postal code](https://docs.syntage.com/api-reference/miscellaneous/retrieve-mx-addresses-by-postal-code.md)
- [Products and Services Bought Insight](https://docs.syntage.com/api-reference/products-and-services-bought-insight/get-products-and-services-bought.md): Returns a paginated list of products and services bought by the entity, including transaction details and share percentages.
- [Products and Services Sold Insight](https://docs.syntage.com/api-reference/products-and-services-sold-insight/get-products-and-services-sold.md): Returns a paginated list of products and services sold by the entity, including transaction details and share percentages.
- [Risks Insight](https://docs.syntage.com/api-reference/risks-insight/get-risk-calculations.md): Risk indicators (concentration, foreign-currency exposure, cash-transaction share, insolvency, tax compliance, etc.) computed from the entity's invoicing, payments, and tax-filing data.
- [RPC Shareholders Insight](https://docs.syntage.com/api-reference/rpc-shareholders-insight/get-rpc-shareholders-beta.md): Shareholder information is obtained from the Registro Público de Comercio (RPC).
- [Retrieve RUG garantias data](https://docs.syntage.com/api-reference/rug-garantias/retrieve-rug-garantias-data.md)
- [Sales Revenue Insight](https://docs.syntage.com/api-reference/sales-revenue-insight/get-sales-revenue.md): Money the entity has earned over time, aggregated from issued income invoices.
- [Create an scheduler rule](https://docs.syntage.com/api-reference/scheduler-rules/create-an-scheduler-rule.md)
- [Delete an scheduler rule](https://docs.syntage.com/api-reference/scheduler-rules/delete-an-scheduler-rule.md)
- [Retrieve an scheduler rule](https://docs.syntage.com/api-reference/scheduler-rules/retrieve-an-scheduler-rule.md)
- [Update an scheduler rule](https://docs.syntage.com/api-reference/scheduler-rules/update-an-scheduler-rule.md)
- [Create an scheduler](https://docs.syntage.com/api-reference/schedulers/create-an-scheduler.md)
- [Delete an scheduler](https://docs.syntage.com/api-reference/schedulers/delete-an-scheduler.md)
- [List schedulers](https://docs.syntage.com/api-reference/schedulers/list-schedulers.md): List all schedulers
- [Retrieve an scheduler](https://docs.syntage.com/api-reference/schedulers/retrieve-an-scheduler.md)
- [Update an scheduler](https://docs.syntage.com/api-reference/schedulers/update-an-scheduler.md)
- [Scores Insight](https://docs.syntage.com/api-reference/scores-insight/get-scores.md): Entity scores aggregated from every configured score source (Syntage Score and any third-party rating providers enabled for the organization).
- [Create a new shareholder for an entity](https://docs.syntage.com/api-reference/shareholders/create-a-new-shareholder-for-an-entity.md)
- [Delete a shareholder](https://docs.syntage.com/api-reference/shareholders/delete-a-shareholder.md)
- [Delete a shareholder relation](https://docs.syntage.com/api-reference/shareholders/delete-a-shareholder-relation.md)
- [Delete a shareholder relation source](https://docs.syntage.com/api-reference/shareholders/delete-a-shareholder-relation-source.md)
- [Get a specific shareholder](https://docs.syntage.com/api-reference/shareholders/get-a-specific-shareholder.md)
- [Get a specific shareholder relation](https://docs.syntage.com/api-reference/shareholders/get-a-specific-shareholder-relation.md)
- [Get a specific shareholder relation source](https://docs.syntage.com/api-reference/shareholders/get-a-specific-shareholder-relation-source.md)
- [Get all shareholders](https://docs.syntage.com/api-reference/shareholders/get-all-shareholders.md)
- [Get an entity's shareholders](https://docs.syntage.com/api-reference/shareholders/get-an-entitys-shareholders.md)
- [Get shareholder relation sources](https://docs.syntage.com/api-reference/shareholders/get-shareholder-relation-sources.md)
- [Get shareholder relations](https://docs.syntage.com/api-reference/shareholders/get-shareholder-relations.md)
- [Promote a shareholder relation](https://docs.syntage.com/api-reference/shareholders/promote-a-shareholder-relation.md): Promotes a shareholder relation by creating a new entity for the shareholder. This operation requires providing the shareholder's name, RFC, and datasource configuration.
- [Update a shareholder](https://docs.syntage.com/api-reference/shareholders/update-a-shareholder.md)
- [Update a shareholder relation](https://docs.syntage.com/api-reference/shareholders/update-a-shareholder-relation.md)
- [Summary Insight](https://docs.syntage.com/api-reference/summary-insight/get-summary.md): Aggregated profile of the entity combining identity, economic activity, tax regimes, and headline figures from the latest annual tax return.
- [Create a tag](https://docs.syntage.com/api-reference/tags/create-a-tag.md)
- [Delete a tag](https://docs.syntage.com/api-reference/tags/delete-a-tag.md)
- [Update a tag](https://docs.syntage.com/api-reference/tags/update-a-tag.md)
- [Trial Balance Insight](https://docs.syntage.com/api-reference/trial-balance-insight/get-trial-balance.md): Returns all trial balances accounts matching on the account catalogs. If not present it will be tagged/grouped as '000 - Undefined'.
- [Vendor Concentration Insight](https://docs.syntage.com/api-reference/vendor-concentration-insight/get-vendor-invoice-concentration.md): Returns the concentration of issued or received invoices by vendors.
- [Vendor Network Insight](https://docs.syntage.com/api-reference/vendor-network-insight/get-vendor-network-insight.md): Vendors the entity has purchased from, with invoiced totals and cancellation rates per counterparty.
- [Create a webhook endpoint](https://docs.syntage.com/api-reference/webhook-endpoints/create-a-webhook-endpoint.md): Webhook requests are retried up to 5 times when it doesn't get a successful response (status code between 200-299) or when the request times out (after 3 seconds).
- [Delete a webhook endpoint](https://docs.syntage.com/api-reference/webhook-endpoints/delete-a-webhook-endpoint.md)
- [List all webhook endpoints](https://docs.syntage.com/api-reference/webhook-endpoints/list-all-webhook-endpoints.md)
- [Retrieve a webbook endpoint](https://docs.syntage.com/api-reference/webhook-endpoints/retrieve-a-webhook-endpoint.md)
- [Update an webhook endpoint](https://docs.syntage.com/api-reference/webhook-endpoints/update-an-webhook-endpoint.md)
- [List all webhook requests](https://docs.syntage.com/api-reference/webhook-requests/list-all-webhook-requests.md)
- [Retrieve a webhook request](https://docs.syntage.com/api-reference/webhook-requests/retrieve-a-webhook-request.md): ### How to validate webhook calls by using the `signingSecret` value. Whenever a webhook is called, a `X-Satws-Signature` header is sent to help verify it. Syntage generates a signature using a hash-based message authentication code (HMAC) with SHA-256 using the `signingSecret` as key. To verify the…
- [Overview](https://docs.syntage.com/api-reference/webhooks/overview.md)
- [Version 2020-01-01 to 2020-06-28](https://docs.syntage.com/changelog/2020-01-01-to-2020-06-28.md)
- [Environments](https://docs.syntage.com/guides/api/environments.md)
- [Pagination](https://docs.syntage.com/guides/api/pagination.md)
- [Property Filtering](https://docs.syntage.com/guides/api/property-filtering.md)
- [Rate Limiting](https://docs.syntage.com/guides/api/rate-limiting.md)
- [Request IDs](https://docs.syntage.com/guides/api/request-ids.md)
- [Catalogs](https://docs.syntage.com/guides/catalogs.md)
- [Embedding Entity Onboarding](https://docs.syntage.com/guides/embedding-entity-onboarding.md)
- [Integration Flow](https://docs.syntage.com/guides/integration-flow.md)
- [Validating Webhook Requests](https://docs.syntage.com/guides/validating-webhook-requests.md): How to validate webhook calls by using the `signingSecret` value.
- [Widget (Deprecated)](https://docs.syntage.com/guides/widget.md)
- [Introduction](https://docs.syntage.com/index.md)

## OpenAPI Specs

- [openapi](https://docs.syntage.com/openapi/openapi.yaml)