openapi: 3.1.2 info: version: "2020-06-28" title: Syntage API contact: name: Email email: support@syntage.com description: | # Introduction The Syntage API is organized around [REST](https://en.wikipedia.org/wiki/Representational_State_Transfer). Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns [JSON-LD](https://json-ld.org) responses, and uses standard HTTP response codes, authentication, and verbs. # Environments | Name | Description | Base URL | |------|-------------|----------| | **Sandbox** | The Sandbox environment is dedicated to development and testing. In this environment, no real taxpayer credentials are required and all interaction with the SAT is simulated generating life-like data, allowing you to pull test data from all endpoints. | https://api.sandbox.syntage.com | | **Production** | The Production environment is dedicated to live applications with real connections to the SAT. In this environment, real taxpayer credentials are required, and you will pull real fiscal data directly from the SAT. | https://api.syntage.com | Each environment has a different API Key for [authentication](#section/Authentication). # Request IDs Each API request has an associated request identifier. You can find this value in the response headers, under `X-Request-ID`: ```curl curl -i https://api.syntage.com HTTP/1.1 200 OK Date: Sun, 29 Nov 2020 19:21:21 GMT X-Request-ID: Root=1-6532dcae-169bf139354cd48959f55c55 ``` If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. # Rate Limiting Our API employs a number of safeguards against bursts of incoming traffic to help maximize its stability. The returned HTTP headers of any API request show your current rate limit status: ```curl curl -i https://api.syntage.com HTTP/1.1 200 OK Date: Sun, 29 Nov 2020 19:21:21 GMT X-RateLimit-Limit: 60 X-RateLimit-Remaining: 56 X-RateLimit-Reset: 1606678044 ``` | Header Name | Description | |-----------------------|------------------------------------------------------------------------------| | X-RateLimit-Limit | The maximum number of requests you're permitted to make. | | X-RateLimit-Remaining | The number of requests remaining in the current rate limit window. | | X-RateLimit-Reset | The time at which the current rate limit window resets in UTC epoch seconds. | If you exceed the rate limit, a [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) response is returned: ```http HTTP/1.1 429 Too Many Requests Date: Sun, 29 Nov 2020 19:21:21 GMT X-RateLimit-Limit: 60 X-RateLimit-Remaining: 0 X-RateLimit-Reset: 1606678044 ``` We may reduce limits to prevent abuse, or increase limits to enable high-traffic operations. You can check your current limits in the [dashboard](https://app.syntage.com/settings/usage). To request an increased rate limit, please [contact support](https://support.syntage.com/). # Pagination When issuing a GET request on a collection containing more than 1 page (e.g. [/events](#operation/ListEvent)), a collection is returned. Links to the first, the last, previous and the next page in the collection are displayed as well as the number of total items in the collection. All endpoints that support this operation have a query parameter defined by: - `itemsPerPage` The number of items per page (default: 20, max: 1000) - `page` The collection page number ```bash "hydra:totalItems": 1, "hydra:view": { "@id": "/events?page=1", "@type": "hydra:PartialCollectionView", "hydra:first": "/events?page=1", "hydra:next": "/events?page=2", "hydra:last": "/events?page=3" }, ``` ## Cursor Pagination Cursor pagination is a technique used for navigating through large datasets efficiently. It allows you to retrieve a specific subset of results from a collection by using a cursor value that represents the position within the collection. The cursor serves as a reference point for fetching the next or previous set of results. ### Benefits of Cursor Pagination: 1. **Efficient Navigation:** Cursor pagination eliminates the need to fetch the entire dataset at once, making it more scalable and faster. You can retrieve data in smaller, manageable chunks based on the cursor values. 2. **Consistent Results:** Each page of results in cursor pagination is stable and doesn't change even if new items are added or removed from the collection. This ensures that you get consistent and reliable results. 3. **Flexibility:** Cursors can be used to navigate forwards and backwards in the collection without impacting performance. ### How to Use Cursor Pagination: To use cursor pagination with our API, follow these instructions: 1. Make a request to retrieve the initial page of results. The response will be a JSON-LD document that includes a `hydra:next` attribute with the URI for the next page. The URI already includes the cursor attribute. 2. To retrieve the next page of results, make a GET request to the URI provided in the `hydra:next` attribute. This URI will automatically include the cursor value for the next page. 3. If you want to navigate to the previous page, you can use the `hydra:previous` attribute in the JSON-LD response. It will contain the URI for the previous page, including the cursor value. 4. You can continue making requests to the `hydra:next` and `hydra:previous` URIs to navigate through the paginated results, based on your requirements. Make sure to update your request headers to include the necessary headers for JSON-LD content negotiation, such as `Accept: application/ld+json` or `Content-Type: application/ld+json`. By following these instructions, you can effectively navigate through the paginated results using the cursor values provided in the `hydra:next` and `hydra:previous` attributes, without the need to manually include the cursor in your requests. This simplifies the pagination process and enhances the usability of our API. ### Considerations About Cursor Pagination: - By default, the API uses offset-based pagination (except for a few endpoints that we will list below). If you want to switch to cursor pagination, you need to include an additional header in your request. Set the `X-Pagination-Style` header with the value `"cursor"` to enable cursor pagination. If not specified, the API will assume offset-based pagination. - After enabling cursor pagination, the API response will no longer include the `hydra:totalItems` field by default. Retrieving the total count can be resource intensive and impact response times, especially for large datasets. However, if you need the `hydra:totalItems` information, you can include an additional header in your request. Set the `X-Pagination-Enable-Partial` header with the value `0` to indicate that the response should include extra information, including the `hydra:totalItems` count. Please be aware that enabling this feature may impact API response times, as the backend needs to perform a count operation on the dataset. - With `X-Pagination-Enable-Partial: 0`, `hydra:totalItems` counts the items that match the request and its cursor: on a page requested through `hydra:next`, only the items after the cursor. Request the total on the first page, without a cursor. - `GET /entities/{entityId}/invoices` and `GET /entities/{entityId}/invoices/line-items` also accept the `X-Pagination-Bounded-Count` header with the value `1`, together with `X-Pagination-Enable-Partial: 0`. The count is then limited to 100,000 items: within the limit, the response includes the exact `hydra:totalItems`; above it, the response omits `hydra:totalItems`, which means the collection has more than 100,000 items. Narrow the request with filters, such as an issue date range, to count them. If you require the `hydra:totalItems` count, please consider the potential impact on API response times. ### Example ```bash curl -i 'https://api.syntage.com/entities/{entityId}/invoices?itemsPerPage=10' \ --header 'Accept: application/ld+json' \ --header 'X-Api-Key: {apiKey}' \ --header 'X-Pagination-Style: cursor' \ --header 'X-Pagination-Enable-Partial: 0' ``` **Note:** We only support cursor pagination for the following endpoints: - `GET /entities/{entityId}/invoices` - `GET /entities/{entityId}/invoices/line-items` - `GET /entities/{entityId}/invoices/{invoiceId}/line-items` - `GET /invoices/{invoiceId}/line-items` - `GET /entities/{entityId}/invoices/payments` Feel free to reach out if you have any further questions or need additional assistance! # Property Filtering The property filter adds the possibility to select the properties for GET operations. Syntax: `?properties[]=&properties[][]=` You can add as many properties as you need. The following example shows how to select `paymentType` and `issuer.rfc` when fetching a list of invoices. ```curl curl -i https://api.syntage.com/entities/{entityId}/invoices?properties[]=paymentType&properties[issuer]=rfc ``` # Filtering **Warning:** Collection endpoints only apply the filter query parameters documented for that endpoint. If you send an unsupported or misspelled filter query parameter, the API ignores it and processes the request as if that parameter was not sent. # API Versioning Guide Guidance on changes between versions. ## Version: 2020-01-01 to 2020-06-28 ### **Invoice** _**Affected Endpoints:** `GET /invoices/{id}` and `GET /entities/{entityId}/invoices`_ - The `amount` property has been removed from API responses. Use the `total` property instead. - Retrieval by invoice's `uuid` at `/invoices/{id}` is now removed. To retrieve an invoice, use the invoice's `id` at the specified endpoint. To find an invoice using its `uuid`, filter the invoice collection at `/entities/{entityId}/invoices?uuid[]={uuid}`. - Previously, the `@iri` property for an invoice pointed to the resource using `uuid`, like `/invoices/{uuid}`. Now, it points using its `id`, like `/invoices/{id}`. ### **Entity (Formerly Link)** _**Affected Endpoint:** `GET /entities`_ - Filtering entities by `status` is removed. Use `credential.status` instead. For example, utilize `GET /entities?credential.status[]=active` instead of `GET /entities?status[]=active`. ### **Tax Return** _**Affected Endpoints:** `GET /tax-returns/{id}` and `GET /entities/{entityId}/tax-returns`_ - Retrieval by tax return's `operationNumber` at `/tax-returns/{id}` is removed. To retrieve a tax return, use the tax return's `id` at the mentioned endpoint. To find a tax return using its `operationNumber`, filter the collection at `/entities/{entityId}/tax-returns?operationNumber[]={operationNumber}`. - Previously, the `@iri` property for a tax return pointed to the resource using `operationNumber`, like `/tax-returns/{operationNumber}`. Now, it directs to its `id`, like `/tax-returns/{id}`. ### **Event** _**Affected Endpoints:** `GET /events` and `GET /events/{id}`_ - For events associated to an `tax-return`, the `@iri` property now directs to `/tax-returns/{id}` instead of the previous `/tax-returns/{operationNumber}`. - For events associated to an `invoice`, the `@iri` property now directs to `/invoices/{id}` instead of the previous `/invoices/{uuid}`. ### **Extraction** _**Affected Endpoints:** `GET /extractions` and `GET /extractions/{id}`_ - The `periodFrom` property has been removed. Use `options.period.from` instead. - The `periodTo` property has been removed. Use `options.period.to` instead. ### **File** _**Affected Endpoint:** `GET /file/{id}`_ - For files associated to an `tax-return`, the `@iri` property now directs to `/tax-returns/{id}`, instead of the previous `/tax-returns/{operationNumber}`. - For files associated to an `invoice`, the `@iri` property now directs to `/invoices/{id}`, instead of the previous `/invoices/{uuid}`. ### Trying Out This Version If you want to test this version, you can do so by making any request with the `Accept-Version` header pointing to the latest version: ```curl curl -i 'https://api.syntage.com/entities/{entityId}/invoices' \ --header 'Accept-Version: 2020-06-28' \ --header 'X-Api-Key: {apiKey}' ``` tags: - name: Events description: | Events record meaningful changes to resources in your organization. When something changes, Syntage creates an Event resource. For example, submitting an entity's SAT credential can create credential and entity events, and a completed extraction can create an `extraction.updated` event. Many requests can create more than one event. For example, submitting valid SAT credentials for an entity can create `credential.created`, `credential.updated`, and `link.created` events. Events occur when the state of another resource changes. The state of that resource at the time of the change is embedded in the event's `data` field. For example, a `credential.updated` event contains a Credential, and an `invoice.updated` event contains an Invoice. Use the Events endpoints to retrieve recent events directly. Use [webhooks](/api-reference/webhooks/overview) when you want Syntage to deliver events to your server automatically. Access to events is only guaranteed for 7 days. Entity lifecycle events still use the `link.*` event type names for backwards compatibility. The suffix describes the kind of change: | Suffix | Meaning | | --- | --- | | `.created` | A new resource was created. | | `.updated` | An existing resource changed. | | `.deleted` | A resource was deleted or is no longer available. | | Resource | Event types | | --- | --- | | Credentials | `credential.created`, `credential.updated`, `credential.deleted` | | Entities | `link.created`, `link.updated`, `link.deleted` | | Files | `file.created` | | Extractions | `extraction.created`, `extraction.updated` | | Exports | `export.created`, `export.updated` | | Invoices | `invoice.created`, `invoice.updated`, `invoice.deleted` | | Invoice payments | `invoice_payment.created`, `invoice_payment.updated` | | Invoice line items | `invoice_line_item.created`, `invoice_line_item.updated` | | Tax returns | `tax_return.created`, `tax_return.updated`, `tax_return.deleted` | | Tax status | `tax_status.created`, `tax_status.updated`, `tax_status.deleted` | | Tax compliance checks | `tax_compliance_check.created`, `tax_compliance_check.updated`, `tax_compliance_check.deleted` | | Tax retentions | `tax_retention.created`, `tax_retention.updated`, `tax_retention.deleted` | | Electronic accounting records | `electronic_accounting_record.created`, `electronic_accounting_record.updated` | | RPC entidades | `rpc_entidades.created`, `rpc_entidades.updated` | | RPC socios | `rpc_socios.created`, `rpc_socios.updated` | | RPC actos | `rpc_acto.created`, `rpc_acto.updated` | | Shareholder relations | `shareholder_relation.created`, `shareholder_relation.updated` | | Shareholder relation sources | `shareholder_relation_source.created` | | RUG garantias | `rug_garantia.created`, `rug_garantia.updated` | | Buró de Crédito reports | `buro_de_credito_report.created`, `buro_de_credito_report.updated` | | Background checks | `background_check.created` | | SAT certificates | `sat_certificate.created`, `sat_certificate.updated` | | Company verification reports | `company_verification_report.created`, `company_verification_report.updated` | - name: Exports description: | Export invoices data in csv or xlsx format. Once you requested an export you will receive an email with a link to download the generated file - name: Files description: | Files associated to resources - name: DS MX SAT Credentials - name: DS MX SAT Certificates - name: Entities description: | An Entity is a resource that represents a person or company. Entities can be added via Add Entity, or automatically when a credential is validated (when the status becomes "valid"). This resource controls your access to data and allows you to create new extractions. When an Entity is deleted, its data is deleted as well. Its events stay available through the Events endpoints for the same 7 days as any other event. - name: Extractions description: | 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 | | ---- | ----------- | --------- | | unrecoverable | The extraction failed in a way that retrying won't fix. Contact support for help with the entity. Older extractions can also have this code when the extraction process failed many times and reached the maximum number of retries. | No | | 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 | The following codes are no longer assigned to new extractions, but they can still appear on older extractions: | Code | Description | Retryable | | ---- | ----------- | --------- | | invalid_credentials | The SAT [Credential](#tag/Credentials) was no longer valid. | After updating the credential | | login_failed | We couldn't log in with the SAT credential. | Yes | | datasource_disabled | The Buró de Crédito integration was disabled for the entity type. | No | An invalid credential doesn't fail a new extraction. The extraction stays `waiting` until the credential is valid again, and then it resumes automatically. Failed extractions don't resume, including older ones with `invalid_credentials`: update the credential, and then create a new extraction. Before retrying a failed extraction manually, check [Syntage Status](https://status.syntage.com/) for an incident affecting the relevant datasource or service, and follow its published instructions. See [Extractions](/resources/core/extractions#retrying-failed-extractions) for details. - name: DS MX SAT Invoices description: | Invoices represent CFDI documents issued or received by an entity. Invoice records include SAT identifiers, issuer and receiver data, monetary totals, payment status, cancellation status, invoice relationships, file availability, and tags. Use the entity invoice list when you need all invoices extracted for one entity. Retrieve an invoice by ID when you need the full invoice resource, including tags and related invoice metadata. Use the CFDI endpoint when you need the XML or PDF content for a specific invoice. ### Blacklist status The field `issuer.blacklistStatus` or `receiver.blacklistStatus` is set while the invoice issuer or receiver RFC appears in a current [SAT 69-B publication source](https://www.sat.gob.mx/minisitio/DatosAbiertos/contribuyentes_publicados.html). It is `null` when the RFC is absent from all current sources, even if the RFC appeared in an earlier publication: | Status | Description | |-------------|-----------------------------------------------------------------------------------------------------------| | presumed | SAT has identified possible irregularities and started an investigation | | dismissed | SAT dismissed the investigation after reviewing evidence | | definitive | SAT determined that the RFC has confirmed irregularities | | favorable | SAT reversed a definitive status after reviewing additional evidence | - name: DS MX SAT Invoice Line Items - name: DS MX SAT Invoice Relations description: | Invoice relations represent CFDI relationships between invoices, such as substitutions, credit notes, or other SAT-defined relation types. Each relation includes the source invoice, related invoice when Syntage has it, related invoice UUID, and the SAT relation type code. - name: DS MX SAT Tax Retentions - name: DS MX SAT Credit Notes - name: DS MX RPC Entidades description: | RPC entidades are company records extracted from the Registro Publico de Comercio. They group registration profile data, related registry acts, and shareholder records found for an entity. - name: DS MX RPC Actos description: | RPC actos are commercial registry acts associated with an RPC entidade. They can include extracted act data and file references for registry documents. - name: DS MX RPC Socios description: | RPC socios are shareholder or partner records found in RPC filings. - name: Scheduler Rules - name: Schedulers - name: DS MX SAT Invoice Batch Payments description: | Batch payments are derived from payment receipt CFDIs, also known as type `P` invoices. A batch payment groups one or more invoice payments into the payment transaction reported by SAT. Use batch payments when you need payment-method, currency, bank, operation-number, or transaction-level information. Use invoice payments when you need the amount applied to a specific deferred invoice. - name: DS MX SAT Invoice Payments description: | Invoice payments are derived from payment receipt CFDIs, also known as type `P` invoices. A payment receipt records payment activity for a previously issued deferred invoice. Each payment belongs to a batch payment and the invoice it was applied to. Syntage updates the related invoice's `paidAmount`, `dueAmount`, and `fullyPaidAt` fields based on the received payments. - name: DS MX SAT Electronic Accounting - name: DS MX SAT Tax Returns - name: DS MX SAT Tax Compliance Checks description: | A tax compliance check maps the content of Opinion de Cumplimiento de Obligaciones Fiscales, an official SAT document that states whether an RFC is complying with its tax obligations. Each tax compliance check is a snapshot of the compliance result at a specific check date. | Result | Meaning | |---|---| | `positive` | The RFC is complying with its tax obligations | | `negative` | SAT reported one or more compliance issues | | `no_obligations` | SAT reported no active tax obligations | | `activity_suspended` | SAT reported suspended business activity | - name: DS MX SAT Tax Status - name: Cash Flow Insight - name: Balance Sheet Insight - name: Income Statement Insight - name: Invoicing Concentration Insight - name: Customer Concentration Insight - name: Vendor Concentration Insight - name: Employees Insight - name: Expenditures Insight - name: Financial Institutions Insight - name: Financial Ratios Insight - name: Government Customers Insight - name: Blacklisted Counterparties Insight - name: Risks Insight - name: Sales Revenue Insight - name: Summary Insight - name: Trial Balance Insight - name: Shareholders Insight - name: RPC Shareholders Insight - name: Customer Network Insight - name: Vendor Network Insight - name: Invoicing Annual Comparison Insight - name: Scores Insight - name: Insight Exports description: | Insight exports return supported entity insights as CSV or XLSX files. - name: Reports description: | Reports group entity insights into a configurable layout. A report is rendered in the dashboard's Reports section and can be downloaded as a PDF document with the [Exports API](/api-reference/exports/export-data). Built-in reports are created and kept up to date by Syntage and cannot be modified or deleted. Custom reports are personal by default; organizational reports are shared with every user in the organization. - name: Webhook Endpoints description: | Webhook endpoints tell Syntage where to deliver events for your organization. Each endpoint includes the HTTPS delivery URL, subscribed event types, enabled state, payload content type, and signing secret. - name: Webhook Requests description: | Webhook requests are delivery attempts from Syntage to a webhook endpoint. Use them to monitor delivery status, inspect failed deliveries, and connect an event to the endpoint that received it. - name: DS Syntage Score description: | Syntage Score calculates an internal score for a company entity from SAT annual tax return data and tax compliance data. - name: DS MX RUG Operaciones description: | RUG operations are registry acts associated with a movable collateral guarantee. They include operation metadata, guarantee numbers, grantors, parsed boleta data, and file references when available. - name: DS MX RUG Garantias description: | RUG guarantees are movable collateral guarantees registered in Mexico's Registro Unico de Garantias Mobiliarias. - name: DS MX Buró de Crédito Reports description: | Buró de Crédito reports contain credit bureau data generated for an entity by the `buro_de_credito_report` extractor. Reports include the selected product type, provider report ID, parsed provider response, score when available, and generated files such as the report PDF. - name: DS MX Buró de Crédito Authorizations description: | Buró de Crédito authorizations store the consent, RFC, address, and identity data required before Syntage can request Buró de Crédito reports for an entity. - name: Background Checks description: | Background checks provide comprehensive verification and screening data for entities. These checks gather information from various databases and sources to assess risk, verify identity, and provide insights into an entity's background across multiple categories. ### Check Categories Background checks are organized into specific categories: - **personal_identity**: Identity verification and personal information - **criminal_record**: Criminal background and legal history - **legal_background**: Legal proceedings and court records - **business_background**: Business registration and commercial activity - **professional_background**: Professional licenses and certifications - **credit_history**: Credit and financial history - **taxes_and_finances**: Tax compliance and financial records - **affiliations_and_insurances**: Professional affiliations and insurance records - **driving_licenses**: Driving licenses and vehicle permits - **vehicle_information**: Vehicle ownership and registration - **traffic_fines**: Traffic violations and fines - **alert_in_media**: Media mentions and public records - **behavior**: Behavioral patterns and risk indicators - **international_background**: International records and verification - **politically_exposed_person**: PEP (Politically Exposed Person) screening - **document_validation**: Document authenticity verification ### Check Status - **pending**: Background check is being processed - **completed**: Background check has been completed successfully - **error**: Background check encountered an error during processing ### Supported Countries - **MX**: Mexico-specific background checks - **ALL**: International background checks across multiple countries - name: Company Verification Reports description: | Company Verification Reports provide verification of company details and supporting files extracted from trusted sources. Use these endpoints to retrieve reports for a specific entity, list all reports, or download the generated PDF report. - name: Shareholders description: | Shareholders represent individuals or entities that own shares in a company. This resource provides information about shareholders, their relationships with entities, and the sources of shareholder information. ### Shareholder Types - **physical**: Individual person shareholders - **legal**: Corporate entity shareholders - **unknown**: When the shareholder type cannot be determined ### Relation Types - **shareholders**: Indicates the entity's shareholders - **shareholder_of**: Indicates entities that this shareholder owns shares in ### Source Types - **manual**: Manually entered shareholder information - **rpc_socio**: Information sourced from RPC (Registro Público de Comercio) - **company_verification**: Cap-table shareholders synced from a company verification report - name: DS MX Infonavit Overdue Credits description: | Infonavit overdue credits are employer registrations found in the Infonavit Créditos Firmes list of firm (overdue) housing-credit obligations, matched to an entity by name by the `infonavit` extractor. Records include the employer registration number (NRP), reported state, credit count, and publication dates. servers: - url: https://api.syntage.com description: Production - url: https://api.sandbox.syntage.com description: Sandbox components: securitySchemes: ApiKey: type: apiKey in: header name: X-API-Key description: | Your API key is available in the [Production](https://app.syntage.com/settings/api-keys) and [Sandbox](https://app.sandbox.syntage.com/settings/api-keys) dashboards. parameters: entityId: name: entityId in: path required: true example: 91106968-1abd-4d64-85c1-4e73d96fb997 schema: type: string format: uuid resourceId: name: id in: path required: true example: 91106968-1abd-4d64-85c1-4e73d96fb997 schema: type: string format: uuid companyVerificationReportId: name: reportId in: path required: true description: Identifier of the Company Verification report. example: 91ab5678-1234-5678-9abc-def012345678 schema: type: string format: uuid createdAtBefore: name: createdAt[before] in: query description: Filter by resource creation date (less than or equal `<=`) example: "2020-01-17 11:47:27" schema: type: string format: date-time createdAtStrictlyBefore: name: createdAt[strictly_before] in: query description: Filter by resource creation date (less than `<`) example: "2020-01-17 11:47:27" schema: type: string format: date-time createdAtAfter: name: createdAt[after] in: query description: Filter by resource creation date (greater than or equal `>=`) example: "2020-01-17 11:47:27" schema: type: string format: date-time createdAtStrictlyAfter: name: createdAt[strictly_after] in: query description: Filter by resource creation date (greater than `>`) example: "2020-01-17 11:47:27" schema: type: string format: date-time orderCreatedAt: name: order[createdAt] in: query description: Order by resource creation date schema: $ref: "#/components/schemas/CollectionOrder" collectionPage: name: page in: query required: false description: Collection page number schema: $ref: "#/components/schemas/CollectionPage" collectionCursorNextPageParam: name: id[lt] in: query required: false example: 91106968-1abd-4d64-85c1-4e73d96fb997 description: Collection cursor pointer to the next page schema: type: string collectionCursorPreviousPageParam: name: id[gt] in: query required: false example: 91106968-1abd-4d64-85c1-4e73d96fb997 description: Collection cursor pointer to the previous page schema: type: string collectionLimit: name: itemsPerPage in: query required: false description: Number of items per page schema: $ref: "#/components/schemas/CollectionLimit" taxpayerId: name: id in: path required: true schema: $ref: "#/components/schemas/TaxpayerID" orderUpdatedAt: name: order[updatedAt] in: query description: Order by resource update date schema: $ref: "#/components/schemas/CollectionOrder" invoiceId: name: id in: path required: true schema: $ref: "#/components/schemas/InvoiceID" updatedAtBefore: name: updatedAt[before] in: query description: Filter by the date the resource was last updated (less than or equal `<=`) example: "2020-01-17 11:47:27" schema: type: string format: date-time updatedAtStrictlyBefore: name: updatedAt[strictly_before] in: query description: Filter by the date the resource was last updated (less than `<`) example: "2020-01-17 11:47:27" schema: type: string format: date-time updatedAtAfter: name: updatedAt[after] in: query description: Filter by the date the resource was last updated (greater than or equal `>=`) example: "2020-01-17 11:47:27" schema: type: string format: date-time updatedAtStrictlyAfter: name: updatedAt[strictly_after] in: query description: Filter by the date the resource was last updated (greater than `>`) example: "2020-01-17 11:47:27" schema: type: string format: date-time taxReturnId: name: id in: path required: true schema: $ref: "#/components/schemas/TaxReturnID" validFromBefore: name: validFrom[before] in: query description: Filter certificates by validity start date (less than or equal `<=`) example: "2025-01-01T00:00:00+00:00" schema: type: string format: date-time validFromStrictlyBefore: name: validFrom[strictly_before] in: query description: Filter certificates by validity start date (less than `<`) example: "2025-01-01T00:00:00+00:00" schema: type: string format: date-time validFromAfter: name: validFrom[after] in: query description: Filter certificates by validity start date (greater than or equal `>=`) example: "2020-01-01T00:00:00+00:00" schema: type: string format: date-time validFromStrictlyAfter: name: validFrom[strictly_after] in: query description: Filter certificates by validity start date (greater than `>`) example: "2020-01-01T00:00:00+00:00" schema: type: string format: date-time validToBefore: name: validTo[before] in: query description: Filter certificates by validity end date (less than or equal `<=`) example: "2030-01-01T00:00:00+00:00" schema: type: string format: date-time validToStrictlyBefore: name: validTo[strictly_before] in: query description: Filter certificates by validity end date (less than `<`) example: "2030-01-01T00:00:00+00:00" schema: type: string format: date-time validToAfter: name: validTo[after] in: query description: Filter certificates by validity end date (greater than or equal `>=`) example: "2025-01-01T00:00:00+00:00" schema: type: string format: date-time validToStrictlyAfter: name: validTo[strictly_after] in: query description: Filter certificates by validity end date (greater than `>`) example: "2025-01-01T00:00:00+00:00" schema: type: string format: date-time orderValidFrom: name: order[validFrom] in: query description: Order certificates by validity start date schema: $ref: "#/components/schemas/CollectionOrder" orderValidTo: name: order[validTo] in: query description: Order certificates by validity end date schema: $ref: "#/components/schemas/CollectionOrder" serialNumberFilter: name: serialNumber in: query description: Filter certificates by serial number (supports partial matching) example: "00001000000516152485" schema: type: string certificateTypeFilter: name: type in: query description: Filter certificates by type schema: type: string enum: - efirma - csd shareholderId: name: shareholderId in: path required: true description: The shareholder ID example: 91ab5678-1234-5678-9abc-def012345678 schema: type: string format: uuid relationId: name: relationId in: path required: true description: The relation ID example: 82cd9012-3456-7890-abcd-ef1234567890 schema: type: string format: uuid sourceId: name: sourceId in: path required: true description: The source ID example: 73de0123-4567-8901-bcde-f23456789012 schema: type: string format: uuid shareholderTypeFilter: name: type in: query description: Filter shareholders by type schema: type: string enum: - physical - legal - unknown relationTypeFilter: name: relationType in: query description: Filter relations by type schema: type: string enum: - shareholders - shareholder_of sourceNameFilter: name: sourceName in: query description: Filter sources by name schema: type: string enum: - manual - rpc_socio - company_verification shareholderNameFilter: name: name in: query description: Filter shareholders by name (supports partial matching) example: "JUAN PEREZ" schema: type: string shareholderRfcFilter: name: rfc in: query description: Filter shareholders by RFC (supports partial matching) example: "PEGJ850101" schema: type: string orderShares: name: order[shares] in: query description: Order by number of shares schema: $ref: "#/components/schemas/CollectionOrder" orderOwnership: name: order[ownership] in: query description: Order by ownership percentage schema: $ref: "#/components/schemas/CollectionOrder" orderName: name: order[name] in: query description: Order by name schema: $ref: "#/components/schemas/CollectionOrder" backgroundCheckId: name: backgroundCheckId in: path required: true description: The background check ID example: 91ab5678-1234-5678-9abc-def012345678 schema: type: string format: uuid backgroundCheckCategoryFilter: name: category in: query description: Filter background check records by category schema: $ref: "#/components/schemas/BackgroundCheckCategory" backgroundCheckStatusFilter: name: status in: query description: Filter background checks by status schema: $ref: "#/components/schemas/BackgroundCheckStatus" backgroundCheckCountryFilter: name: country in: query description: Filter background checks by country schema: $ref: "#/components/schemas/BackgroundCheckCountry" orderScore: name: order[score] in: query description: Order by background check score schema: $ref: "#/components/schemas/CollectionOrder" schemas: AccountsPayableReceivableRow: type: object properties: amount: description: Total amount in the original currency type: number example: 50000.00 metric: description: Total amount in `MXN` for the period. type: number example: 50000.00 date: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. deprecated: true type: string example: "202408" dateLabel: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. deprecated: true type: string example: "202408" startDate: description: The start date of the period in `YYYY-MM-DD` format. type: string format: date example: "2024-08-01" dimension: description: | The dimension value for the row: - `"Due"` / `"Vencido"` — outstanding amount for the period (`nonCumulative` only). - `"Paid"` / `"Pagado"` — amount paid in the period (`nonCumulative` only). - `"Cumulative Due"` / `"Vencido Acumulado"` — running cumulative outstanding amount (`cumulative` only). The exact string is localized based on the request's `Accept-Language` header. type: string example: Due label: description: Human-readable display label. Equal to `dimension`. type: string example: Due groupName: description: | **Deprecated.** Use `dimension` instead. Same value as `dimension`. deprecated: true type: string example: Due BuroDeCreditoAuthorization: oneOf: - title: Person type: object required: - id - rfc - authorizedAt - authorizedUntil - validityYears - link - nationality - birthdate - firstName - firstLastName - secondLastName - address - city - municipality - state - postalCode - neighborhood - country - createdAt - updatedAt properties: id: type: string format: uuid description: Unique authorization ID example: "9bd4a640-9f41-4cd5-a158-20767b386ca0" rfc: type: string description: RFC authorized for Buró de Crédito report requests example: "PRPU800101HM2" link: description: Entity associated with the authorization $ref: "#/components/schemas/Entity" authorizedAt: type: string format: date-time description: Date and time when authorization was granted example: "2024-01-31T00:00:00+00:00" authorizedUntil: type: string format: date-time description: Date and time when authorization expires example: "2027-01-31T00:00:00+00:00" validityYears: type: integer enum: - 1 - 2 - 3 description: Term, in years, that this authorization was signed under. `authorizedUntil` is this many years after `authorizedAt`. example: 3 nationality: type: string description: Two-letter nationality code example: "MX" birthdate: type: string format: date description: Person birth date example: "1980-01-01" firstName: type: string description: Person first name example: "UNO" middleName: type: [string, "null"] description: Person middle name example: "DOS" firstLastName: type: string description: Person first last name example: "PRUEBA" secondLastName: type: string description: Person second last name example: "PROSPECTOR" address: type: string description: Street name used for the authorization address example: "Jaime Balmes" city: type: string description: City used for the authorization address example: "Cd de Mexico" municipality: type: string description: Municipality or borough used for the authorization address example: "Miguel Hidalgo" state: type: string description: Buró de Crédito state code for the authorization address example: "CMX" postalCode: type: string description: Five-digit postal code used for the authorization address example: "11510" exteriorNumber: type: [string, "null"] description: Exterior number used for the authorization address example: "8" interiorNumber: type: [string, "null"] description: Interior number used for the authorization address example: "" neighborhood: type: string description: Neighborhood used for the authorization address example: "Los morales" country: type: string description: Two-letter country code for the authorization address example: "MX" email: type: [string, "null"] description: Email address associated with the authorization when available example: "person@example.com" origin: type: string enum: - external - onboarding description: How the authorization was created example: external isValid: type: boolean description: Whether the authorization has not expired example: true createdAt: type: string format: date-time description: Date and time when the authorization was created example: "2024-01-31T00:00:00+00:00" updatedAt: type: string format: date-time description: Date and time when the authorization was last updated example: "2024-01-31T00:00:00+00:00" deletedAt: type: [string, "null"] format: date-time description: Date and time when the authorization was deleted example: "2024-01-31T00:00:00+00:00" - title: Company type: object required: - id - rfc - authorizedAt - authorizedUntil - validityYears - link - nationality - tradeName - address - city - municipality - state - postalCode - neighborhood - country - createdAt - updatedAt properties: id: type: string format: uuid description: Unique authorization ID example: "9bd4a640-9f41-4cd5-a158-20767b386ca0" rfc: type: string description: RFC authorized for Buró de Crédito report requests example: "PRPU800101HM2" link: description: Entity associated with the authorization $ref: "#/components/schemas/Entity" authorizedAt: type: string format: date-time description: Date and time when authorization was granted example: "2024-01-31T00:00:00+00:00" authorizedUntil: type: string format: date-time description: Date and time when authorization expires example: "2027-01-31T00:00:00+00:00" validityYears: type: integer enum: - 1 - 2 - 3 description: Term, in years, that this authorization was signed under. `authorizedUntil` is this many years after `authorizedAt`. example: 3 nationality: type: string description: Two-letter nationality code example: "MX" tradeName: type: string description: Company trade or legal name used for the authorization example: "PROSPECTOR" address: type: string description: Street name used for the authorization address example: "Jaime Balmes" city: type: string description: City used for the authorization address example: "Cd de Mexico" municipality: type: string description: Municipality or borough used for the authorization address example: "Miguel Hidalgo" state: type: string description: Buró de Crédito state code for the authorization address example: "CMX" postalCode: type: string description: Five-digit postal code used for the authorization address example: "11510" exteriorNumber: type: [string, "null"] description: Exterior number used for the authorization address example: "8" interiorNumber: type: [string, "null"] description: Interior number used for the authorization address example: "" neighborhood: type: string description: Neighborhood used for the authorization address example: "Los morales" country: type: string description: Two-letter country code for the authorization address example: "MX" email: type: [string, "null"] description: Email address associated with the authorization when available example: "company@example.com" origin: type: string enum: - external - onboarding description: How the authorization was created example: external isValid: type: boolean description: Whether the authorization has not expired example: true createdAt: type: string format: date-time description: Date and time when the authorization was created example: "2024-01-31T00:00:00+00:00" updatedAt: type: string format: date-time description: Date and time when the authorization was last updated example: "2024-01-31T00:00:00+00:00" deletedAt: type: [string, "null"] format: date-time description: Date and time when the authorization was deleted example: "2024-01-31T00:00:00+00:00" BuroDeCreditoReport: oneOf: - title: "007" type: object required: - id - link - provider - productType - reportId - data - score - files properties: id: type: string format: uuid description: Unique Buró de Crédito report ID example: "9bd4a640-9f41-4cd5-a158-20767b386ca0" link: type: string format: iri-reference description: Entity associated with the report example: "/entities/0191ebdd-a743-7d0a-840f-5b1b7ff8adcf" provider: type: string enum: - buro_de_credito - moffin description: Provider that generated the report example: buro_de_credito productType: type: string enum: - "007" - "004" description: Buró de Crédito product requested for the report example: "007" reportId: type: string description: Provider report ID example: "012342" data: type: object description: Parsed Buró de Crédito provider response for the selected product type example: respuesta: persona: nombre: RFC: XDFR991206 sexo: M estadoCivil: M nacionalidad: MX primerNombre: CARLOS apellidoMaterno: GARCIA apellidoPaterno: LOPEZ fechaNacimiento: "15071985" claveImpuestosOtroPais: XDFR991206JHGRYD00 numeroRegistroElectoral: "0187654321098" cuentas: - montoPagar: "890" tipoCuenta: R saldoActual: 1260+ fechaReporte: "02082024" modoReportar: A saldoVencido: "0" tipoContrato: CC creditoMaximo: "17689" limiteCredito: "21000" historicoPagos: "11111100" fechaUltimoPago: "02082024" formaPagoActual: "01" frecuenciaPagos: Z montoUltimoPago: "3972" nombreOtorgante: BANCO fechaUltimaCompra: "27072024" fechaActualizacion: "08082024" fechaAperturaCuenta: "21122023" claveUnidadMonetaria: MX numeroTelefonoOtorgante: "0" indicadorTipoResponsabilidad: I fechaMasAntiguaHistoricoPagos: "31122023" fechaMasRecienteHistoricoPagos: "31072024" identificadorSociedadInformacionCrediticia: "0" - montoPagar: "0" tipoCuenta: I numeroPagos: "16" saldoActual: 0+ fechaReporte: "14012021" modoReportar: A saldoVencido: "0" tipoContrato: PL creditoMaximo: "5174" historicoPagos: "1111" fechaUltimoPago: "12012021" formaPagoActual: "01" frecuenciaPagos: V montoUltimoPago: "393" nombreOtorgante: BANCO claveObservacion: CC fechaCierreCuenta: "13012021" fechaUltimaCompra: "23092020" fechaActualizacion: "15012021" fechaAperturaCuenta: "23092020" claveUnidadMonetaria: MX numeroTelefonoOtorgante: "0" indicadorTipoResponsabilidad: I fechaMasAntiguaHistoricoPagos: "30092020" fechaMasRecienteHistoricoPagos: "07122020" identificadorSociedadInformacionCrediticia: "0" - montoPagar: "0" tipoCuenta: I numeroPagos: "16" saldoActual: 0+ fechaReporte: "31082020" modoReportar: A saldoVencido: "0" tipoContrato: PL creditoMaximo: "5174" historicoPagos: "311111111" fechaUltimoPago: "27082020" formaPagoActual: "01" frecuenciaPagos: V montoUltimoPago: "1620" nombreOtorgante: BANCO claveObservacion: CC fechaCierreCuenta: "30082020" fechaUltimaCompra: "22012020" fechaActualizacion: "02092020" fechaAperturaCuenta: "22012020" numeroPagosVencidos: "1" claveUnidadMonetaria: MX numeroTelefonoOtorgante: "0" indicadorTipoResponsabilidad: I fechaMasAntiguaHistoricoPagos: "30112019" mopHistoricoMorosidadMasGrave: "03" fechaMasRecienteHistoricoPagos: "31072020" fechaHistoricaMorosidadMasGrave: "31072020" importeSaldoMorosidadHistMasGrave: "345" identificadorSociedadInformacionCrediticia: "0" empleos: - cP: "77560" estado: QR codPais: MX direccion1: CALLE JUAREZ 123 nombreEmpresa: TRABAJADOR INDEPENDIENTE coloniaPoblacion: CENTRO delegacionMunicipio: BENITO JUAREZ - cargo: NEGOCIO PROPIO DUENO codPais: MX direccion1: "" nombreEmpresa: MATERIALES LA ROCA domicilios: - cP: "77560" estado: QR codPais: MX direccion1: CALLE HIDALGO 456 tipoDomicilio: H numeroTelefono: "9981234567" coloniaPoblacion: CENTRO delegacionMunicipio: BENITO JUAREZ fechaReporteDireccion: "16012020" - cP: "77560" estado: QR codPais: MX direccion1: CALLE MORELOS 789 tipoDomicilio: H numeroTelefono: "9987654321" coloniaPoblacion: CENTRO delegacionMunicipio: BENITO JUAREZ fechaReporteDireccion: "11122019" indicadorEspecialDomicilio: K encabezado: clavePais: MX claveOtorgante: FFA4771003 identificadorBuro: "1020" numeroControlConsulta: "3406534887" numeroReferenciaOperador: cc0be12a952043ba9ce2bf840 claveRetornoConsumidorPrincipal: "1" claveRetornoConsumidorSecundario: "0" hawkAlertBD: - mensaje: TELEFONO 9981234567 NO CORRESPONDE A ZONA POSTAL codigoClave: "850" fechaReporte: "13082024" tipoInstitucion: BURO DE CREDITO - mensaje: TELEFONO 9981234567 CORRESPONDE A NUMERO MOVIL codigoClave: "870" fechaReporte: "13082024" tipoInstitucion: BURO DE CREDITO - mensaje: TELEFONO 9987654321 NO CORRESPONDE A ZONA POSTAL codigoClave: "850" fechaReporte: "13082024" tipoInstitucion: BURO DE CREDITO - mensaje: COLONIA NO COINCIDE CON CODIGO POSTAL 77560 codigoClave: "890" fechaReporte: "13082024" tipoInstitucion: BURO DE CREDITO - mensaje: TELEFONO 9987654321 CORRESPONDE A NUMERO MOVIL codigoClave: "870" fechaReporte: "13082024" tipoInstitucion: BURO DE CREDITO - mensaje: 12-ORC-ACD(24-02)-000310/2021-DGO-PAPASQUIARO S codigoClave: "990" fechaReporte: "13072021" tipoInstitucion: INF DE JUICIOS - mensaje: 12-NOP-ACD(23-11)-000047/2021-DGO-PAPASQUIARO S codigoClave: "990" fechaReporte: "25022021" tipoInstitucion: INF DE JUICIOS resumenReporte: - numeroMOP0: "00" numeroMOP1: "03" numeroMOP2: "00" numeroMOP3: "00" numeroMOP4: "00" numeroMOP5: "00" numeroMOP6: "00" numeroMOP7: "00" tipoMoneda: MX numeroMOP96: "00" numeroMOP97: "00" numeroMOP99: "00" numeroMOPUR: "00" numeroCuentas: "0003" cuentasDisputa: "00" fechaIngresoBD: "11122019" mensajesAlerta: NNNNN cuentasCerradas: "0002" totalPagosPagosFijos: "000000000" totalPagosRevolventes: "000000890" totalSolicitudesReporte: "08" cuentasNegativasActuales: "0000" cuentasPagosFijosHipotecas: "0002" cuentasRevolventesAbiertas: "0001" cuentasClavesHistoriaNegativa: "0001" fechaAperturaCuentaMasAntigua: "22012020" totalSaldosActualesPagosFijos: 000000000+ totalSaldosVencidosPagosFijos: "000000000" fechaAperturaCuentaMasReciente: "21122023" numeroSolicitudesUltimos6Meses: "03" totalCreditosMaximosPagosFijos: "000000000" totalLimitesCreditoRevolventes: "000021000" totalSaldosActualesRevolventes: 000001260+ totalSaldosVencidosRevolventes: "000000000" totalCreditosMaximosRevolventes: "000017689" fechaSolicitudReporteMasReciente: "31072024" existenciaDeclaracionesConsumidor: N numeroTotalCuentasDespachoCobranza: "00" nuevaDireccionReportadaUltimos60Dias: N pctLimiteCreditoUtilizadoRevolventes: "006" numeroTotalSolicitudesDespachosCobranza: "00" fechaSolicitudMasRecienteDespachoCobranza: "00000000" fechaAperturaCuentaMasRecienteDespachoCobranza: "00000000" scoreBuroCredito: - valorScore: "0676" codigoRazon: - "04" codigoScore: "007" nombreScore: BC SCORE hawkAlertConsulta: - mensaje: 12-NOP-ACD(23-11)-000047/2021-DGO-PAPASQUIARO S codigoClave: "990" fechaReporte: "25022021" tipoInstitucion: INF DE JUICIOS - mensaje: 12-ORC-ACD(24-02)-000310/2021-DGO-PAPASQUIARO S codigoClave: "990" fechaReporte: "13072021" tipoInstitucion: INF DE JUICIOS consultaEfectuadas: - tipoContrato: CS fechaConsulta: "13082024" claveOtorgante: FFA4771003 resultadoFinal: "0" importeContrato: "0" nombreOtorgante: VANDELIER identificadorOrigenConsulta: "0" indicadorTipoResponsabilidad: I - tipoContrato: LS fechaConsulta: "31072024" resultadoFinal: "0" importeContrato: "0" nombreOtorgante: ARRENDAMIENTO identificadorOrigenConsulta: "0" indicadorTipoResponsabilidad: I - tipoContrato: CC fechaConsulta: "22072024" resultadoFinal: "0" importeContrato: "100" nombreOtorgante: BANCO claveUnidadMonetaria: MX identificadorOrigenConsulta: "0" indicadorTipoResponsabilidad: I - tipoContrato: UK fechaConsulta: "08032024" resultadoFinal: "0" importeContrato: "1000" nombreOtorgante: SIC claveUnidadMonetaria: MX identificadorOrigenConsulta: "0" indicadorTipoResponsabilidad: I - tipoContrato: CC fechaConsulta: "21122023" resultadoFinal: "0" importeContrato: "0" nombreOtorgante: BANCO identificadorOrigenConsulta: "0" indicadorTipoResponsabilidad: I - tipoContrato: CC fechaConsulta: "18112023" resultadoFinal: "0" importeContrato: "0" nombreOtorgante: BANCO identificadorOrigenConsulta: "0" indicadorTipoResponsabilidad: I - tipoContrato: CC fechaConsulta: "20042023" resultadoFinal: "0" importeContrato: "0" nombreOtorgante: BANCO identificadorOrigenConsulta: "0" indicadorTipoResponsabilidad: I - tipoContrato: CC fechaConsulta: "19122022" resultadoFinal: "0" importeContrato: "0" nombreOtorgante: BANCO identificadorOrigenConsulta: "0" indicadorTipoResponsabilidad: I - tipoContrato: CC fechaConsulta: "19102022" resultadoFinal: "0" importeContrato: "0" nombreOtorgante: BANCO identificadorOrigenConsulta: "0" indicadorTipoResponsabilidad: I score: type: [string, "null"] description: Score returned by the selected Buró de Crédito product when available example: "0676" files: type: array description: Files generated for the report, including the report PDF items: allOf: - $ref: "#/components/schemas/File" - example: type: buro_de_credito.report.pdf resource: /datasources/mx/buro-de-credito/reports/9cc7fc78-5e84-4862-af83-c6c7022fcb41 mimeType: application/pdf extension: pdf filename: 9cc7fc78-5e84-4862-af83-c6c7022fcb41.pdf createdAt: type: string format: date-time description: Date and time when the report was created example: "2024-01-31T00:00:00+00:00" updatedAt: type: string format: date-time description: Date and time when the report was last updated example: "2024-01-31T00:00:00+00:00" - title: INFORME_BURO type: object required: - id - link - provider - productType - reportId - data - score - files properties: id: type: string format: uuid description: Unique Buró de Crédito report ID example: "9bd4a640-9f41-4cd5-a158-20767b386ca0" link: type: string format: iri-reference description: Entity associated with the report example: "/entities/0191ebdd-a743-7d0a-840f-5b1b7ff8adcf" provider: type: string enum: - buro_de_credito - moffin description: Provider that generated the report example: buro_de_credito productType: type: string enum: - INFORME_BURO - RCO description: Buró de Crédito product requested for the report example: INFORME_BURO reportId: type: string description: Provider report ID example: "012342" data: type: object description: Parsed Buró de Crédito provider response for the selected product type example: score: - errorScore: "0" valorScore: "307" codigoScore: "012" codigoRazon1: Z3 codigoRazon2: W3 hawkHr: - codigoHawk: "000" fechaMensajeHawk: "02052024" descripcionPrevencionHawk: NO SE ENCONTRO INFORMACION historia: - rfc: SSD1912102V8 periodo: "202306" saldoVigente: "0" maximoSaldoVencido: "4" saldoVencidoA90Dias: "0" saldoVencido1A29Dias: "4" saldoVencido30A59Dias: "0" saldoVencido60A89Dias: "0" mayorNumeroDiasVencido: "16" - rfc: SSD1912102V8 periodo: "202307" saldoVigente: "0" maximoSaldoVencido: "4" saldoVencidoA90Dias: "0" saldoVencido1A29Dias: "4" saldoVencido30A59Dias: "0" saldoVencido60A89Dias: "0" mayorNumeroDiasVencido: "16" - rfc: SSD1912102V8 periodo: "202308" saldoVigente: "17" maximoSaldoVencido: "4" saldoVencidoA90Dias: "0" saldoVencido1A29Dias: "0" saldoVencido30A59Dias: "0" saldoVencido60A89Dias: "0" mayorNumeroDiasVencido: "16" - rfc: SSD1912102V8 periodo: "202309" saldoVigente: "23" maximoSaldoVencido: "4" saldoVencidoA90Dias: "0" saldoVencido1A29Dias: "0" saldoVencido30A59Dias: "0" saldoVencido60A89Dias: "0" mayorNumeroDiasVencido: "16" - rfc: SSD1912102V8 periodo: "202310" saldoVigente: "19" maximoSaldoVencido: "4" saldoVencidoA90Dias: "0" saldoVencido1A29Dias: "0" saldoVencido30A59Dias: "0" saldoVencido60A89Dias: "0" mayorNumeroDiasVencido: "16" - rfc: SSD1912102V8 periodo: "202311" saldoVigente: "32" maximoSaldoVencido: "4" saldoVencidoA90Dias: "0" saldoVencido1A29Dias: "0" saldoVencido30A59Dias: "0" saldoVencido60A89Dias: "0" mayorNumeroDiasVencido: "16" - rfc: SSD1912102V8 periodo: "202312" saldoVigente: "38" maximoSaldoVencido: "4" saldoVencidoA90Dias: "0" saldoVencido1A29Dias: "0" saldoVencido30A59Dias: "0" saldoVencido60A89Dias: "0" mayorNumeroDiasVencido: "16" - rfc: SSD1912102V8 periodo: "202401" saldoVigente: "35" maximoSaldoVencido: "4" saldoVencidoA90Dias: "0" saldoVencido1A29Dias: "0" saldoVencido30A59Dias: "0" saldoVencido60A89Dias: "0" mayorNumeroDiasVencido: "16" - rfc: SSD1912102V8 periodo: "202402" saldoVigente: "12" maximoSaldoVencido: "4" saldoVencidoA90Dias: "0" saldoVencido1A29Dias: "0" saldoVencido30A59Dias: "0" saldoVencido60A89Dias: "0" mayorNumeroDiasVencido: "16" - rfc: SSD1912102V8 periodo: "202403" saldoVigente: "33" maximoSaldoVencido: "4" saldoVencidoA90Dias: "0" saldoVencido1A29Dias: "0" saldoVencido30A59Dias: "0" saldoVencido60A89Dias: "0" mayorNumeroDiasVencido: "16" - rfc: SSD1912102V8 periodo: "202404" maximoSaldoVencido: "4" mayorNumeroDiasVencido: "16" - rfc: SSD1912102V8 periodo: "202405" maximoSaldoVencido: "4" mayorNumeroDiasVencido: "16" encabezado: claveRetorno: "1" fechaConsulta: "02052024" identificadorConsulta: "1111" identificadorTransaccion: "0371405559" datosGenerales: pais: MX ciudad: CIUDAD DE MEXICO estado: CDMX nombre: SynMed Equipos Médico SAPI DE CV direccion1: Acapulco 22 rfcCliente: SSD1912102V8 tipoCliente: "1" codigoPostal: "06700" nacionalidad: MX coloniaPoblacion: ROMA NORTE delegacionMunicipio: CUAUHTEMOC indicadorInformacionAdicional: PROD consultaEmpresaComercialMas24Meses: "0" consultaEntidadFinancieraMas24Meses: "0" consultaEmpresaComercialUltimos3Meses: "0" consultaEmpresaComercialUltimos12Meses: "0" consultaEmpresaComercialUltimos24Meses: "0" consultaEntidadFinancieraUltimos3Meses: "2" consultaEntidadFinancieraUltimos12Meses: "5" consultaEntidadFinancieraUltimos24Meses: "7" creditoComercial: total: "618" vencido: "0" vigente: "618" otorgante: "1" rfcCliente: SSD1912102V8 historicoPagos: "1" fechaUltimoReporte: "122023" saldoVencidoDe1a29Dias: "0" saldoVencidoDe30a59Dias: "0" saldoVencidoDe60a89Dias: "0" saldoVencidoDe90a119Dias: "0" saldoVencidoDe120a179Dias: "0" saldoVencidoDe180DiasOMas: "0" creditoFinanciero: - plazo: "0" moneda: "001" apertura: "10032022" rfcCliente: SSD1912102V8 tipoCambio: "1.00" atrasoMayor: "0" tipoCredito: "6280" tipoUsuario: OTRAS FINANCIERAS numeroCuenta: "597876930" saldoInicial: "6241" saldoVigente: "21293" historicoPagos: "111111111111111111111111" saldoVencidoDe1a29Dias: "0" saldoVencidoDe30a59Dias: "0" saldoVencidoDe60a89Dias: "0" saldoVencidoDe90a119Dias: "0" ultimoPeriodoActualizado: "202403" saldoVencidoDe120a179Dias: "0" saldoVencidoDe180DiasOMas: "0" - plazo: "30" moneda: "001" apertura: "30042023" rfcCliente: SSD1912102V8 tipoCambio: "1.00" atrasoMayor: "0" tipoCredito: "1380" tipoUsuario: JEEVES MEXICO numeroCuenta: "100335" saldoInicial: "64288" saldoVigente: "3507" historicoPagos: "111111122" saldoVencidoDe1a29Dias: "0" saldoVencidoDe30a59Dias: "0" saldoVencidoDe60a89Dias: "0" saldoVencidoDe90a119Dias: "0" ultimoPeriodoActualizado: "202403" saldoVencidoDe120a179Dias: "0" saldoVencidoDe180DiasOMas: "0" - plazo: "30" moneda: "001" apertura: "31122023" rfcCliente: SSD1912102V8 tipoCambio: "1.00" atrasoMayor: "0" tipoCredito: "1380" tipoUsuario: JEEVES MEXICO numeroCuenta: "156499" saldoInicial: "8413" saldoVigente: "8413" historicoPagos: "111" saldoVencidoDe1a29Dias: "0" saldoVencidoDe30a59Dias: "0" saldoVencidoDe60a89Dias: "0" saldoVencidoDe90a119Dias: "0" ultimoPeriodoActualizado: "202403" saldoVencidoDe120a179Dias: "0" saldoVencidoDe180DiasOMas: "0" score: type: [string, "null"] description: Score returned by the selected Buró de Crédito product when available example: "307" files: type: array description: Files generated for the report, including the report PDF items: allOf: - $ref: "#/components/schemas/File" - example: type: buro_de_credito.report.pdf resource: /datasources/mx/buro-de-credito/reports/9cc7fc78-5e84-4862-af83-c6c7022fcb41 mimeType: application/pdf extension: pdf filename: 9cc7fc78-5e84-4862-af83-c6c7022fcb41.pdf createdAt: type: string format: date-time description: Date and time when the report was created example: "2024-01-31T00:00:00+00:00" updatedAt: type: string format: date-time description: Date and time when the report was last updated example: "2024-01-31T00:00:00+00:00" BilReport: type: object description: Buró de Investigaciones Legales report generated for an entity. properties: "@id": type: string format: iri-reference description: BIL report IRI reference. example: /datasources/bil/reports/9cc7fc78-5e84-4862-af83-c6c7022fcb41 "@type": type: string description: JSON-LD resource type default: BilReport id: type: string format: uuid description: Unique BIL report ID. example: 9cc7fc78-5e84-4862-af83-c6c7022fcb41 fecha: type: string format: date-time description: Date and time reported by BIL for the generated report. example: "2026-05-19T12:22:39-06:00" investigado: type: string description: Name searched and reported by BIL. example: EMPRESA DE PRUEBA SA DE CV folio: type: string description: BIL report folio. example: ENG10387-001 gradoMaximo: type: integer description: Highest grade returned by BIL for the report. example: 5 data: type: object description: Parsed BIL XML response. The structure follows the vendor response and can vary by report content. additionalProperties: true example: REPORTES: REPORTE: TIPO: BASICO INVESTIGADO: EMPRESA DE PRUEBA SA DE CV FOLIO: ENG10387-001 GRADO_MAXIMO: "5" xmlFile: allOf: - $ref: "#/components/schemas/File" - description: File resource for the original BIL XML response. example: "@id": /files/88d3e2b7-6262-4ec7-9b2b-5a90a6227d01 "@type": File id: 88d3e2b7-6262-4ec7-9b2b-5a90a6227d01 type: bil.report.xml resource: /datasources/bil/reports/9cc7fc78-5e84-4862-af83-c6c7022fcb41 mimeType: text/xml extension: xml filename: ENG10387-001.xml pdfFile: allOf: - $ref: "#/components/schemas/File" - description: File resource for the BIL PDF report. example: "@id": /files/0ab1bdf6-9008-4acf-8e31-8196405df2d0 "@type": File id: 0ab1bdf6-9008-4acf-8e31-8196405df2d0 type: bil.report.pdf resource: /datasources/bil/reports/9cc7fc78-5e84-4862-af83-c6c7022fcb41 mimeType: application/pdf extension: pdf filename: ENG10387-001.pdf createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" BilReportCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/BilReport "@id": example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/datasources/bil/reports "hydra:member": type: array items: $ref: "#/components/schemas/BilReport" InfonavitOverdueCredit: type: object description: Employer registration found in the public Infonavit Créditos Firmes list of firm (overdue) housing-credit obligations, matched to an entity by name. properties: "@id": type: string format: iri-reference description: Infonavit overdue credit IRI reference. example: /datasources/infonavit/overdue-credits/9cc7fc78-5e84-4862-af83-c6c7022fcb41 "@type": type: string description: JSON-LD resource type default: InfonavitOverdueCredit id: type: string format: uuid description: Unique Infonavit overdue credit ID. example: 9cc7fc78-5e84-4862-af83-c6c7022fcb41 nrp: type: string description: Employer registration number (Número de Registro Patronal) as published by Infonavit. example: B5312345108 name: type: string description: Employer name as published in the Infonavit Créditos Firmes list. example: EMPRESA DE PRUEBA SA DE CV stateCode: type: [string, "null"] description: State code reported by Infonavit, when available. example: "09" stateName: type: [string, "null"] description: State name reported by Infonavit, when available. example: CIUDAD DE MEXICO creditCount: type: [integer, "null"] description: Number of firm housing-credit obligations reported for the employer, when available. example: 3 firstPublicationDate: type: [string, "null"] format: date description: Date the employer first appeared in the Infonavit Créditos Firmes list, when available. example: "2025-03-01" year: type: integer description: Year of the Infonavit Créditos Firmes list in which the employer appears. example: 2025 createdAt: $ref: "#/components/schemas/createdAt" InfonavitOverdueCreditCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/InfonavitOverdueCredit "@id": example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/datasources/infonavit/overdue-credits "hydra:member": type: array items: $ref: "#/components/schemas/InfonavitOverdueCredit" RetainedTaxes: type: object description: >- Retained tax amount of the line item by tax type. Carries no rate or factor type; use the line item's `taxes` for the per-node detail, including lines where the CFDI applies the same tax more than once. An amount is `0` when the line item does not include that tax, and `null` for line items extracted before 2023. properties: valueAddedTax: type: [number, "null"] format: double description: Retained value-added tax amount (IVA retenido). example: 0 incomeTax: type: [number, "null"] format: double description: Retained income tax amount (ISR retenido). example: 0 sinTax: type: [number, "null"] format: double description: Retained special tax on production and services amount (IEPS retenido). example: 0 TransferredTaxes: type: object description: >- Transferred tax amount of the line item by tax type. Carries no rate or factor type; use the line item's `taxes` for the per-node detail, including lines where the CFDI applies the same tax more than once. An amount is `0` when the line item does not include that tax, and `null` for line items extracted before 2023. properties: valueAddedTax: type: [number, "null"] format: double description: Transferred value-added tax amount (IVA trasladado). example: 672 sinTax: type: [number, "null"] format: double description: Transferred special tax on production and services amount (IEPS trasladado). example: 0 DatasourceName: type: string enum: - sat - buro_de_credito - rpc - rug - bil Datasource: type: string description: A datasource properties: name: $ref: "#/components/schemas/DatasourceName" createdAt: type: string description: Date and time the resource was created example: "2020-01-01T12:15:00.000Z" updatedAt: type: string description: Date and time the resource was last updated example: "2020-01-01T12:15:00.000Z" File: type: object properties: "@id": type: string format: iri-reference description: File IRI reference example: /files/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string description: JSON-LD resource type default: File example: File id: type: string format: uuid description: Unique file ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 type: type: string description: File category, such as an invoice CFDI XML or PDF example: invoice.cfdi.xml resource: type: string description: IRI of the resource that produced or owns the file example: /invoices/7c45e9c6-8f7f-4d0e-b6e5-65fef6c8c2f9 mimeType: type: string description: Media type of the file content example: text/xml extension: type: string description: File extension for the stored content example: xml size: type: integer description: File size in bytes example: 40544 filename: type: string description: Suggested filename for the file content example: 6f3c5312-2849-4525-86f6-c48a54c64c60.xml createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" SatCertificate: type: object required: - id - link - serialNumber - type - issuer - subject - validFrom - validTo - file - status - revokedAt - createdAt - updatedAt properties: "@id": type: string format: iri-reference description: SAT Certificate IRI reference example: /datasources/mx/sat/certificados/0197a365-6c09-7019-b072-6c756008cd2d "@type": type: string default: SatCertificate id: type: string format: uuid description: SAT certificate ID example: 0197a365-6c09-7019-b072-6c756008cd2d link: type: string format: iri-reference description: Entity IRI reference example: /entities/91ab5678-1234-5678-9abc-def012345678 serialNumber: type: string description: Certificate serial number example: "00001000000516152485" type: type: string enum: - efirma - csd description: Certificate type example: efirma issuer: type: object description: Certificate issuer information properties: id-at-commonName: type: string example: "AUTORIDAD CERTIFICADORA" id-at-postalCode: type: string example: "06300" id-at-countryName: type: string example: "MX" id-at-localityName: type: string example: "CUAUHTEMOC" id-at-streetAddress: type: string example: "AV. HIDALGO 77, COL. GUERRERO" id-at-organizationName: type: string example: "SERVICIO DE ADMINISTRACION TRIBUTARIA" id-at-uniqueIdentifier: type: string example: "SAT970701NN3" pkcs-9-at-emailAddress: type: string example: "contacto.tecnico@sat.gob.mx" id-at-stateOrProvinceName: type: string example: "CIUDAD DE MEXICO" pkcs-9-at-unstructuredName: type: string example: "responsable: ADMINISTRACION CENTRAL DE SERVICIOS TRIBUTARIOS AL CONTRIBUYENTE" id-at-organizationalUnitName: type: string example: "SAT-IES Authority" subject: type: object description: Certificate subject information properties: id-at-name: type: string example: "JUAN MANUEL PEREZ GONZALEZ" id-at-commonName: type: string example: "JUAN MANUEL PEREZ GONZALEZ" id-at-countryName: type: string example: "MX" id-at-serialNumber: $ref: "#/components/schemas/TaxpayerID" id-at-organizationName: type: string example: "JUAN MANUEL PEREZ GONZALEZ" id-at-uniqueIdentifier: type: string example: "PEGJ850101AA1" pkcs-9-at-emailAddress: type: string example: "juan.perez@example.com" validFrom: type: string format: date-time description: Certificate validity start date example: "2022-11-11 19:02:09" validTo: type: string format: date-time description: Certificate validity end date example: "2026-11-11 19:02:49" file: allOf: - $ref: "#/components/schemas/File" - type: object description: "Certificate file. Use the file download endpoint to retrieve the actual file content." example: type: sat.certificate.efirma resource: /datasources/mx/sat/certificados/0197a365-6c09-7019-b072-6c756008cd2d mimeType: application/x-x509-ca-cert extension: cer filename: 91ab5678-1234-5678-9abc-def012345678-00001000000516152485.cer status: type: [string, "null"] enum: - active - revoked - expired - unknown - null description: Certificate status example: active revokedAt: type: [string, "null"] format: date-time description: Date and time when the certificate was revoked, if applicable example: "2023-01-01T12:00:00Z" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" Shareholder: type: object required: - id - name - type - rfc - relations - entity - createdAt - updatedAt properties: "@id": type: string format: iri-reference description: Shareholder IRI reference example: /shareholders/91ab5678-1234-5678-9abc-def012345678 "@type": type: string default: Shareholder id: type: string format: uuid description: Unique shareholder ID example: 91ab5678-1234-5678-9abc-def012345678 name: type: string description: Name of the person or company that owns shares example: "JUAN MANUEL PEREZ GONZALEZ" type: type: string enum: - physical - legal - unknown description: Shareholder type, where `physical` is a person, `legal` is a company, and `unknown` means the type cannot be determined example: physical rfc: anyOf: - $ref: "#/components/schemas/TaxpayerID" - type: "null" description: Shareholder RFC, when available relations: type: array items: $ref: "#/components/schemas/ShareholderRelation" description: Relations that connect this shareholder to entities entity: type: [string, "null"] format: iri-reference description: Entity created for this shareholder after promotion, if the shareholder has been promoted example: /entities/91ab5678-1234-5678-9abc-def012345678 createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" ShareholderRelation: type: object required: - id - link - shareholder - relationType - sources - shares - totalShares - ownership - createdAt - updatedAt properties: "@id": type: string format: iri-reference description: ShareholderRelation IRI reference example: /shareholders/91ab5678-1234-5678-9abc-def012345678/relations/82cd9012-3456-7890-abcd-ef1234567890 "@type": type: string default: ShareholderRelation id: type: string format: uuid description: Unique shareholder relation ID example: 82cd9012-3456-7890-abcd-ef1234567890 link: type: string format: iri-reference description: Entity connected to this shareholder relation example: /entities/91ab5678-1234-5678-9abc-def012345678 shareholder: allOf: - $ref: "#/components/schemas/Shareholder" description: Shareholder connected by this relation relationType: type: string enum: - shareholders - shareholder_of description: Direction of the ownership relation between the shareholder and entity example: shareholders sources: type: array items: $ref: "#/components/schemas/ShareholderRelationsSource" description: Sources that support this shareholder relation shares: type: number format: float description: Number of shares represented by this relation example: 1500.50 totalShares: type: [number, "null"] format: float description: Total number of shares in the company, when known example: 10000.00 ownership: type: [number, "null"] format: float description: Ownership ratio as a decimal value, for example `0.15` means 15% example: 0.15 createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" ShareholderRelationsSource: type: object required: - id - relation - shareholder - sourceName - sourceId - shares - createdAt - updatedAt properties: "@id": type: string format: iri-reference description: ShareholderRelationsSource IRI reference example: /shareholders/91ab5678-1234-5678-9abc-def012345678/relations/82cd9012-3456-7890-abcd-ef1234567890/sources/73de0123-4567-8901-bcde-f23456789012 "@type": type: string default: ShareholderRelationsSource id: type: string format: uuid description: Unique shareholder relation source ID example: 73de0123-4567-8901-bcde-f23456789012 relation: allOf: - $ref: "#/components/schemas/ShareholderRelation" description: Shareholder relation supported by this source shareholder: allOf: - $ref: "#/components/schemas/Shareholder" description: Shareholder described by this source sourceName: type: string enum: - manual - rpc_socio - company_verification description: Source that provided the shareholder information example: manual sourceId: type: string format: uuid description: ID of the source record that provided this information example: 64ef1234-5678-9012-cdef-345678901234 shares: type: number format: float description: Number of shares reported by this source example: 1500.50 createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" ShareholderRelationType: type: string enum: - shareholders - shareholder_of description: | Represents the relationship between a shareholder and an entity: - **shareholders**: The entity's shareholders - **shareholder_of**: Entities that this shareholder owns shares in example: shareholders ShareholderType: type: string enum: - physical - legal - unknown description: | Type of shareholder: - **physical**: Individual person shareholders - **legal**: Corporate entity shareholders - **unknown**: When the shareholder type cannot be determined example: physical ShareholderRelationSourceName: type: string enum: - manual - rpc_socio - company_verification description: | Source of the shareholder information: - **manual**: Manually entered shareholder information - **rpc_socio**: Information from RPC datasource - **company_verification**: Cap-table shareholders synced from a company verification report example: manual BackgroundCheck: type: object required: - id - link - country - score - status - scores - databaseStatuses - files - createdAt - updatedAt properties: "@id": type: string format: iri-reference description: Background Check IRI reference example: /background-checks/91ab5678-1234-5678-9abc-def012345678 "@type": type: string default: BackgroundCheck id: type: string format: uuid description: Unique background check ID example: 91ab5678-1234-5678-9abc-def012345678 link: type: string format: iri-reference description: Entity associated with the background check example: /entities/91ab5678-1234-5678-9abc-def012345678 country: allOf: - $ref: "#/components/schemas/BackgroundCheckCountry" description: Country scope for the background check score: type: number format: float description: Overall score returned by the background check provider example: 85.5 status: allOf: - $ref: "#/components/schemas/BackgroundCheckStatus" description: Processing status for the background check scores: type: array items: $ref: "#/components/schemas/BackgroundCheckScore" description: Scores returned for each background check category databaseStatuses: type: array items: $ref: "#/components/schemas/BackgroundCheckDatabaseStatus" description: Status information for each database checked by the provider files: type: array items: $ref: "#/components/schemas/File" description: Files produced by the background check, including PDF reports when available createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" BackgroundCheckRecord: type: object required: - id - category - database - sections - title properties: "@id": type: string format: iri-reference description: Background Check Record IRI reference example: /background-checks/91ab5678-1234-5678-9abc-def012345678/records/82cd9012-3456-7890-abcd-ef1234567890 "@type": type: string default: BackgroundCheckRecord id: type: string format: uuid description: Unique background check record ID example: 82cd9012-3456-7890-abcd-ef1234567890 category: allOf: - $ref: "#/components/schemas/BackgroundCheckCategory" description: Category that groups this record database: allOf: - $ref: "#/components/schemas/BackgroundCheckDatabase" description: Database where this record was found sections: type: array items: $ref: "#/components/schemas/BackgroundCheckRecordSection" description: Sections of detailed fields returned for this record title: type: string description: Display title for the record example: Criminal records CompanyVerificationReport: type: object required: - id - link - rpcEntity - extraction - files - createdAt - updatedAt properties: "@id": type: string format: iri-reference description: Company Verification Report IRI reference example: /datasources/mx/company-verification/reports/91ab5678-1234-5678-9abc-def012345678 "@type": type: string default: CompanyVerificationReport id: type: string format: uuid description: Unique company verification report ID example: 91ab5678-1234-5678-9abc-def012345678 link: type: string format: iri-reference description: Entity associated with the company verification report example: /entities/91ab5678-1234-5678-9abc-def012345678 rpcEntity: allOf: - $ref: "#/components/schemas/RpcEntidadeProfile" description: RPC company profile used for the verification report extraction: type: string format: iri-reference description: Extraction that produced the report example: /extractions/91106968-1abd-4d64-85c1-4e73d96fb997 files: type: array items: $ref: "#/components/schemas/File" description: Files generated for the company verification report, including PDF and HTML reports when available createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" CorporateStructureCurrentPowersEntity: type: object description: | A person or company appearing in the latest Company Verification report for the entity with at least one currently effective power of attorney. The response is limited to the holder's identity and their current powers — no cap-table holdings, share totals, or ownership percentages. required: - name - entityType - powers properties: name: type: string description: Full name of the holder, as resolved by the upstream pipeline. example: Juan Pérez García entityType: type: string description: Whether the holder is a natural person or a legal entity. enum: - person - company example: person powers: type: array description: Currently effective powers of attorney granted to this holder, ordered by grant date ascending. items: $ref: "#/components/schemas/CorporateStructureCurrentPowersPower" CorporateStructureCurrentPowersPower: type: object description: A single currently effective power of attorney granted to a holder. required: - status - grantedAt - documentSource - documentNumber - externalReference - exerciseJointlyRequired - exerciseSubstitutionAllowed - realEstateCanAcquire - realEstateCanDispose properties: status: type: string description: Always `current` for this insight — expired powers are filtered out of the response. enum: - current example: current power: type: [string, "null"] description: | Canonical power type (for example, `administrative_acts` or `lawsuits_and_collections`). `null` when the upstream pipeline classified the power as `external` (a reference to another document). example: administrative_acts grantedAt: type: string format: date description: Date the power was granted, as recorded in the source document. example: "2020-01-15" expirationDate: type: [string, "null"] format: date description: Date the power expires, when known. example: "2025-01-15" expirationSource: type: [string, "null"] description: Source used to derive the expiration date (for example, `document` or `inference`). example: document documentSource: type: string description: Where the granting document was sourced from. example: rpc documentNumber: type: string description: Identifier of the granting document (NCI, protocol number, etc.). example: "12345" grantingState: type: [string, "null"] description: Mexican state where the granting document was issued, when known. example: CDMX externalReference: type: boolean description: True when the power refers to a separate external document instead of being defined inline. example: false referenceText: type: [string, "null"] description: Verbatim text of the external reference, when present. referenceDocumentNumber: type: [string, "null"] description: Document number of the external reference, when present. exerciseJointlyWith: type: [string, "null"] description: Name of the co-grantee with whom the power must be exercised jointly, when applicable. exerciseJointlyRequired: type: boolean description: Whether the power can only be exercised jointly with the co-grantee. example: false exerciseSubstitutionAllowed: type: boolean description: Whether the power may be substituted or delegated to another party. example: false exerciseLimitations: type: [string, "null"] description: Free-text limitations recorded in the source document. realEstateCanAcquire: type: boolean description: Whether the grantee may acquire real estate on behalf of the principal. example: false realEstateCanDispose: type: boolean description: Whether the grantee may dispose of or sell real estate on behalf of the principal. example: false BackgroundCheckScore: type: object required: - id - category - score - status - recordsCount properties: id: type: string format: uuid description: Unique category score ID example: 73de0123-4567-8901-bcde-f23456789012 category: allOf: - $ref: "#/components/schemas/BackgroundCheckCategory" description: Category this score applies to score: type: number format: float description: Score returned for this background check category example: 92.3 status: type: string description: Provider status for this category check example: "clean" recordsCount: type: integer description: Number of records found for this category example: 3 BackgroundCheckDatabaseStatus: type: object required: - id - database - category - status properties: id: type: string format: uuid description: Unique database status ID example: 64ef1234-5678-9012-cdef-345678901234 database: allOf: - $ref: "#/components/schemas/BackgroundCheckDatabase" description: Database checked by the provider category: allOf: - $ref: "#/components/schemas/BackgroundCheckCategory" description: Category checked in this database status: type: string description: Provider status for this database check example: "completed" BackgroundCheckDatabase: type: object required: - id - name - country properties: id: type: string format: uuid description: Unique background check database ID example: 55f01234-5678-9012-cdef-345678901234 name: type: string description: Display name of the database example: "Mexico Criminal Records Database" country: allOf: - $ref: "#/components/schemas/BackgroundCheckCountry" description: Country covered by this database BackgroundCheckRecordSection: type: object required: - id - title - fields properties: id: type: string format: uuid description: Unique record section ID example: 46ef1234-5678-9012-cdef-345678901234 title: type: string description: Display title for the record section example: "Personal Information" fields: type: array items: $ref: "#/components/schemas/BackgroundCheckRecordSectionField" description: Fields included in this record section BackgroundCheckRecordSectionField: type: object required: - id - name - value properties: id: type: string format: uuid description: Unique field ID example: 37ef1234-5678-9012-cdef-345678901234 name: type: string description: Display name for the field example: "Full Name" value: type: string description: Value returned for the field example: "Juan Manuel Perez Gonzalez" BackgroundCheckCategory: type: string enum: - affiliations_and_insurances - alert_in_media - behavior - business_background - criminal_record - driving_licenses - international_background - legal_background - personal_identity - professional_background - traffic_fines - vehicle_information - vehicle_permits - taxes_and_finances - politically_exposed_person - credit_history - document_validation - unknown description: | Category of background check: - **personal_identity**: Identity verification and personal information - **criminal_record**: Criminal background and legal history - **legal_background**: Legal proceedings and court records - **business_background**: Business registration and commercial activity - **professional_background**: Professional licenses and certifications - **credit_history**: Credit and financial history - **taxes_and_finances**: Tax compliance and financial records - **affiliations_and_insurances**: Professional affiliations and insurance records - **driving_licenses**: Driving licenses and vehicle permits - **vehicle_information**: Vehicle ownership and registration - **vehicle_permits**: Vehicle permits and registrations - **traffic_fines**: Traffic violations and fines - **alert_in_media**: Media mentions and public records - **behavior**: Behavioral patterns and risk indicators - **international_background**: International records and verification - **politically_exposed_person**: PEP (Politically Exposed Person) screening - **document_validation**: Document authenticity verification - **unknown**: Unknown or unclassified category example: criminal_record BackgroundCheckStatus: type: string enum: - pending - completed - error description: | Status of the background check: - **pending**: Background check is being processed - **completed**: Background check has been completed successfully - **error**: Background check encountered an error during processing example: completed BackgroundCheckCountry: type: string enum: - MX - ALL description: | Country scope for background check: - **MX**: Mexico-specific background checks - **ALL**: International background checks across multiple countries example: MX Export: type: object properties: "@id": type: string format: iri-reference description: Export IRI reference example: /exports/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string description: JSON-LD resource type default: Export id: type: string format: uuid description: Unique export ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 file: description: Generated file once the export is finished allOf: - $ref: "#/components/schemas/File" - example: type: Export resource: /exports/91106968-1abd-4d64-85c1-4e73d96fb997 mimeType: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet extension: xlsx filename: 9137b53f-1abd-4d64-85c1-4e73d96fb997.xlsx format: type: string description: Output format for the generated export file example: xlsx fileTypes: type: array description: File types to include in the export minItems: 1 example: - invoice.cfdi.xml items: type: string enum: - invoice.cfdi.xml - invoice.cfdi.pdf - tax_return.transcript - tax_return.ack_receipt - tax_return.payment_receipt example: invoice.cfdi.xml status: type: string description: Current export processing status enum: - pending - running - finished - failed - stopping - stopped example: pending uri: type: string description: API collection URI used as the export source example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/invoices?usage=I01&type=I&issuedAt[after]=2020-01-01 createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" ExportCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/Export "@id": default: /exports "hydra:member": items: $ref: "#/components/schemas/Export" InsightReportInsightEntryInput: type: object required: - name - type properties: name: type: string description: Entry identifier within the report layout example: sales-revenue type: type: string description: "`insight` renders a single insight; `group` renders a titled section of child insight entries" enum: - insight - group insight: type: string description: Name of the insight rendered by this entry; required when `type` is `insight` example: sales-revenue visible: type: boolean description: Whether the entry is shown when the report is rendered children: type: array description: Child insight entries; used when `type` is `group` items: $ref: "#/components/schemas/InsightReportInsightEntryInput" InsightReportInsightEntry: type: object required: - name - type properties: name: type: string description: Entry identifier within the report layout example: sales-revenue type: type: string description: "`insight` renders a single insight; `group` renders a titled section of child insight entries" enum: - insight - group insight: type: string description: Name of the insight rendered by this entry; present when `type` is `insight` example: sales-revenue visible: type: boolean description: Whether the entry is currently shown when the report is rendered children: type: array description: Child insight entries; present when `type` is `group` items: $ref: "#/components/schemas/InsightReportInsightEntry" builtIn: type: boolean description: Whether the entry comes from a built-in report definition; omitted for entries defined in custom reports InsightReport: type: object properties: "@id": type: string format: iri-reference description: Report IRI reference example: /reports/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string description: JSON-LD resource type default: InsightReport id: type: string format: uuid description: Unique report ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 name: type: string description: Report name shown in the dashboard's report selector; built-in reports use stable names such as `full_report` example: Credit review builtIn: type: boolean description: Whether the report is managed by Syntage; built-in reports are kept up to date automatically and cannot be modified or deleted example: false organizational: type: boolean description: Whether the report is shared with every user in the organization; personal reports are only visible to their owner example: false insights: type: array description: Ordered layout of insight entries and groups rendered by the report items: $ref: "#/components/schemas/InsightReportInsightEntry" createdBy: type: object description: Profile of the user who created the report; omitted for built-in reports properties: id: type: string format: uuid description: User ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 firstName: type: string example: John lastName: type: string example: Doe fullName: type: string example: John Doe createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" InsightReportCollection: allOf: - $ref: "#/components/schemas/Collection" - type: object properties: "@context": default: /contexts/InsightReport "@id": default: /reports "hydra:member": items: $ref: "#/components/schemas/InsightReport" TaxpayerID: type: string minLength: 12 maxLength: 13 description: RFC (Registro Federal de Contribuyentes) example: PEIC211118IS0 CollectionOrder: type: string enum: - asc - desc example: asc CollectionPage: type: integer default: 1 CollectionLimit: type: integer default: 20 minimum: 1 maximum: 1000 HydraView: type: object properties: "@context": type: string "@id": type: string "@type": type: string default: hydra:Collection "hydra:member": type: array items: type: object hydra:totalItems: type: integer description: Total number of items found minimum: 0 example: 1 "hydra:view": type: object description: Pagination information properties: "@id": type: string format: iri-reference description: Current page IRI reference "@type": type: string default: hydra:PartialCollectionView hydra:first: type: string format: iri-reference description: First page IRI reference; omitted when there is no pagination hydra:next: type: string format: iri-reference description: Next page IRI reference; omitted when there is no pagination hydra:last: type: string format: iri-reference description: Last page IRI reference; omitted when there is no pagination Collection: allOf: - $ref: "#/components/schemas/HydraView" - type: object properties: "hydra:search": type: object properties: "@type": type: string hydra:template: type: string hydra:variableRepresentation: type: string hydra:mapping: type: array items: type: object properties: "@type": type: string variable: type: string property: type: string required: type: boolean CursorCollection: type: object properties: "@context": type: string "@id": type: string "@type": type: string default: hydra:Collection "hydra:member": type: array items: type: object "hydra:view": type: object description: Pagination information properties: "@id": type: string format: iri-reference description: Current page IRI reference "@type": type: string default: hydra:PartialCollectionView hydra:next: type: string example: /entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367 description: Next page IRI reference; omitted when there is no pagination hydra:last: type: string example: /entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367 description: Last page IRI reference; omitted when there is no pagination "hydra:search": type: object properties: "@type": type: string hydra:template: type: string hydra:variableRepresentation: type: string hydra:mapping: type: array items: type: object properties: "@type": type: string variable: type: string property: type: string required: type: boolean uuid: type: string format: uuid example: e0a24894-7fbf-48ae-bfb0-efaae30a6319 Value: type: string example: BlacklistStatusSource: type: string description: The blacklist status while a taxpayer appears in a current SAT 69-B publication source enum: - presumed - dismissed - definitive - favorable example: presumed CredentialType: type: string enum: - ciec - efirma example: ciec CredentialStatus: type: string enum: - waiting - pending - valid - invalid - disabled - deactivated - error x-enumDeprecated: deactivated: Legacy status retained for existing records. The `disabled` status is used for credentials that can no longer be used. description: | Credential validation status: | Value | Description | | --- | --- | | `waiting` | Credential validation is temporarily disabled, usually because of an ongoing incident. The credential will be validated later. | | `pending` | Credential validation has been requested and is waiting to be processed. | | `valid` | The credential was accepted by SAT and can be used for extractions. | | `invalid` | SAT rejected the credential during validation. | | `disabled` | SAT reported the credential as disabled or otherwise unrecoverable during validation. | | `deactivated` | **Deprecated.** Legacy status retained for existing records. The `disabled` status is used for credentials that can no longer be used. | | `error` | Credential validation failed because of an unexpected error. | example: pending Credential: type: object properties: "@id": type: string format: iri-reference description: SAT Credential IRI reference example: /credentials/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: Credential id: type: string format: uuid description: Credential ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 type: $ref: "#/components/schemas/CredentialType" rfc: $ref: "#/components/schemas/TaxpayerID" status: $ref: "#/components/schemas/CredentialStatus" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" CredentialCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/Credential "@id": default: /credentials "hydra:member": items: $ref: "#/components/schemas/Credential" CredentialCiecInput: type: object description: CIEC required: - type - rfc - password properties: type: type: string description: Credential type rfc: type: string minLength: 12 maxLength: 13 description: RFC (Registro Federal de Contribuyentes) example: PEIC211118IS0 password: type: string minLength: 8 writeOnly: true description: CIEC's password example: secret123 CredentialEfirmaInput: type: object description: e.firma required: - type - certificate - privateKey - password properties: type: type: string description: Credential type certificate: type: string format: base64 writeOnly: true description: Certificate file (.cer) content encoded in Base64 example: MIIF7zCC...Pl1ai2M= privateKey: type: string format: base64 writeOnly: true description: Private key file (.key) content encoded in Base64 example: MIIFDjBA...e3Kov54= password: type: string writeOnly: true description: Private key password example: secret123 EventType: type: string enum: - credential.created - credential.updated - credential.deleted - link.created - link.updated - link.deleted - file.created - extraction.created - extraction.updated - invoice.created - invoice.updated - invoice.deleted - invoice_payment.created - invoice_payment.updated - invoice_line_item.created - invoice_line_item.updated - tax_return.created - tax_return.updated - tax_return.deleted - export.created - export.updated - tax_status.created - tax_status.updated - tax_status.deleted - tax_compliance_check.created - tax_compliance_check.updated - tax_compliance_check.deleted - tax_retention.created - tax_retention.updated - tax_retention.deleted - electronic_accounting_record.created - electronic_accounting_record.updated - electronic_accounting_record.deleted - rpc_entidades.created - rpc_entidades.updated - rpc_acto.created - rpc_acto.updated - rpc_socios.created - rpc_socios.updated - shareholder_relation.created - shareholder_relation.updated - shareholder_relation_source.created - rug_garantia.created - rug_garantia.updated - buro_de_credito_report.created - buro_de_credito_report.updated - sat_certificate.created - sat_certificate.updated - background_check.created - company_verification_report.created - company_verification_report.updated example: credential.updated EventSource: type: string format: iri-reference description: Source that originated the event example: /extractions/91106968-1abd-4d64-85c1-4e73d96fb997 EventResource: type: string format: iri-reference description: Resource related to the event example: /credentials/91106968-1abd-4d64-85c1-4e73d96fb997 TaxpayerPersonType: type: string enum: - physical - legal example: physical TaxpayerName: type: string minLength: 1 maxLength: 254 description: Taxpayer name example: Pedro Infante Cruz Taxpayer: type: object properties: "@id": type: string format: iri-reference description: Taxpayer IRI reference example: /taxpayers/PEIC211118IS0 "@type": type: string default: Taxpayer id: $ref: "#/components/schemas/TaxpayerID" personType: $ref: "#/components/schemas/TaxpayerPersonType" registrationDate: type: string format: date description: Taxpayer registration date name: $ref: "#/components/schemas/TaxpayerName" ElectronicAccountingRecord: type: object properties: "@id": type: string format: iri-reference description: Electronic Accounting Record IRI reference example: /electronic-accounting-records/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: ElectronicAccountingRecord id: $ref: "#/components/schemas/ElectronicAccountingRecordID" year: $ref: "#/components/schemas/ElectronicAccountingRecordYear" month: $ref: "#/components/schemas/ElectronicAccountingRecordMonth" type: $ref: "#/components/schemas/ElectronicAccountingRecordType" reason: $ref: "#/components/schemas/ElectronicAccountingRecordReason" fileType: $ref: "#/components/schemas/ElectronicAccountingRecordXmlFileType" filename: $ref: "#/components/schemas/ElectronicAccountingRecordFilename" code: $ref: "#/components/schemas/ElectronicAccountingRecordCode" receivedAt: $ref: "#/components/schemas/ElectronicAccountingRecordReceivedAt" status: $ref: "#/components/schemas/ElectronicAccountingRecordStatus" files: $ref: "#/components/schemas/ElectronicAccountingRecordFiles" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" ElectronicAccountingRecordID: type: string format: uuid description: Electronic Accounting Record ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 ElectronicAccountingRecordYear: type: integer description: Fiscal year example: 2022 ElectronicAccountingRecordMonth: type: integer example: 3 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 ElectronicAccountingRecordReason: type: string example: EM enum: - AF - DE - CO - FC - EM ElectronicAccountingRecordStatus: type: string example: accepted enum: - received - accepted - rejected ElectronicAccountingRecordType: type: [string, "null"] example: "N" enum: - "N" - C - null ElectronicAccountingRecordXmlFileType: type: string example: B enum: - CT - B - PL - XF - XC ElectronicAccountingRecordFilename: type: string example: PEIC211118IS0202203BN.zip ElectronicAccountingRecordCode: type: string example: "0002220300000000124236" ElectronicAccountingRecordReceivedAt: type: string format: date-time ElectronicAccountingRecordFiles: type: array description: "Electronic accounting record files: (ack receipt, ack processing, XML and digital stamp)" items: $ref: "#/components/schemas/File" Event: type: object properties: "@id": type: string format: iri-reference description: Event IRI reference example: /events/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string description: JSON-LD resource type default: Event id: $ref: "#/components/schemas/uuid" taxpayer: $ref: "#/components/schemas/Taxpayer" type: $ref: "#/components/schemas/EventType" source: $ref: "#/components/schemas/EventSource" resource: $ref: "#/components/schemas/EventResource" data: type: object description: Resource data (data.object) and changes (data.changes) example: object: id: 91106968-1abd-4d64-85c1-4e73d96fb997 rfc: PEIC211118IS0 type: ciec status: valid createdAt: "2020-01-17 11:47:27" changes: status: old: pending new: valid createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" EventCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/Event "@id": default: /events "hydra:member": items: $ref: "#/components/schemas/Event" ExtractionExtractor: type: string description: Extractor to run, which retrieves resources from the corresponding datasource enum: - 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 ExtractionStatus: type: string enum: - pending - waiting - running - finished - failed - stopping - stopped - cancelled ExtractionOptions: type: object description: Options are specific to the selected extractor. Select the schema matching the extractor; extractors not listed here do not accept options. anyOf: - $ref: "#/components/schemas/InvoiceExtractionOptions" - $ref: "#/components/schemas/TaxRetentionExtractionOptions" - $ref: "#/components/schemas/AnnualTaxReturnExtractionOptions" - $ref: "#/components/schemas/MonthlyTaxReturnExtractionOptions" - $ref: "#/components/schemas/RifTaxReturnExtractionOptions" - $ref: "#/components/schemas/ElectronicAccountingExtractionOptions" - $ref: "#/components/schemas/RpcExtractionOptions" - $ref: "#/components/schemas/BuroDeCreditoReportExtractionOptions" ExtractionPeriodOptions: title: Extraction period type: object additionalProperties: false properties: from: type: string description: Start of the extraction period. Accepts a date or relative date expression. Defaults to the start of the year three years ago. example: "2024-01-01" to: type: string description: End of the extraction period. Must be later than `from` and cannot be a future date. Defaults to the current date and time. example: "2024-12-31" InvoiceExtractionOptions: title: Invoice extraction options type: object additionalProperties: false properties: period: $ref: "#/components/schemas/ExtractionPeriodOptions" types: type: array description: CFDI types to extract. Defaults to every supported type. minItems: 1 uniqueItems: true items: type: string enum: - I - E - P - N - T example: - I - E - P issued: type: boolean description: Whether to extract CFDIs issued by the entity. default: true received: type: boolean description: Whether to extract CFDIs received by the entity. default: true complement: type: integer description: Complement filter passed to SAT. default: -1 pdf: type: boolean description: Whether to download PDF files. default: true xml: type: boolean description: Whether to download XML files. default: true TaxRetentionExtractionOptions: title: Tax retention extraction options type: object additionalProperties: false properties: period: $ref: "#/components/schemas/ExtractionPeriodOptions" issued: type: boolean description: Whether to extract tax retentions issued by the entity. default: true received: type: boolean description: Whether to extract tax retentions received by the entity. default: true complement: type: integer description: Complement filter passed to SAT. default: -1 AnnualTaxReturnExtractionOptions: title: Annual tax return extraction options type: object additionalProperties: false properties: period: $ref: "#/components/schemas/ExtractionPeriodOptions" files: type: object additionalProperties: false description: Tax return file types to download. properties: tax_return.ack_receipt: type: boolean description: Whether to download the filing acknowledgment receipt. default: true tax_return.transcript: type: boolean description: Whether to download the tax return transcript. default: true tax_return.payment_receipt: type: boolean description: Whether to download the payment receipt. default: true tax_return.financial_statements: type: boolean description: Whether to download financial statements. default: true tax_return.audited_financial_statements: type: boolean description: Whether to download audited financial statements. default: true MonthlyTaxReturnExtractionOptions: title: Monthly tax return extraction options type: object additionalProperties: false properties: period: $ref: "#/components/schemas/ExtractionPeriodOptions" files: type: object additionalProperties: false description: Tax return file types to download. properties: tax_return.ack_receipt: type: boolean description: Whether to download the filing acknowledgment receipt. default: true tax_return.transcript: type: boolean description: Whether to download the tax return transcript. default: true tax_return.payment_receipt: type: boolean description: Whether to download the payment receipt. default: true tax_return.financial_statements: type: boolean description: Whether to download financial statements. default: true RifTaxReturnExtractionOptions: title: RIF tax return extraction options type: object additionalProperties: false properties: period: $ref: "#/components/schemas/ExtractionPeriodOptions" ElectronicAccountingExtractionOptions: title: Electronic accounting extraction options type: object additionalProperties: false properties: period: $ref: "#/components/schemas/ExtractionPeriodOptions" RpcExtractionOptions: title: RPC extraction options type: object additionalProperties: false properties: nameThreshold: type: number format: float minimum: 0.75 maximum: 1 description: Minimum name similarity for matching RPC entities. Higher values require a closer match. When omitted, the RPC datasource uses its default threshold of 0.75. example: 0.9 nameLimit: type: integer minimum: 1 maximum: 100 description: Maximum number of matching RPC entities to return, ordered from most to least similar. When omitted, the RPC datasource uses its default page size. example: 25 BuroDeCreditoReportExtractionOptions: title: Buró de Crédito report extraction options type: object additionalProperties: false properties: productType: type: string description: Buró de Crédito product to request. Supported values depend on whether the entity is a person or company. When omitted, the organization's configured default applies. enum: - "007" - "004" - INFORME_BURO - RCO example: INFORME_BURO legalScoreCode: type: string description: Score code used for a company report. The only supported value is `012`. enum: - "012" default: "012" legalAmbiguity: type: string minLength: 1 description: Ambiguity indicator saved with the extraction and used for a company report. When omitted, the organization's configured legal ambiguity applies, falling back to `R` when unset. ExtractionRequest: oneOf: - $ref: "#/components/schemas/InvoiceExtractionRequest" - $ref: "#/components/schemas/TaxRetentionExtractionRequest" - $ref: "#/components/schemas/AnnualTaxReturnExtractionRequest" - $ref: "#/components/schemas/MonthlyTaxReturnExtractionRequest" - $ref: "#/components/schemas/RifTaxReturnExtractionRequest" - $ref: "#/components/schemas/ElectronicAccountingExtractionRequest" - $ref: "#/components/schemas/RpcExtractionRequest" - $ref: "#/components/schemas/BuroDeCreditoReportExtractionRequest" - $ref: "#/components/schemas/TaxStatusExtractionRequest" - $ref: "#/components/schemas/TaxComplianceExtractionRequest" - $ref: "#/components/schemas/SatCertificatesExtractionRequest" - $ref: "#/components/schemas/BilExtractionRequest" - $ref: "#/components/schemas/RugExtractionRequest" - $ref: "#/components/schemas/BackgroundCheckExtractionRequest" - $ref: "#/components/schemas/InfonavitExtractionRequest" discriminator: propertyName: extractor mapping: invoice: "#/components/schemas/InvoiceExtractionRequest" tax_retention: "#/components/schemas/TaxRetentionExtractionRequest" annual_tax_return: "#/components/schemas/AnnualTaxReturnExtractionRequest" monthly_tax_return: "#/components/schemas/MonthlyTaxReturnExtractionRequest" rif_tax_return: "#/components/schemas/RifTaxReturnExtractionRequest" electronic_accounting: "#/components/schemas/ElectronicAccountingExtractionRequest" rpc: "#/components/schemas/RpcExtractionRequest" buro_de_credito_report: "#/components/schemas/BuroDeCreditoReportExtractionRequest" tax_status: "#/components/schemas/TaxStatusExtractionRequest" tax_compliance: "#/components/schemas/TaxComplianceExtractionRequest" sat_certificates: "#/components/schemas/SatCertificatesExtractionRequest" bil: "#/components/schemas/BilExtractionRequest" rug: "#/components/schemas/RugExtractionRequest" background_check: "#/components/schemas/BackgroundCheckExtractionRequest" infonavit: "#/components/schemas/InfonavitExtractionRequest" InvoiceExtractionRequest: title: Invoice extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - invoice options: $ref: "#/components/schemas/InvoiceExtractionOptions" TaxRetentionExtractionRequest: title: Tax retention extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - tax_retention options: $ref: "#/components/schemas/TaxRetentionExtractionOptions" AnnualTaxReturnExtractionRequest: title: Annual tax return extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - annual_tax_return options: $ref: "#/components/schemas/AnnualTaxReturnExtractionOptions" MonthlyTaxReturnExtractionRequest: title: Monthly tax return extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - monthly_tax_return options: $ref: "#/components/schemas/MonthlyTaxReturnExtractionOptions" RifTaxReturnExtractionRequest: title: RIF tax return extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - rif_tax_return options: $ref: "#/components/schemas/RifTaxReturnExtractionOptions" ElectronicAccountingExtractionRequest: title: Electronic accounting extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - electronic_accounting options: $ref: "#/components/schemas/ElectronicAccountingExtractionOptions" RpcExtractionRequest: title: RPC extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - rpc options: $ref: "#/components/schemas/RpcExtractionOptions" BuroDeCreditoReportExtractionRequest: title: Buró de Crédito report extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - buro_de_credito_report options: $ref: "#/components/schemas/BuroDeCreditoReportExtractionOptions" TaxStatusExtractionRequest: title: Tax status extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - tax_status TaxComplianceExtractionRequest: title: Tax compliance extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - tax_compliance SatCertificatesExtractionRequest: title: SAT certificates extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - sat_certificates BilExtractionRequest: title: BIL extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - bil RugExtractionRequest: title: RUG extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - rug BackgroundCheckExtractionRequest: title: Background Check extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - background_check InfonavitExtractionRequest: title: Infonavit extraction allOf: - $ref: "#/components/schemas/ExtractionEntityTarget" - type: object required: - extractor properties: extractor: type: string enum: - infonavit ExtractionEntityTarget: title: Entity target type: object required: - entity properties: entity: type: string format: iri-reference description: Entity IRI reference example: /entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d ExtractionRateLimitedAt: type: string format: date-time description: | 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" ExtractionErrorCode: type: [string, "null"] description: | [Extraction error code](#section/Extraction-error-codes) example: null enum: - unrecoverable - sat_unavailable - internal_error - undefined - invalid_credentials - login_failed - datasource_disabled - null ExtractionCreatedDataPoints: type: integer description: | 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 ExtractionUpdatedDataPoints: type: integer description: | 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 Extraction: type: object properties: "@id": type: string format: iri-reference description: Extraction IRI reference example: /extractions/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string description: JSON-LD resource type default: Extraction id: type: string format: uuid description: Unique extraction ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 taxpayer: $ref: "#/components/schemas/Taxpayer" extractor: $ref: "#/components/schemas/ExtractionExtractor" options: $ref: "#/components/schemas/ExtractionOptions" status: $ref: "#/components/schemas/ExtractionStatus" startedAt: type: [string, "null"] format: date-time description: Time when the _status_ changed from **pending** to **running** finishedAt: type: [string, "null"] format: date-time description: Time when the _status_ changed from **running** to **finished** or **failed** rateLimitedAt: $ref: "#/components/schemas/ExtractionRateLimitedAt" errorCode: $ref: "#/components/schemas/ExtractionErrorCode" createdDataPoints: $ref: "#/components/schemas/ExtractionCreatedDataPoints" updatedDataPoints: $ref: "#/components/schemas/ExtractionUpdatedDataPoints" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" ExtractionCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/Extraction "@id": default: /extractions "hydra:member": items: $ref: "#/components/schemas/Extraction" InvoiceID: type: string format: uuid description: Invoice ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 InvoiceUUID: type: string format: uuid description: Invoice UUID (Folio fiscal) example: def404af-5eef-4112-aa99-d1ec8493b89a InvoiceVersion: type: [number, "null"] format: float enum: - 3.2 - 3.3 - 4.0 - null description: CFDI version example: 3.3 InvoiceReference: type: [string, "null"] description: An open field for internal identification. Commonly used to identify a branch maxLength: 25 example: Branch-A InvoiceInternalIdentifier: type: [string, "null"] description: An open field for internal identification. Commonly used to identify an invoice maxLength: 40 example: "00001" InvoiceType: type: string enum: - I - E - P - "N" - T description: Invoice type code from the [c_TipoDeComprobante](/guides/catalogs#c_tipodecomprobante) catalog externalDocs: url: https://syntage.com/docs/catalogs/#c_tipodecomprobante InvoiceUsage: type: [string, "null"] enum: - G01 - G02 - G03 - I01 - I02 - I03 - I04 - I05 - I06 - I07 - I08 - D01 - D02 - D03 - D04 - D05 - D06 - D07 - D08 - D09 - D10 - S01 - P01 - CP01 - CN01 - null example: G03 description: Invoice usage code from the [c_UsoCFDI](/guides/catalogs#c_usocfdi) catalog externalDocs: url: https://syntage.com/docs/catalogs/#c_usocfdi InvoicePaymentType: type: [string, "null"] enum: - PUE - PPD - null description: Payment type code from the [c_MetodoPago](/guides/catalogs#c_metodopago) catalog example: PUE externalDocs: url: https://syntage.com/docs/catalogs#c_metodopago InvoicePaymentMethod: type: [string, "null"] enum: - "01" - "02" - "03" - "04" - "05" - "06" - "08" - "12" - "13" - "14" - "15" - "17" - "23" - "24" - "25" - "26" - "27" - "28" - "29" - "30" - "31" - "99" - null example: "04" description: Payment method code from the [c_FormaPago](/guides/catalogs#c_formapago) catalog externalDocs: url: https://syntage.com/docs/catalogs#c_formapago InvoicePaymentTerms: type: [string, "null"] enum: - immediate_payment - net_0 - net_15 - net_30 - net_45 - net_90 - net_120 - null example: immediate_payment description: Payment terms InvoicePlaceOfIssue: type: string example: "01210" description: Postal code of the place of issue InvoiceIssuerTaxRegime: type: [number, "null"] enum: - 601 - 603 - 605 - 606 - 607 - 608 - 609 - 610 - 611 - 612 - 614 - 615 - 616 - 620 - 621 - 622 - 623 - 624 - 625 - 626 - 628 - 629 - 630 - null description: Tax regime code from the [c_RegimenFiscal](/guides/catalogs#c_regimenfiscal) catalog example: 601 externalDocs: url: https://syntage.com/docs/catalogs#c_regimenfiscal RpcEntidade: type: object description: Company record extracted from the Registro Publico de Comercio properties: "@id": type: string format: iri-reference description: RPC entidade IRI reference example: /datasources/mx/rpc/entidades/99c13810-868f-482e-a6f1-878254248d27 "@type": type: string default: RpcEntidade id: $ref: "#/components/schemas/RpcEntidadeID" fme: $ref: "#/components/schemas/RpcEntidadeFme" nombreRazonSocial: $ref: "#/components/schemas/RpcEntidadeNombreRazonSocial" objetoSocial: $ref: "#/components/schemas/RpcEntidadeObjetoSocial" duracionDeLaSociedad: $ref: "#/components/schemas/RpcEntidadeDuracionDeLaSociedad" domicilioSocial: $ref: "#/components/schemas/RpcEntidadeDomicilioSocial" nacionalidad: $ref: "#/components/schemas/RpcEntidadeNacionalidad" estatusFme: $ref: "#/components/schemas/RpcEntidadeEstatusFme" rfc: $ref: "#/components/schemas/RpcEntidadeRfc" tipoDePersona: $ref: "#/components/schemas/RpcEntidadeTipoDePersona" antecedenteRegistral: $ref: "#/components/schemas/RpcEntidadeAntecedenteRegistral" regimenJuridico: $ref: "#/components/schemas/RpcEntidadeRegimenJuridico" giro: $ref: "#/components/schemas/RpcEntidadeGiro" entidadFederativa: $ref: "#/components/schemas/RpcEntidadeEntidadFederativa" municipio: $ref: "#/components/schemas/RpcEntidadeMunicipio" oficinaRegistral: $ref: "#/components/schemas/RpcEntidadeOficinaRegistral" fechaDeInscripcion: $ref: "#/components/schemas/RpcEntidadeFechaDeInscripcion" curp: $ref: "#/components/schemas/RpcEntidadeCurp" lookupBy: $ref: "#/components/schemas/RpcEntidadeLookupBy" actos: type: array description: Registry acts found for this RPC entidade items: $ref: "#/components/schemas/RpcEntidadeActo" socios: type: array description: Shareholder or partner records found for this RPC entidade items: $ref: "#/components/schemas/RpcEntidadeSocio" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" RpcEntidadeProfile: type: object description: Basic RPC entidade profile information properties: "@id": type: string format: iri-reference description: RPC entidade IRI reference example: /datasources/mx/rpc/entidades/99c13810-868f-482e-a6f1-878254248d27 "@type": type: string default: RpcEntidade id: $ref: "#/components/schemas/RpcEntidadeID" fme: $ref: "#/components/schemas/RpcEntidadeFme" nombreRazonSocial: $ref: "#/components/schemas/RpcEntidadeNombreRazonSocial" RpcEntidadeID: type: string format: uuid description: RPC Entidade ID example: 99c13810-868f-482e-a6f1-878254248d27 RpcEntidadeFme: type: [string, "null"] description: Electronic commercial folio assigned by RPC example: N-2000000000 RpcEntidadeNombreRazonSocial: type: [string, "null"] description: Legal name reported by RPC example: FOO BAR, S.A. DE C.V. RpcEntidadeObjetoSocial: type: [string, "null"] description: Corporate purpose reported by RPC example: a) La operación, administración, comercialización... RpcEntidadeDuracionDeLaSociedad: type: [string, "null"] description: Company duration reported by RPC example: INDEFINIDA RpcEntidadeDomicilioSocial: type: [string, "null"] description: Registered social domicile example: Zona Metropolitana ... RpcEntidadeNacionalidad: type: [string, "null"] description: Company nationality reported by RPC example: Mexicana RpcEntidadeEstatusFme: type: [string, "null"] description: RPC folio status example: Abierto RpcEntidadeRfc: type: [string, "null"] description: RFC reported by RPC example: PEIC211118IS0 RpcEntidadeTipoDePersona: type: string description: Type of person reported by RPC example: Moral RpcEntidadeAntecedenteRegistral: type: [string, "null"] description: Prior registry reference reported by RPC RpcEntidadeRegimenJuridico: type: [string, "null"] description: Legal regime reported by RPC example: Sociedad Anónima RpcEntidadeGiro: type: [string, "null"] description: Business activity reported by RPC RpcEntidadeEntidadFederativa: type: [string, "null"] description: Mexican state where the registry record is held example: Jalisco RpcEntidadeMunicipio: type: [string, "null"] description: Municipality where the registry record is held example: Guadalajara RpcEntidadeOficinaRegistral: type: [string, "null"] description: Registry office that holds the record example: Guadalajara RpcEntidadeFechaDeInscripcion: type: [string, "null"] format: date-time description: Registration date reported by RPC example: 01/01/2017 12:00:00 T.CENTRO RpcEntidadeCurp: type: [string, "null"] description: CURP reported by RPC when present RpcEntidadeLookupBy: type: string description: Search source that produced the RPC entidade enum: - entity - shareholder example: entity RpcEntidadeActo: type: object description: Registry act nested in an RPC entidade response properties: id: type: string format: uuid description: RPC acto ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 formaPrecodificada: type: [string, "null"] description: RPC pre-coded form for the act example: M0 - ... acto: type: [string, "null"] description: Name or type of registry act nci: type: [string, "null"] description: NCI reported by RPC fechaDeIngreso: type: [string, "null"] format: date-time description: Date and time the act was submitted to RPC example: 01/01/2017 12:00:00 T.CENTRO fechaDeInscripcion: type: [string, "null"] format: date-time description: Date and time the act was registered by RPC example: 01/01/2017 12:00:00 T.CENTRO numeroDeDocumento: type: [string, "null"] description: Document number reported by RPC modalidad: type: [string, "null"] description: Act modality reported by RPC data: type: [object, "null"] description: Parsed act data from RPC additionalProperties: true file: $ref: "#/components/schemas/File" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" RpcEntidadeSocio: type: object description: Shareholder or partner record nested in an RPC entidade response properties: id: type: string format: uuid description: RPC socio ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 estatus: type: [string, "null"] description: Shareholder status reported by RPC example: Activo nacionalidad: type: [string, "null"] description: Shareholder nationality reported by RPC example: Mexicana nombre: type: [string, "null"] description: Shareholder given name or company name example: FOO BAR apellidoPaterno: type: [string, "null"] description: Shareholder paternal surname apellidoMaterno: type: [string, "null"] description: Shareholder maternal surname rfc: type: [string, "null"] description: Shareholder RFC when reported by RPC curp: type: [string, "null"] description: Shareholder CURP when reported by RPC serie: type: [string, "null"] description: Share series reported by RPC example: A fechaDeConstitucion: type: [string, "null"] description: Incorporation date when the shareholder is a company example: 04/05/2016 fechaDeNacimiento: type: [string, "null"] description: Birth date when the shareholder is a person acciones: type: [string, "null"] description: Number of shares reported by RPC example: "999" total: type: [string, "null"] description: Total share amount reported by RPC example: "19000.0" valor: type: [string, "null"] description: Share value reported by RPC example: "19000.0" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" RpcActo: allOf: - $ref: "#/components/schemas/RpcEntidadeActo" - type: object properties: "@id": type: string format: iri-reference description: RPC acto IRI reference example: /rpc/actos/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: RpcActo RpcSocio: allOf: - $ref: "#/components/schemas/RpcEntidadeSocio" - type: object properties: "@id": type: string format: iri-reference description: RPC socio IRI reference example: /datasources/rpc/socios/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: RpcSocio rpcEntidade: $ref: "#/components/schemas/RpcEntidadeProfile" RugOperacionPartial: type: object description: RUG operation summary properties: "@id": type: string format: iri-reference description: RUG operation IRI reference example: /datasources/rug/operaciones/99c13810-868f-482e-a6f1-878254248d27 "@type": type: string default: RugOperacion id: $ref: "#/components/schemas/RugOperacionID" numeroDeAsiento: $ref: "#/components/schemas/RugOperacionNumeroDeAsiento" tipo: $ref: "#/components/schemas/RugOperacionTipo" fecha: $ref: "#/components/schemas/RugOperacionFecha" file: $ref: "#/components/schemas/RugOperacionFile" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" RugOperacionID: type: string format: uuid description: RUG operación identifier example: 99c13810-868f-482e-a6f1-878254248d27 RugOperacionFecha: type: string format: date-time description: Date and time of the RUG operation example: 2021-10-12T00:00:00+00:00 RugOperacionNumeroDeAsiento: type: number description: RUG seat number for the operation example: 12345678 RugOperacionTipo: type: string description: Type of RUG operation enum: - anotacion - aviso_preventivo - cancelacion - cancelacion_de_anotacion - certificacion - inscripcion - modificacion - modificacion_de_anotacion - rectificacion_de_anotacion - rectificacion_por_error - renovacion_o_reduccion_de_vigencia - renovacion_vigencia_de_anotacion - transmision example: inscripcion RugOperacionOtorgante: type: object description: Grantor associated with a RUG operation properties: nombre: type: string description: Grantor name example: El Otorgante de Garantías Mobiliarias, S.A. de C.V. folio_electronico: type: string description: Grantor electronic folio example: 34011*7 RugOperacionFile: type: string format: iri-reference description: File resource for the RUG operation document example: /files/99c13810-868f-482e-a6f1-878254248d27 RugOperacionBoleta: type: object description: Parsed RUG boleta data for the operation properties: datos_del_asiento: type: object properties: numero_de_asiento_cadena_unica_de_datos: type: string example: 12345678 numero_de_garantia_mobiliaria: type: string example: 123456 fecha_y_hora: type: string example: 11/03/2022 - 00:18:32 * ZULU GMT / UTC vigencia: type: string example: 12 meses inscrito_en_el_folio_mercantil_no: type: string example: 34011*7 datos_del_otorgante: type: array items: type: object properties: nombre_denominacion_o_razon_social: type: string example: El Otorgante de Garantías Mobiliarias, S.A. de C.V. folio_electronico: type: string example: 34011*7 el_otorgante_de_la_garantia_mobiliaria_es_deudor: type: string example: Si datos_del_acreedor: type: object properties: nombre_denominacion_o_razon_social: type: string example: Grupo Financiero Acreedor, S.A.P.I. de C.V., SOFOM E.N.R. telefono: type: string example: 12345678 extension: type: string example: N/A correo_electronico: type: string example: persona.a@acreedor.com.mx,persona.b@acreedor.com.mx domicilio_para_efectos_del_rug: type: string example: Av. Paseo de la Reforma 296, Juárez, Cuauhtémoc, 06600 Ciudad de México, CDMX datos_de_los_acreedores_adicionales: type: array items: type: object properties: nombre_denominacion_o_razon_social: type: string example: Grupo Financiero Acreedor Adicional, S.A.P.I. de C.V., SOFOM E.N.R. telefono: type: string example: 12345678 extension: type: string example: 543 correo_electronico: type: string example: persona@acredoor2.com.mx domicilio_para_efectos_del_rug: type: string example: Av. Luis Barragan 505, Santa Fe, Contadero, Cuajimalpa de Morelos, 05348 Ciudad de México, CDMX folio_electronico: type: string example: 12345*6 datos_de_los_deudores: type: array items: type: object properties: nombre_denominacion_o_razon_social: type: string example: El Otorgante de Garantías Mobiliarias, S.A. de C.V. datos_de_la_garantia_mobiliaria: type: object properties: tipo_de_garantia_mobiliaria: type: string example: Factoraje Financiero fecha_de_celebracion_del_acto_o_contrato_o_del_surgimiento_de_los_derechos_de_retencion_o_privilegios_especiales: type: string example: 08/03/2021 monto_maximo_garantizado_y_moneda: type: string example: $ 12345.67 Peso Mexicano tipo_de_bienes_muebles_objeto_de_la_garantia_mobiliaria: type: string example: Derechos, incluyendo derechos de cobro. descripcion_de_los_bienes_muebles_objeto_de_la_garantia_mobiliaria: type: string example: Factura con el folio fiscal 99c13810-868f-482e-a6f1-878254248d27 el_acto_o_contrato_preve_incrementos_reducciones_o_sustituciones_de_los_bienes_muebles_o_del_monto_garantizado: type: string example: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vehicula blandit feugiat. Nullam ligula nunc, vehicula non porta quis, eleifend id leo. Nulla et nisl vulputate, commodo urna sit amet, pharetra leo. Aliquam erat volutpat. datos_del_instrumento_publico_mediante_el_cual_se_formalizo_el_acto_o_contrato: type: string example: Proin laoreet posuere velit eget interdum. Donec interdum risus quam, porta laoreet dui consectetur nec. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. terminos_y_condiciones_del_acto_o_contrato_de_la_garantia_mobiliaria: type: string example: Integer molestie urna vitae dolor consectetur, ut molestie libero pulvinar. datos_del_acto_o_contrato_que_creo_la_obligacion_garantizada: type: object properties: declaro_bajo_protesta_de_decir_verdad_que_se_solicito_al_otorgante_de_la_garantia_manifestacion_respecto_de_la_no_existencia_de_garantias_otorgadas_previamente_referente_a_los_bienes_objeto_de_esta_garantia: type: string example: Si acto_o_contrato_que_creo_la_obligacion_garantizada: type: string example: Vivamus nisi leo, dapibus a tellus eu, dictum convallis neque. Suspendisse ut diam sollicitudin, congue tortor in, mollis felis. Vestibulum id ornare lacus. fecha_de_celebracion_del_acto_o_contrato: type: string example: 08/03/2021 fecha_de_terminacion_del_acto_o_contrato: type: string example: 08/03/2022 terminos_y_condiciones_del_acto_o_contrato_que_creo_la_obligacion_garantizada: type: string example: Donec euismod bibendum porttitor. Suspendisse cursus venenatis fringilla. Nulla ornare elementum gravida. Nam lectus mi, tincidunt sed vehicula nec, interdum ut lacus. Vestibulum nec nibh elit. persona_que_firmo_el_asiento: type: object properties: nombre: type: string example: Juan Robles Hernández en_su_caracter_de: type: string example: ACREEDOR persona_que_solicita_o_autoridad_que_instruye_el_asiento: type: object properties: nombre_y_cargo: type: string example: N/A firma_electronica: type: object properties: cadena_original_solicitante: type: string example: MkdQYUeOZGNIU3AXa080V05jQkNGMzNDSitZPXwzMzczLzA5NA== sello_solicitante: type: string example: pBFfNh/Ox2+GiivFcx8xjMamo+njQpo/AtJlMCA/3TYByMnhPBP0kJjYhmAu7YhmCGg6K2AKrPIpVlOgS53nZH/kRBp0a0WdDCuhL7sZYdTuuGYa7IqvdkuGqCxppF6/JphYto7pgsKpozW5WleP+wE6Y37ZWSD9SvgfDIliL3faL3EBOQhNb3R3t+GcpzIyvhAtlONfsp0aHPo+1Ngr/7jwwXPaFQuKtVonWB7e0R4E4QmaEPAdkmFg0wfCCOuYufRCtqqgAVVHvV5DpBabp83w470qDVrmDyYTnbpFeg5pdN0k4vtESaSkVwGaxNnnVKNQ4j9sVG+KO0a2aej8xw== certificado_solicitante: type: string example: >- SERIALNUMBER=ROSR561225HDFJNC00, OID.2.5.4.45=ROSR561225HD0, EMAILADDRESS=juan.roblesh@gmail.com, C=MX, O=JUAN ROBLES HERNÁNDEZ, OID.2.5.4.41=JUAN ROBLES HERNÁNDEZ, CN=JUAN ROBLES HERNÁNDEZ sello_de_tiempo: type: string example: >- Certificado AC:O=Secretaria de Economia, OU=nCipher DSE ESN:48D7-2DFC-BF7B, CN=TS A1.economia.gob.mx, C=MX, ST=Ciudad de Mexico, L=Alvaro Obregon|Fecha: 202203110 01832.21Z|Numero de secuencia:107221737826163|Digestion: PUS8fSphg13dOKjPYoMVN82 DCLg= cadena_original_rug: type: string example: MkdQYUdOZGNIx3RXa080V05jQkNGMzNDSitZPXrzMzczNzA2NA==|k|d sello_rug: type: string example: B7auogaFXWzNO7EBganQX6Bm/XmU12bYsP8ahtNagGNEuLJ0EekYmjdNvBvzd5/x9Mr6ypXCcLue+2ZNEjf4BWzElZdmsI69/GWTOp6ULozM2eFZMzLSL/He6WGtkoceWulElNDApb0PUkfaDOovlkVSZYkG0HTmZ/C9fJLYMvzA2LrazeEDibqp/M9l9HTgwCa+7NcLi+eAKYDGXCfbhnfsdFpkk338hQoc4TPyoB0sy5bUFCwwM7kCD/6ZSTy8QAXm9nvdt8vX/UktryZwUB72shedXWqQx3QtWJWpWHgi1cl0gQSial00a1pQspFVXvcX5rC5mEdzeezhsECVfg== numero_serie_rug: type: string example: 123 certificado_rug: type: string example: >- EMAILADDRESS=contacto_rug@economia.gob.mx, O=Secretaria de Economia, OU=Direccion General de Normatividad Mercantil, CN=RUG. Ernesto del Castillo Hernandez, T=Di rector de Coordinacion del Registro Publico de Comercio, STREET="Insurgentes Sur 1940, Piso 1", OID.2.5.4.17=01030, C=MX, ST=Ciudad de Mexico, L=Alvaro Obregon, OID.2.5.4.45=#030E0043414845363731313037535638, SERIALNUMBER=CAHE671107HDFSRR03 , OID.2.5.4.20=(55)5229 6100 Ext. 33529 RugOperacionFull: allOf: - $ref: "#/components/schemas/RugOperacionPartial" - type: object description: Full RUG operation details properties: numeroDeGarantia: $ref: "#/components/schemas/RugNumeroDeGarantia" otorgantes: type: array items: $ref: "#/components/schemas/RugOperacionOtorgante" boleta: $ref: "#/components/schemas/RugOperacionBoleta" RugGarantia: type: object description: RUG guarantee resource properties: "@id": type: string format: iri-reference description: RUG guarantee IRI reference example: /datasources/rug/garantias/99c13810-868f-482e-a6f1-878254248d27 "@type": type: string default: RugGarantia id: $ref: "#/components/schemas/RugGarantiaID" numeroDeGarantia: $ref: "#/components/schemas/RugNumeroDeGarantia" fechaDeInscripcion: $ref: "#/components/schemas/RugGarantiaFechaDeInscripcion" fechaDeCancelacion: $ref: "#/components/schemas/RugGarantiaFechaDeCancelacion" otorgantes: type: array items: $ref: "#/components/schemas/RugGarantiaOtorgante" acreedor: $ref: "#/components/schemas/RugGarantiaAcreedor" tipoDeGarantia: $ref: "#/components/schemas/RugTipoDeGarantia" monto: $ref: "#/components/schemas/RugGarantiaMonto" moneda: $ref: "#/components/schemas/RugGarantiaMoneda" tipoDeLosBienes: $ref: "#/components/schemas/RugGarantiaTipoDeLosBienes" descripcionDeLosBienes: $ref: "#/components/schemas/RugGarantiaDescripcionDeLosBienes" fechaDeCelebracionDelActoOContrato: $ref: "#/components/schemas/RugGarantiaFechaDeCelebracionDelActoOContrato" fechaDeTerminacionDelActoOContrato: $ref: "#/components/schemas/RugGarantiaFechaDeTerminacionDelActoOContrato" operaciones: type: array items: $ref: "#/components/schemas/RugOperacionPartial" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" RugGarantiaID: type: string format: uuid description: RUG guarantee ID example: 99c13810-868f-482e-a6f1-878254248d27 RugNumeroDeGarantia: type: number description: RUG guarantee number example: 123456 RugGarantiaFechaDeInscripcion: type: string format: date-time description: Date and time the guarantee was registered example: 2021-10-12T19:58:11+00:00 RugGarantiaFechaDeCancelacion: type: [string, "null"] format: date-time description: Date and time the guarantee was cancelled example: 2023-03-12T00:00:00+00:00 RugGarantiaOtorgante: type: object description: Grantor associated with a RUG guarantee properties: nombre: type: string description: Grantor name example: El Otorgante de Garantías Mobiliarias, S.A. de C.V. folioElectronico: type: string description: Grantor electronic folio example: 34011*7 RugGarantiaAcreedor: type: string description: Creditor name reported for the guarantee example: Grupo Financiero Acreedor, S.A.P.I. de C.V., SOFOM E.N.R. RugTipoDeGarantia: type: string description: Type of movable collateral guarantee enum: - cesion_de_creditos - clausulas_rescisoria_y_de_reserva_de_dominio_en_compraventas_mercantiles - constituida_sobre_aeronave - constituida_sobre_embarcacion - derechos_de_retencion - derivada_de_un_arrendamiento_financiero - derivada_de_un_credito_de_habilitacion_o_avio - derivada_de_un_credito_refaccionario - derivada_de_un_fideicomiso_de_garantia - derivada_de_una_hipoteca_industrial - factoraje_financiero - otros_actos_gravamenes_o_afectaciones_sobre_bienes_muebles_en_los_que_el_acreedor_no_mantenga_la_posesion_sobre_los_mismos - prenda_ordinaria_mercantil_cuando_el_acreedor_prendario_no_mantenga_la_posesion_sobre_los_bienes - prenda_sin_transmision_de_posesion - privilegios_especiales example: factoraje_financiero RugGarantiaMonto: type: [number, "null"] format: float description: Guaranteed amount example: 12345.67 RugGarantiaMoneda: type: [string, "null"] description: Currency reported for the guaranteed amount example: peso_mexicano RugGarantiaTipoDeLosBienes: type: array description: Types of collateral goods covered by the guarantee items: type: string enum: - acciones_y_obligaciones_bonos_contratos_de_opcion_y_futuros - bienes_de_consumo - derechos_incluyendo_derechos_de_cobro - ganado - inventario - maquinaria_y_equipo - otros - productos_agricolas - vehiculos_de_motor example: derechos_incluyendo_derechos_de_cobro RugGarantiaDescripcionDeLosBienes: type: string description: Description of the collateral goods covered by the guarantee example: Factura con el folio fiscal 99c13810-868f-482e-a6f1-878254248d27 RugGarantiaFechaDeCelebracionDelActoOContrato: type: [string, "null"] format: date-time description: Date the act or contract was executed example: 2021-03-08T00:00:00+00:00 RugGarantiaFechaDeTerminacionDelActoOContrato: type: [string, "null"] format: date-time description: Date the act or contract ends example: 2022-03-08T00:00:00+00:00 TaxpayerBlacklistStatus: type: [string, "null"] description: The blacklist status while a taxpayer appears in a current SAT 69-B publication source example: presumed enum: - presumed - dismissed - definitive - favorable - null InvoiceIssuer: type: object properties: rfc: $ref: "#/components/schemas/TaxpayerID" name: $ref: "#/components/schemas/TaxpayerName" taxRegime: $ref: "#/components/schemas/InvoiceIssuerTaxRegime" blacklistStatus: $ref: "#/components/schemas/TaxpayerBlacklistStatus" example: rfc: AOM920820BEA name: APPLE OPERATIONS MEXICO S.A. DE C.V. taxRegime: 601 blacklistStatus: null InvoiceIsIssuer: type: boolean description: | `true` if the invoice issuer is the entity's RFC example: true InvoiceReceiver: type: object properties: rfc: $ref: "#/components/schemas/TaxpayerID" name: $ref: "#/components/schemas/TaxpayerName" blacklistStatus: $ref: "#/components/schemas/TaxpayerBlacklistStatus" InvoiceIsReceiver: type: boolean description: | `true` if the invoice receiver is the entity's RFC example: false InvoiceCurrency: type: [string, "null"] description: ISO 4217 alphabetic currency code minLength: 3 maxLength: 3 example: MXN InvoiceDiscount: type: number format: float description: Discount amount example: 3324 InvoiceTax: type: number format: float description: Tax amount example: 5224 InvoiceSubtotal: type: number format: float description: Subtotal amount example: 51349.8 InvoiceTotal: type: number format: float description: Invoice total amount example: 53249.8 InvoiceExchangeRate: type: [number, "null"] format: float description: Set when *currency* is different than MXN (Mexican Peso). example: 19.8 InvoicePaidAmount: type: number format: float description: For a deferred invoice this field state the paid amount. (Applies only for "PPD" invoices). example: 53249.8 InvoiceDueAmount: type: number format: float description: For a deferred invoice this field state the due amount. (Applies only for "PPD" invoices). example: 0 InvoiceCreditedAmount: type: [number, "null"] format: float description: Credited amount example: 31.32 InvoiceSubtotalCreditedAmount: type: [number, "null"] format: float description: Subtotal credited amount example: 27 InvoiceLastPaymentDate: type: [string, "null"] format: date-time description: This field is populated with the last related payment date (Applies only for "PPD" invoices). InvoiceFullyPaidAt: type: [string, "null"] format: date-time description: This field is populated when the total debt is paid. (Applies only for "PPD" invoices). InvoicePaymentTermsRaw: type: [string, "null"] example: Tarjeta de crédito description: The invoice payment terms text exactly as it comes from the invoice, i.e. immediate, 30 days, cash, credit card, etc InvoiceStatus: type: string enum: - VIGENTE - CANCELADO description: Whether the invoice is active or canceled example: VIGENTE InvoicePac: type: string minLength: 12 maxLength: 12 description: Certification provider tax ID (Proveedor Autorizado de Certificación) example: SAT970701NN3 InvoiceIssuedAt: type: string format: date-time description: Invoice issue date example: "2019-01-03T21:10:40.000Z" InvoiceCertifiedAt: type: string format: date-time description: Invoice certification date example: "2019-01-03T21:10:41.000Z" InvoiceCancellationStatus: type: string enum: - Cancelable sin aceptación - Cancelable con aceptación - No cancelable description: Whether or not the invoice can be canceled example: Cancelable con aceptación InvoiceCancellationStatusProcess: type: [string, "null"] enum: - En proceso - Solicitud rechazada - Cancelado sin aceptación - Cancelado con aceptación - Plazo vencido - null description: Set when the cancellation process starts example: En proceso InvoiceCanceledAt: type: [string, "null"] format: date-time description: Set when *status* is `CANCELADO` InvoiceRelationID: type: string format: uuid description: Invoice relation ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 InvoiceRelationType: type: number enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 description: Invoice relation type code from the [c_TipoRelacion](/guides/catalogs#c_tiporelacion) catalog example: 7 externalDocs: url: https://syntage.com/docs/catalogs/#c_tiporelacion InvoiceRelationInvoice: type: string format: iri-reference description: Invoice IRI reference example: /invoices/92106967-2abd-5d64-95c2-4e73d96fb998 InvoiceRelationRelatedInvoice: type: [string, "null"] format: iri-reference description: Invoice IRI reference example: /invoices/92106967-2abd-5d64-95c2-4e73d96fb998 InvoiceRelationRelatedInvoiceUuid: type: string format: uuid description: The related Invoice UUID (Folio fiscal) example: def404af-5eef-4112-aa99-d1ec8493b89a InvoiceRelation: type: object properties: "@id": type: string format: iri-reference description: Invoice Relation IRI reference example: /invoices/relations/93a197e7-6baa-5dc5-bf8d-fb1645a770c1 "@type": type: string default: InvoiceRelation id: $ref: "#/components/schemas/InvoiceRelationID" type: $ref: "#/components/schemas/InvoiceRelationType" invoice: $ref: "#/components/schemas/InvoiceRelationInvoice" relatedInvoice: $ref: "#/components/schemas/InvoiceRelationRelatedInvoice" relatedInvoiceUuid: $ref: "#/components/schemas/InvoiceRelationRelatedInvoiceUuid" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" InvoiceRelationCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/InvoiceRelation "@id": default: /invoices/relations "hydra:member": items: $ref: "#/components/schemas/InvoiceRelation" MxSatCfdi: type: object properties: uuid: type: string format: uuid description: Invoice UUID example: def404af-5eef-4112-aa99-d1ec8493b89a data: type: object description: Parsed CFDI data additionalProperties: true processedXmlAt: type: [string, "null"] format: date-time description: Date and time the CFDI XML was processed example: "2020-01-01T12:15:00.000Z" processedPdfAt: type: [string, "null"] format: date-time description: Date and time the CFDI PDF was processed example: "2020-01-01T12:15:00.000Z" InvoiceHasXML: type: boolean description: | `true` when the CFDI is available in the XML format. The file can be downloaded through the [retrieve an invoice CFDI](#operation/GetInvoiceCFDI) operation InvoiceHasPDF: type: boolean description: | `true` when the CFDI is available in the PDF format. The file can be downloaded through the [retrieve an invoice CFDI](#operation/GetInvoiceCFDI) operation Invoice: allOf: - $ref: "#/components/schemas/InvoiceCollectionItem" - type: object properties: tags: $ref: "#/components/schemas/TagCollection" InvoiceCollectionItem: type: object properties: "@id": type: string format: iri-reference description: Invoice IRI reference example: /invoices/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: Invoice id: $ref: "#/components/schemas/InvoiceID" uuid: $ref: "#/components/schemas/InvoiceUUID" version: $ref: "#/components/schemas/InvoiceVersion" reference: $ref: "#/components/schemas/InvoiceReference" internalIdentifier: $ref: "#/components/schemas/InvoiceInternalIdentifier" type: $ref: "#/components/schemas/InvoiceType" usage: $ref: "#/components/schemas/InvoiceUsage" paymentType: $ref: "#/components/schemas/InvoicePaymentType" paymentMethod: $ref: "#/components/schemas/InvoicePaymentMethod" paymentTerms: $ref: "#/components/schemas/InvoicePaymentTerms" placeOfIssue: $ref: "#/components/schemas/InvoicePlaceOfIssue" issuer: $ref: "#/components/schemas/InvoiceIssuer" isIssuer: $ref: "#/components/schemas/InvoiceIsIssuer" receiver: $ref: "#/components/schemas/InvoiceReceiver" isReceiver: $ref: "#/components/schemas/InvoiceIsReceiver" currency: $ref: "#/components/schemas/InvoiceCurrency" discount: $ref: "#/components/schemas/InvoiceDiscount" tax: $ref: "#/components/schemas/InvoiceTax" subtotal: $ref: "#/components/schemas/InvoiceSubtotal" creditedAmount: $ref: "#/components/schemas/InvoiceCreditedAmount" subtotalCreditedAmount: $ref: "#/components/schemas/InvoiceSubtotalCreditedAmount" total: $ref: "#/components/schemas/InvoiceTotal" exchangeRate: $ref: "#/components/schemas/InvoiceExchangeRate" paidAmount: $ref: "#/components/schemas/InvoicePaidAmount" dueAmount: $ref: "#/components/schemas/InvoiceDueAmount" lastPaymentDate: $ref: "#/components/schemas/InvoiceLastPaymentDate" fullyPaidAt: $ref: "#/components/schemas/InvoiceFullyPaidAt" paymentTermsRaw: $ref: "#/components/schemas/InvoicePaymentTermsRaw" status: $ref: "#/components/schemas/InvoiceStatus" pac: $ref: "#/components/schemas/InvoicePac" issuedAt: $ref: "#/components/schemas/InvoiceIssuedAt" certifiedAt: $ref: "#/components/schemas/InvoiceCertifiedAt" cancellationStatus: $ref: "#/components/schemas/InvoiceCancellationStatus" cancellationProcessStatus: $ref: "#/components/schemas/InvoiceCancellationStatusProcess" canceledAt: $ref: "#/components/schemas/InvoiceCanceledAt" relations: type: array items: $ref: "#/components/schemas/InvoiceRelation" xml: $ref: "#/components/schemas/InvoiceHasXML" pdf: $ref: "#/components/schemas/InvoiceHasPDF" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" InvoicePaymentID: type: string format: uuid description: Invoice Payment ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 InvoicePaymentInvoiceUUID: type: string format: uuid description: The related deferred Invoice UUID (Folio fiscal) example: def404af-5eef-4112-aa99-d1ec8493b89a InvoicePaymentCurrency: type: [string, "null"] description: ISO 4217 alphabetic currency code minLength: 3 maxLength: 3 example: MXN InvoicePaymentExchangeRate: type: [number, "null"] format: float description: Set when `currency` is different than MXN example: 19.8 InvoicePaymentInstallment: type: integer description: Payment installment example: 3 InvoicePaymentPreviousBalance: type: number format: float description: Amount before the payment example: 53249.8 InvoicePaymentAmount: type: number format: float description: Payment amount applied to the invoice. Positive values are income for the entity; negative values are expenses. example: -53249.8 InvoicePaymentOutstandingBalance: type: number format: float description: Due amount after a payment example: 0 InvoicePaymentCanceledAt: type: [string, "null"] format: date-time description: Set when the payment invoice is canceled InvoicePayment: type: object properties: "@id": type: string format: iri-reference description: Invoice Payment IRI reference example: /invoices/payments/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: InvoicePayment id: $ref: "#/components/schemas/InvoicePaymentID" invoiceUuid: $ref: "#/components/schemas/InvoicePaymentInvoiceUUID" currency: $ref: "#/components/schemas/InvoicePaymentCurrency" exchangeRate: $ref: "#/components/schemas/InvoicePaymentExchangeRate" installment: $ref: "#/components/schemas/InvoicePaymentInstallment" previousBalance: $ref: "#/components/schemas/InvoicePaymentPreviousBalance" amount: $ref: "#/components/schemas/InvoicePaymentAmount" outstandingBalance: $ref: "#/components/schemas/InvoicePaymentOutstandingBalance" invoice: type: string format: iri-reference description: Invoice IRI reference example: /invoices/91106968-1abd-4d64-85c1-4e73d96fb997 batchPayment: type: string format: iri-reference description: Invoice Batch Payment IRI reference example: /invoices/batch-payments/91106968-1abd-4d64-85c1-4e73d96fb997 canceledAt: $ref: "#/components/schemas/InvoicePaymentCanceledAt" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" Tag: type: object properties: "@id": type: string format: iri-reference description: Resource tag IRI reference example: /tags/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string description: JSON-LD resource type default: Tag id: $ref: "#/components/schemas/uuid" name: type: string description: Display name for the tag example: To be reviewed resourceType: type: string description: Resource type this tag can be applied to example: invoice color: type: [string, "null"] description: Lowercase 7-character hexadecimal color used to display the tag (`#RRGGBB`). Defaults to `#a3aab5` when a tag is created without a color. example: "#22c558" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" TagCollection: type: array items: $ref: "#/components/schemas/Tag" SchedulerRule: type: object properties: "@id": type: string format: iri-reference description: Scheduler Rule IRI reference example: /schedulers/rules/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string description: JSON-LD resource type default: SchedulerRule id: $ref: "#/components/schemas/uuid" scheduler: type: string description: Scheduler that owns this rule example: Daily Invoices Scheduler extractor: $ref: "#/components/schemas/ExtractionExtractor" options: $ref: "#/components/schemas/ExtractionOptions" cronExpression: type: [string, "null"] description: Cron expression that controls when the rule runs example: "@daily" nextRunDate: type: string description: Date and time the resource should execute in the next iteration example: "2020-01-01T12:15:00.000Z" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" SchedulerRuleInput: type: object required: - scheduler - extractor properties: scheduler: type: string writeOnly: true description: Scheduler IRI reference example: /schedulers/91106968-1abd-4d64-85c1-4e73d96fb997 extractor: $ref: "#/components/schemas/ExtractionExtractor" options: $ref: "#/components/schemas/ExtractionOptions" cronExpression: type: string writeOnly: true description: Cron expression that controls when the rule runs example: "@daily" SchedulerRuleUpdateInput: type: object properties: extractor: $ref: "#/components/schemas/ExtractionExtractor" options: $ref: "#/components/schemas/ExtractionOptions" cronExpression: type: string writeOnly: true description: Cron expression that controls when the rule runs example: "@daily" SchedulerRuleCollection: allOf: - $ref: "#/components/schemas/Collection" - type: object properties: "@context": default: /contexts/SchedulerRule "@id": default: /schedulers/rules "hydra:member": items: $ref: "#/components/schemas/SchedulerRule" "hydra:view": properties: "@id": example: /schedulers/rules?page=1 "@type": type: string default: hydra:PartialCollectionView hydra:first: example: /schedulers/rules?page=1 hydra:next: example: /schedulers/rules?page=2 hydra:last: example: /schedulers/rules?page=3 Scores: type: object properties: "@id": type: string format: iri-reference description: Scores IRI reference example: /.well-known/genid/78c595ac88fa9659fa80 "@type": type: string default: Scores scores: type: array description: List of score objects items: $ref: "#/components/schemas/Score" Score: type: object properties: "@id": type: string format: iri-reference description: Score IRI reference example: /.well-known/genid/78c595ac88fa9659fa80 "@type": type: string description: Type of score object default: ScoreBySource id: $ref: "#/components/schemas/uuid" source: type: string description: Source of the score example: "syntage" type: type: string description: Type of score example: "internal" score: type: string description: Calculated score example: "532" generatedAt: type: string description: Date and time the resource was generated example: "2020-01-01T12:15:00.000Z" metadata: type: object description: Essential information and attributes about the score; structure changes depending on source and type example: breakdown: offenders: margen_bruto: "Missing gross margin" margen_neto: "Missing net margin" performers: debt_to_income: "Debt to income between 0.4 and 0.6" quick_ratio: "Quick ratio > 3" distribution: - label: 500 metric: 1 ScoreDistribution: type: object description: Distribution of current Syntage Score values across score buckets. properties: distribution: type: array description: Number of Syntage Score records in each score bucket items: type: object properties: label: type: integer description: Score bucket label example: 500 metric: type: integer description: Number of scores in the bucket example: 12 BuroDeCreditoSummaryInsight: type: object description: Summary row for one Buró de Crédito report score. properties: id: type: string format: uuid description: Buró de Crédito report ID example: 9cc7fc78-5e84-4862-af83-c6c7022fcb41 productType: type: string enum: - "007" - "004" - INFORME_BURO - RCO description: Buró de Crédito product type used to generate the report example: "007" createdAt: type: string format: date-time description: Date and time when the report was created example: "2024-01-31T00:00:00+00:00" scoreValue: type: [string, "null"] description: Score value returned by Buró de Crédito when available example: "0676" scoreCode: type: [string, "null"] description: Buró de Crédito score code when available example: "007" scoreReasonCodes: type: array description: Buró de Crédito score reason codes items: type: string example: - "04" externalReturnKey: type: [string, "null"] description: Provider return key for legal-entity report products when available example: "1" EntityTag: type: object properties: "@id": type: string format: iri-reference description: Entity Tag IRI reference example: /entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string description: JSON-LD resource type default: EntityTag id: $ref: "#/components/schemas/uuid" name: type: string description: Display name for the entity tag example: Priority Entity color: type: [string, "null"] description: Lowercase 7-character hexadecimal color used to display the tag (`#RRGGBB`). Defaults to `#a3aab5` when an entity tag is created without a color. example: "#22c558" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" EntityTagCollection: type: array items: $ref: "#/components/schemas/EntityTag" Scheduler: type: object properties: "@id": type: string format: iri-reference description: Scheduler IRI reference example: /schedulers/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string description: JSON-LD resource type default: Scheduler id: $ref: "#/components/schemas/uuid" name: type: [string, "null"] example: Daily Invoices Scheduler description: Scheduler name; may be null for first-time schedulers created automatically by the platform type: type: string description: Scheduler type example: recurring enum: - recurring isEnabled: type: boolean description: Whether the scheduler is enabled example: true rules: $ref: "#/components/schemas/SchedulerRuleCollection" tags: $ref: "#/components/schemas/EntityTagCollection" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" SchedulerInput: type: object required: - type properties: name: type: [string, "null"] writeOnly: true description: Scheduler name; if omitted, the scheduler is created without a name example: Daily Invoices Scheduler type: type: string writeOnly: true description: Scheduler type; only `recurring` is allowed for creation example: recurring enum: - recurring isEnabled: type: boolean writeOnly: true description: Whether the scheduler is enabled example: true default: true tags: type: array writeOnly: true description: Entity tags to associate with the scheduler example: - /entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997 items: type: string format: iri-reference SchedulerUpdateInput: type: object properties: name: type: string writeOnly: true description: Scheduler name example: Daily Invoices Scheduler isEnabled: type: boolean writeOnly: true description: Whether the scheduler is enabled example: true tags: type: array writeOnly: true description: Tags to associate with the scheduler; sending this key replaces the existing tag collection example: - /entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997 items: type: string format: iri-reference SchedulerCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/Scheduler "@id": default: /schedulers "hydra:member": items: $ref: "#/components/schemas/Scheduler" InvoiceCreditNote: type: object properties: "@id": type: string format: iri-reference description: Invoice Credit Note IRI reference example: /invoices/credit-notes/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: InvoiceCreditNote id: type: string format: uuid description: Invoice credit note ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 appliedInvoice: type: [string, "null"] format: iri-reference description: Invoice receiving the credit example: /invoices/91106968-1abd-4d64-85c1-4e73d96fb997 issuedInvoice: type: [string, "null"] format: iri-reference description: Invoice issuing the credit example: /invoices/91106968-1abd-4d64-85c1-4e73d96fb997 appliedInvoiceUuid: type: [string, "null"] format: uuid description: UUID of the invoice receiving the credit example: def404af-5eef-4112-aa99-d1ec8493b89a issuedInvoiceUuid: type: [string, "null"] format: uuid description: UUID of the invoice issuing the credit example: def404af-5eef-4112-aa99-d1ec8493b89a issuedAt: type: string format: date-time description: Date and time the credit note invoice was issued proportionalRate: type: [number, "null"] format: float description: Percentage of the credit note applied to the target invoice. example: 19.8 amount: type: number format: float description: Amount of the credit note applied to the target invoice, in the target invoice's currency. When an exchange rate is unavailable, the credit note's amount is applied without conversion. example: 19.8 subTotalAmount: type: [number, "null"] format: float description: Amount of the credit note applied to the target invoice before taxes, in the target invoice's currency. When an exchange rate is unavailable, the credit note's amount is applied without conversion. example: 19.8 issuedInvoiceTotal: type: number format: float description: Total of the credit note that was taken into account to calculate the credit, in the credit note's currency. example: 19.8 canceledAt: type: [string, "null"] format: date-time description: Date and time the credit note invoice was canceled createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" InvoicePaymentCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/InvoicePayment "@id": default: /invoices/payments "hydra:member": items: $ref: "#/components/schemas/InvoicePayment" InvoiceCreditNoteCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/InvoiceCreditNote "@id": default: /invoices/credit-notes "hydra:member": items: $ref: "#/components/schemas/InvoiceCreditNote" InvoiceBatchPaymentID: type: string format: uuid description: Invoice batch payment ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 InvoiceBatchPaymentDate: type: [string, "null"] format: date-time description: Payment date InvoiceBatchPaymentPaymentMethod: type: [string, "null"] enum: - "01" - "02" - "03" - "04" - "05" - "06" - "08" - "12" - "13" - "14" - "15" - "17" - "23" - "24" - "25" - "26" - "27" - "28" - "29" - "30" - "31" - "99" - null example: "04" description: Payment method code from the [c_FormaPago](/guides/catalogs#c_formapago) catalog externalDocs: url: https://syntage.com/docs/catalogs#c_formapago InvoiceBatchPaymentCurrency: type: [string, "null"] description: ISO 4217 alphabetic currency code minLength: 3 maxLength: 3 example: MXN InvoiceBatchPaymentExchangeRate: type: [number, "null"] format: float description: Set when `currency` is different than MXN example: 19.8 InvoiceBatchPaymentAmount: type: number format: float description: Total batch payment amount. Positive values are income for the entity; negative values are expenses. example: -53249.8 InvoiceBatchPaymentOperationNumber: type: string description: Operation identifier, it is used for internal control example: "1022030122" InvoiceBatchPaymentBeneficiaryBank: type: object properties: rfc: type: string maxLength: 13 description: Beneficiary bank RFC example: IIA040805DZ4 accountNumber: type: string maxLength: 50 description: Beneficiary bank account number example: "12343453245633" InvoiceBatchPaymentPayerBank: type: object properties: rfc: type: string maxLength: 13 description: Payer bank RFC example: IIA040805DZ4 name: type: string maxLength: 300 description: Payer bank name example: International bank accountNumber: type: string maxLength: 50 description: Payer bank account number example: "12343453245633" InvoiceBatchPaymentCanceledAt: type: [string, "null"] format: date-time description: Date and time the payment receipt invoice was canceled InvoiceBatchPayment: type: object properties: "@id": type: string format: iri-reference description: Invoice Batch Payment IRI reference example: /invoices/batch-payments/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: InvoiceBatchPayment id: $ref: "#/components/schemas/InvoiceBatchPaymentID" date: $ref: "#/components/schemas/InvoiceBatchPaymentDate" paymentMethod: $ref: "#/components/schemas/InvoiceBatchPaymentPaymentMethod" currency: $ref: "#/components/schemas/InvoiceBatchPaymentCurrency" exchangeRate: $ref: "#/components/schemas/InvoiceBatchPaymentExchangeRate" amount: $ref: "#/components/schemas/InvoiceBatchPaymentAmount" operationNumber: $ref: "#/components/schemas/InvoiceBatchPaymentOperationNumber" beneficiaryBank: $ref: "#/components/schemas/InvoiceBatchPaymentBeneficiaryBank" payerBank: $ref: "#/components/schemas/InvoiceBatchPaymentPayerBank" payments: type: array items: allOf: - $ref: "#/components/schemas/InvoicePayment" invoice: allOf: - $ref: "#/components/schemas/Invoice" canceledAt: $ref: "#/components/schemas/InvoiceBatchPaymentCanceledAt" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" InvoiceBatchPaymentCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/InvoiceBatchPayment "@id": default: /invoices/batch-payments "hydra:member": items: $ref: "#/components/schemas/InvoiceBatchPayment" InvoiceLineItem: type: object properties: "@id": type: string format: iri-reference description: Invoice Line Item IRI reference example: /invoices/line-items/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: InvoiceLineItem id: type: string format: uuid description: Invoice line item ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 invoice: $ref: "#/components/schemas/Invoice" identificationNumber: type: [string, "null"] description: Seller-provided item or SKU identifier productIdentification: type: string description: SAT product or service code from the [c_ClaveProdServ](/guides/catalogs#c_claveprodserv) catalog example: "50121537" description: type: string description: Line item description from the CFDI example: Apple iPhone unitAmount: type: number format: double description: Unit price before quantity is applied example: 70 unitCode: type: string description: SAT unit code from the [c_ClaveUnidad](/guides/catalogs#c_claveunidad) catalog example: KGM quantity: type: number format: double description: Quantity billed for this line item example: 60 discountAmount: type: number format: double description: Discount amount applied to this line item example: 0 totalAmount: type: number format: double description: Total line item amount after quantity and discounts example: 4200 retainedTaxes: $ref: "#/components/schemas/RetainedTaxes" transferredTaxes: $ref: "#/components/schemas/TransferredTaxes" taxes: type: array description: >- Full tax detail for the line item, one entry per tax node (`Traslado` or `Retencion`) in the CFDI concepto. Carries the rate and factor type, which `retainedTaxes` and `transferredTaxes` do not. A tax can appear more than once when the CFDI applies it at different rates. items: type: object properties: type: type: string description: Whether the tax is transferred (trasladado) or retained (retenido) enum: - transfer - retention tax: type: string description: SAT tax code from the [c_Impuesto](/guides/catalogs#c_impuesto) catalog. `001` ISR, `002` IVA, `003` IEPS. enum: - "001" - "002" - "003" base: type: [number, "null"] format: double description: >- Taxable base (as in the `Base` attribute of the CFDI `Traslado` or `Retencion` node), with the decimals of the CFDI. It can be lower than the line item's `totalAmount` when the tax applies to only part of it. For `rate` and `share`, the CFDI calculates `amount` as `base` multiplied by `factor.amount`. Also reported for `exempt`. `null` when the CFDI does not include it, and not present for line items processed before this field was introduced. factor: type: object properties: type: type: [string, "null"] description: >- Factor type from the [c_TipoFactor](/guides/catalogs#c_tipofactor) catalog: `rate` (Tasa) is a percentage of the base, `share` (Cuota) is a fixed amount per unit, and `exempt` (Exento) means the line is exempt from the tax. `null` when the CFDI does not include it. enum: - rate - share - exempt - null amount: type: number format: double description: >- Rate or quota (TasaOCuota). A fraction for `rate` (0.16 for 16%) and an amount per unit for `share`. `0` for `exempt`. amount: type: number format: double description: Tax amount (Importe). `0` for `exempt`. example: - type: transfer tax: "002" base: 4200 factor: type: rate amount: 0.16 amount: 672 createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" TaxRetentionID: type: string format: uuid description: Tax retention ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 TaxRetentionUUID: type: string format: uuid description: Tax retention UUID (Folio fiscal) example: def404af-5eef-4112-aa99-d1ec8493b89a TaxRetentionVersion: type: [number, "null"] format: float description: CFDI version example: 1 TaxRetentionCode: type: [string, "null"] example: "25" description: Retention type code from the [Clave de retenciones](/guides/catalogs#clave-de-retenciones) catalog enum: - "01" - "02" - "03" - "04" - "05" - "06" - "07" - "08" - "09" - "10" - "11" - "12" - "13" - "14" - "15" - "16" - "17" - "18" - "19" - "20" - "21" - "22" - "23" - "24" - "25" - "26" - null externalDocs: url: https://syntage.com/docs/catalogs#clave-de-retenciones TaxRetentionDescription: type: [string, "null"] example: Información referente a la fiduciaria description: Retention type description when `code` is `25` (other retention types) TaxpayerCurp: type: string minLength: 18 maxLength: 18 description: Unique Population Registry Code (CURP) example: PEIC123456ABCDEF12 TaxRetentionIssuer: type: object properties: rfc: $ref: "#/components/schemas/TaxpayerID" name: $ref: "#/components/schemas/TaxpayerName" curp: $ref: "#/components/schemas/TaxpayerCurp" TaxpayerNationality: type: string description: Indicator to know if the taxpayer is Mexican or from other countries. example: national enum: - national - foreign TaxRetentionReceiver: type: object properties: rfc: $ref: "#/components/schemas/TaxpayerID" name: $ref: "#/components/schemas/TaxpayerName" nationality: $ref: "#/components/schemas/TaxpayerNationality" curp: $ref: "#/components/schemas/TaxpayerCurp" TaxRetentionPac: type: string minLength: 12 maxLength: 12 description: Certification provider tax ID (Proveedor Autorizado de Certificación) example: SAT970701NN3 TaxRetentionInternalIdentifier: type: [string, "null"] description: An open field for internal identification. Commonly used to identify a tax retention maxLength: 40 example: "00001" TaxRetentionIssuedAt: type: string format: date-time description: Tax retention issue date example: "2019-01-03T21:10:40.000Z" TaxRetentionCertifiedAt: type: string format: date-time description: Tax return certification date example: "2019-01-03T21:10:41.000Z" TaxRetentionCanceledAt: type: [string, "null"] format: date-time description: Set when the tax retention is canceled. TaxRetentionItem: type: object properties: baseAmount: type: number format: float description: Tax base amount for this retained tax item example: 45905 taxType: type: string description: SAT tax type code example: "002" retainedAmount: type: number format: float description: Amount retained for this tax item example: 7344 paymentType: type: string description: Whether the retained tax payment is provisional or definitive example: provisional enum: - provisional - definitive TaxRetentionTotalOperationAmount: type: number format: float description: Operation amount example: 53249.8 TaxRetentionTotalTaxableAmount: type: number format: float description: Subtraction between `totalOperationAmount` and `totalExemptAmount` example: 43249 TaxRetentionTotalExemptAmount: type: number format: float description: Exempt amount example: 1000.8 TaxRetentionTotalRetainedAmount: type: number format: float description: Total retained tax amount example: 1550.7 TaxRetentionPeriodFrom: type: [string, "null"] format: date-time description: Start date for the tax retention period TaxRetentionPeriodTo: type: [string, "null"] format: date-time description: End date for the tax retention period TaxRetentionHasPDF: type: boolean description: | `true` when the CFDI is available in the PDF format. The file can be downloaded through the [retrieve a tax retention CFDI](#operation/GetTaxRetentionCFDI) operation TaxRetentionHasXML: type: boolean description: | `true` when the CFDI is available in the XML format. The file can be downloaded through the [retrieve a tax retention CFDI](#operation/GetTaxRetentionCFDI) operation TaxRetention: type: object properties: "@id": type: string format: iri-reference description: Tax retention IRI reference example: /tax-retentions/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: TaxRetention id: $ref: "#/components/schemas/TaxRetentionID" uuid: $ref: "#/components/schemas/TaxRetentionUUID" version: $ref: "#/components/schemas/TaxRetentionVersion" code: $ref: "#/components/schemas/TaxRetentionCode" description: $ref: "#/components/schemas/TaxRetentionDescription" issuer: allOf: - $ref: "#/components/schemas/TaxRetentionIssuer" - type: object example: rfc: AOM920820BEA name: APPLE OPERATIONS MEXICO S.A. DE C.V. receiver: $ref: "#/components/schemas/TaxRetentionReceiver" pac: $ref: "#/components/schemas/TaxRetentionPac" internalIdentifier: $ref: "#/components/schemas/TaxRetentionInternalIdentifier" issuedAt: $ref: "#/components/schemas/TaxRetentionIssuedAt" certifiedAt: $ref: "#/components/schemas/TaxRetentionCertifiedAt" canceledAt: $ref: "#/components/schemas/TaxRetentionCanceledAt" items: type: array items: $ref: "#/components/schemas/TaxRetentionItem" totalOperationAmount: $ref: "#/components/schemas/TaxRetentionTotalOperationAmount" totalTaxableAmount: $ref: "#/components/schemas/TaxRetentionTotalTaxableAmount" totalExemptAmount: $ref: "#/components/schemas/TaxRetentionTotalExemptAmount" totalRetainedAmount: $ref: "#/components/schemas/TaxRetentionTotalRetainedAmount" periodFrom: $ref: "#/components/schemas/TaxRetentionPeriodFrom" periodTo: $ref: "#/components/schemas/TaxRetentionPeriodTo" pdf: $ref: "#/components/schemas/TaxRetentionHasPDF" xml: $ref: "#/components/schemas/TaxRetentionHasXML" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" TaxpayerTaxRetentionCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/TaxRetention "@id": default: /entities/{entityId}/tax-retentions example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/tax-retentions "hydra:member": items: $ref: "#/components/schemas/TaxRetention" EntityType: type: string enum: - company - person description: Type of entity example: company Entity: type: object properties: "@id": type: string format: iri-reference description: Entity IRI reference example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string description: JSON-LD resource type; Entity resources currently use the legacy `Link` JSON-LD type for backwards compatibility default: Link id: $ref: "#/components/schemas/uuid" type: $ref: "#/components/schemas/EntityType" taxpayer: $ref: "#/components/schemas/Taxpayer" credential: $ref: "#/components/schemas/Credential" tags: $ref: "#/components/schemas/EntityTagCollection" isFavorite: type: boolean readOnly: true description: Whether this entity is a favorite of the authenticated user in their organization. Included by default on GET entity list and item responses only; when selecting response fields with properties[], include properties[]=isFavorite to receive it. createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" EntityCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/Entity "@id": default: /entities "hydra:member": items: $ref: "#/components/schemas/Entity" EntityIdentifier: type: object properties: "@id": type: string format: iri-reference description: Entity identifier IRI reference example: /.well-known/genid/78c595ac88fa9659fa80 "@type": type: string description: JSON-LD resource type default: EntityIdentifier id: $ref: "#/components/schemas/uuid" link: type: string format: iri-reference description: Entity IRI reference example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997 country: type: string description: Country that issued the identifier enum: - mx example: mx identifier: type: string description: Kind of identifier for the entity enum: - curp - rfc example: rfc value: type: string description: Identifier value example: XAXX010101000 createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" EntityIdentifierCollection: allOf: - $ref: "#/components/schemas/Collection" - type: object properties: "@context": default: /contexts/EntityIdentifier "@id": example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/identifiers "hydra:member": items: $ref: "#/components/schemas/EntityIdentifier" EntityIdentifierCreateInput: type: object required: - country - identifier - value properties: country: type: string description: Country that issued the identifier enum: - mx writeOnly: true example: mx identifier: type: string description: Kind of identifier to add to the entity enum: - curp - rfc writeOnly: true example: rfc value: type: string writeOnly: true description: Identifier value example: XAXX010101000 EntityIriCollection: oneOf: - type: array items: type: string example: - /entities/91106968-1abd-4d64-85c1-4e73d96fb997 EntityUpdateInput: properties: tags: type: array writeOnly: true description: Tags to associate with the entity; sending this key replaces the existing tag collection items: type: string format: iri-reference example: - /entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997 name: type: string writeOnly: true description: Entity name example: Syntage EntityTagCreateInput: type: object required: - name properties: name: type: string writeOnly: true description: Entity tag name example: Priority Entity color: type: [string, "null"] writeOnly: true description: Optional display color as a 7-character hexadecimal string (`#RRGGBB`). Omit or send `null` to fall back to the default color. example: "#22c558" EntityTagUpdateInput: type: object properties: name: type: string writeOnly: true description: Entity tag name example: Priority Entity color: type: [string, "null"] writeOnly: true description: Optional display color as a 7-character hexadecimal string (`#RRGGBB`). Send `null` to clear the color and fall back to the default. example: "#22c558" TagInvoiceInput: properties: tags: type: array writeOnly: true description: Tags to associate with the invoice; sending this key replaces the existing tag collection items: type: string format: iri-reference example: - /tags/91106968-1abd-4d64-85c1-4e73d96fb997 TagInvoicesBatchInput: type: object required: - resources - tags properties: resources: type: array writeOnly: true description: Invoices to tag or untag, as IRI references minItems: 1 maxItems: 100 items: type: string format: iri-reference example: - /invoices/91106968-1abd-4d64-85c1-4e73d96fb997 tags: type: array writeOnly: true description: Tags to add or remove, as IRI references minItems: 1 maxItems: 50 items: type: string format: iri-reference example: - /tags/018d9dd9-459f-768e-bc55-a8a72d0d3e9a TagInvoicesBatch: type: object properties: resources: type: array description: IDs of the invoices the operation was applied to items: type: string format: uuid tags: type: array description: IDs of the tags added or removed items: type: string format: uuid TagEntitiesBatchInput: type: object required: - resources - tags properties: resources: type: array writeOnly: true description: Entities to tag or untag, as IRI references minItems: 1 maxItems: 100 items: type: string format: iri-reference example: - /entities/91106968-1abd-4d64-85c1-4e73d96fb997 tags: type: array writeOnly: true description: Entity tags to add or remove, as IRI references minItems: 1 maxItems: 50 items: type: string format: iri-reference example: - /entity-tags/018d9dd9-459f-768e-bc55-a8a72d0d3e9a TagEntitiesBatch: type: object properties: resources: type: array description: IDs of the entities the operation was applied to items: type: string format: uuid tags: type: array description: IDs of the entity tags added or removed items: type: string format: uuid TagCreateInput: type: object required: - name - resourceType properties: name: type: string writeOnly: true description: Tag name example: To be reviewed resourceType: type: string writeOnly: true description: Resource type this tag can be applied to example: invoice color: type: [string, "null"] writeOnly: true description: Optional display color as a 7-character hexadecimal string (`#RRGGBB`). Omit or send `null` to fall back to the default color. example: "#22c558" TagUpdateInput: type: object properties: name: type: string writeOnly: true description: Tag name example: To be reviewed color: type: [string, "null"] writeOnly: true description: Optional display color as a 7-character hexadecimal string (`#RRGGBB`). Send `null` to clear the color and fall back to the default. example: "#22c558" InvoiceCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/Invoice "@id": default: /entities/{entityId}/invoices example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/invoices "hydra:member": items: $ref: "#/components/schemas/Invoice" TaxReturnID: type: string format: uuid description: Tax Return ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 TaxReturnOperationNumber: type: number example: 200100172932 description: Tax return operation code generated by SAT (Número de operación) TaxReturnIntervalUnit: type: string enum: - Anual - Mensual - RIF example: Mensual TaxReturnPeriod: type: string description: Fiscal period. For an annual tax return, it is a year and for monthly tax return it is a month example: Diciembre TaxReturnFiscalYear: type: string example: 2019 description: Fiscal year TaxReturnType: type: string enum: - Complementaria - Complementaria Corrección Fiscal - Complementaria Dictamen - Normal - Normal por Corrección Fiscal example: Complementaria TaxReturnComplementary: type: [string, "null"] description: Set when *type* is `complementaria*` enum: - Declaración no Presentada - Dejar sin Efecto Declaración - Dejar sin Efecto Obligación - Esquema Anterior - Modificación de Declaración - Modificación de Obligaciones - Obligación no presentada - null example: Modificación de Obligaciones TaxReturnPresentedAt: type: string format: date-time description: Tax return filing date TaxReturnCaptureLine: type: [string, "null"] description: Set when the an amount should be paid back to SAT example: 042007HZ795527888246 TaxReturnFiles: type: array description: Tax return PDF files (ack receipt, transcript and payment receipt) items: $ref: "#/components/schemas/File" TaxReturnIssifObligation: type: [boolean, "null"] description: | Indicates whether the taxpayer is obligated to file the Informative Statement on Tax Situation (ISSIF/DISIF) under Article 32-H of the Mexican Federal Tax Code (CFF). Derived from the annual return PDF, either from the 32-H obligation question or from a referenced ISSIF artifact (the `ARCHIVO ISSIF` section or a `.sb2x` filename). When `true`, financial statements for this return are filed separately via SIPRED and therefore are not present in the standard annual-return Excel. Only set on annual returns for Personas Morales filed from fiscal year 2018 onward; older returns always return `false`. example: false TaxReturnPayment: description: Payment type: object properties: dueAmount: type: number format: float description: Amount due for the tax return payment example: 53249.8 dueDate: type: string format: date-time description: Payment due date example: "2019-01-03T21:10:40.000Z" code: description: Payment code type: string example: "0777555544443332222" bank: description: Payer bank type: string example: BBVA Bancomer, S.A. paidAmount: type: number format: float description: Tax return paid amount date: type: string format: date-time description: Payment date operationNumber: type: string description: Bank operation number for the payment example: "123456" TaxReturn: type: object properties: "@id": type: string format: iri-reference description: Tax Return IRI reference example: /tax-returns/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: TaxReturn id: $ref: "#/components/schemas/TaxReturnID" taxpayer: $ref: "#/components/schemas/Taxpayer" operationNumber: $ref: "#/components/schemas/TaxReturnOperationNumber" intervalUnit: $ref: "#/components/schemas/TaxReturnIntervalUnit" period: $ref: "#/components/schemas/TaxReturnPeriod" fiscalYear: $ref: "#/components/schemas/TaxReturnFiscalYear" type: $ref: "#/components/schemas/TaxReturnType" complementary: $ref: "#/components/schemas/TaxReturnComplementary" presentedAt: $ref: "#/components/schemas/TaxReturnPresentedAt" captureLine: $ref: "#/components/schemas/TaxReturnCaptureLine" files: $ref: "#/components/schemas/TaxReturnFiles" issifObligation: $ref: "#/components/schemas/TaxReturnIssifObligation" payment: $ref: "#/components/schemas/TaxReturnPayment" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" TaxComplianceCheckInternalIdentifier: type: string description: The internal identifier (folio) generated by the SAT example: 20NE1234567 TaxComplianceCheckResult: type: string enum: - positive - negative - no_obligations - activity_suspended example: no_obligations TaxComplianceCheckCheckedAt: type: string description: Check date example: "2020-01-01T12:15:00.000Z" TaxComplianceCheck: type: object properties: "@id": type: string format: iri-reference description: Tax Compliance Check IRI reference example: /tax-compliance-checks/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: TaxComplianceCheck id: type: string description: Tax compliance check ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 file: allOf: - $ref: "#/components/schemas/File" - example: type: tax_compliance_check.pdf resource: /tax-compliance-check/91106968-1abd-4d64-85c1-4e73d96fb997 mimeType: application/pdf extension: pdf filename: PEIC211118IS0_20RD1174999.pdf internalIdentifier: $ref: "#/components/schemas/TaxComplianceCheckInternalIdentifier" taxpayer: type: object description: Taxpayer details reported in the compliance document properties: rfc: $ref: "#/components/schemas/TaxpayerID" name: $ref: "#/components/schemas/TaxpayerName" result: $ref: "#/components/schemas/TaxComplianceCheckResult" checkedAt: $ref: "#/components/schemas/TaxComplianceCheckCheckedAt" createdAt: $ref: "#/components/schemas/createdAt" TaxStatusPerson: type: [object, "null"] description: Physical person information extracted from the SAT tax status document. Null when the entity is not a physical person. properties: fullName: type: [string, "null"] description: Full name from the SAT tax status document. example: Pedro Infante Cruz firstName: type: [string, "null"] description: Given name or names from the SAT tax status document. example: Pedro middleName: type: [string, "null"] description: First surname from the SAT tax status document. example: Infante lastName: type: [string, "null"] description: Second surname from the SAT tax status document. example: Cruz curp: type: [string, "null"] description: CURP from the SAT tax status document when present. example: PEIC90110UEYBVT85 TaxStatusCompany: description: Company information. Null when the taxpayer is not a legal person. type: [object, "null"] properties: legalName: type: string description: Legal name from the SAT tax status document example: APPLE OPERATIONS MEXICO tradeName: type: string description: Trade name from the SAT tax status document example: APPLE OPERATIONS MEXICO S.A. DE C.V. entityType: type: string description: Legal entity type from the SAT tax status document example: SOCIEDAD ANONIMA DE CAPITAL VARIABLE TaxStatusAddress: type: object description: Fiscal address from the SAT tax status document properties: streetReferences: type: array minItems: 1 description: Address references or nearby streets items: type: string example: Camiño Galván streetNumber: type: string description: Exterior street number example: "8124" buildingNumber: type: string description: Interior building or unit number example: "496" locality: type: string description: Locality or city example: TUXTLA GUTIERREZ municipality: type: string description: Municipality or delegation example: TUXTLA GUTIERREZ postalCode: type: string description: Postal code example: "29000" state: type: string description: State example: CHIAPAS streetName: type: string description: Street name example: Plaza Jorge Luis streetType: type: string description: Street type example: Calle neighborhood: type: string description: Neighborhood or colonia example: Paseo Ricardo statusRaw: type: string description: Raw SAT address location status example: LOCALIZADO - Domicilio Localizado TaxStatusEconomicActivities: type: array items: type: object properties: name: type: string example: Asalariado order: type: string example: "1" percentage: type: string example: "100" startDate: type: string format: date description: Date when SAT reports the economic activity started. endDate: type: [string, "null"] format: date description: Date when SAT reports the economic activity ended. `null` when the activity is still active according to SAT. TaxStatusTaxRegimes: type: array items: type: object properties: code: type: integer example: 601 name: type: string example: Régimen de Sueldos y Salarios e Ingresos Asimilados a Salarios startDate: type: string format: date description: Date when SAT reports the tax regime started. endDate: type: [string, "null"] format: date description: Date when SAT reports the tax regime ended. `null` when the tax regime is still active according to SAT. TaxStatusObligations: type: array items: type: object properties: description: type: string example: Pago definitivo mensual de IVA. dueDate: type: string example: A más tardar el día 17 del mes inmediato posterior al periodo que corresponda. startDate: type: string format: date description: Date when SAT reports the obligation started. endDate: type: [string, "null"] format: date description: Date when SAT reports the obligation ended. `null` when the obligation is still active according to SAT. TaxStatus: type: object properties: "@id": type: string format: iri-reference description: Tax Status IRI reference example: /tax-status/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: TaxStatus id: type: string description: Tax status ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 file: allOf: - $ref: "#/components/schemas/File" - example: type: TaxStatus resource: /tax-status/91106968-1abd-4d64-85c1-4e73d96fb997 mimeType: application/pdf extension: pdf filename: 91106968-1abd-4d64-85c1-4e73d96fb997.pdf rfc: $ref: "#/components/schemas/TaxpayerID" cif: type: string description: SAT CIF identifier example: 20060152922 person: $ref: "#/components/schemas/TaxStatusPerson" company: $ref: "#/components/schemas/TaxStatusCompany" email: type: string description: Email address reported in the tax status document example: my-email@test.com phone: type: string maxLength: 10 description: Phone number reported in the tax status document example: "5512345678" address: $ref: "#/components/schemas/TaxStatusAddress" economicActivities: $ref: "#/components/schemas/TaxStatusEconomicActivities" taxRegimes: $ref: "#/components/schemas/TaxStatusTaxRegimes" obligations: $ref: "#/components/schemas/TaxStatusObligations" startedOperationsAt: type: string format: date-time description: Date when SAT reports the taxpayer started operations status: type: string description: Taxpayer status reported by SAT example: Activo statusUpdatedAt: type: string format: date-time description: Date when the SAT taxpayer status was last updated createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" TaxpayerTaxReturnCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/TaxReturn "@id": default: /entities/{entityId}/tax-returns example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/tax-returns "hydra:member": items: $ref: "#/components/schemas/TaxReturn" TaxpayerTaxComplianceCheckCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/TaxComplianceCheck "@id": default: /entities/{entityId}/tax-compliance-checks example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/tax-compliance-checks "hydra:member": items: $ref: "#/components/schemas/TaxComplianceCheck" TaxpayerTaxStatusCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/TaxStatus "@id": default: /entities/{entityId}/tax-status example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/tax-status "hydra:member": items: $ref: "#/components/schemas/TaxStatus" TaxpayerElectronicAccountingRecordCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/ElectronicAccountingRecord "@id": default: /entities/{entityId}/electronic-accounting-records example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/electronic-accounting-records "hydra:member": items: $ref: "#/components/schemas/ElectronicAccountingRecord" TaxpayerRpcEntidadeCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/RpcEntidade "@id": default: /entities/{entityId}/datasources/mx/rpc/entidades example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/datasources/mx/rpc/entidades "hydra:member": items: $ref: "#/components/schemas/RpcEntidade" EntityRpcActoCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/RpcActo "@id": default: /entities/{entityId}/datasources/mx/rpc/actos example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/datasources/mx/rpc/actos "hydra:member": items: $ref: "#/components/schemas/RpcActo" TaxpayerRugOperacionCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/RugOperacion "@id": default: /entities/{entityId}/datasources/rug/operaciones example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/datasources/rug/operaciones "hydra:member": items: $ref: "#/components/schemas/RugOperacionFull" TaxpayerRugGarantiaCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/RugGarantia "@id": default: /entities/{entityId}/datasources/rug/garantias example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/datasources/rug/garantias "hydra:member": items: $ref: "#/components/schemas/RugGarantia" TaxRegime: type: object properties: id: type: number enum: - 601 - 605 - 612 - 621 - 622 - 625 - 626 description: SAT tax regime code WebhookEndpointUrl: type: string format: url description: Public HTTPS URL where Syntage sends matching webhook events example: https://example.com/webhooks/syntage WebhookEndpointEventType: type: string description: Event type delivered to a webhook endpoint enum: - credential.created - credential.updated - credential.deleted - link.created - link.updated - link.deleted - extraction.created - extraction.updated - invoice.created - invoice.updated - invoice.deleted - tax_return.created - tax_return.updated - tax_return.deleted - file.created - export.created - export.updated - tax_status.created - tax_status.updated - tax_status.deleted - tax_compliance_check.created - tax_compliance_check.updated - tax_compliance_check.deleted - tax_retention.created - tax_retention.updated - tax_retention.deleted - invoice_payment.created - invoice_payment.updated - invoice_line_item.created - invoice_line_item.updated - electronic_accounting_record.created - electronic_accounting_record.updated - rpc_entidades.created - rpc_entidades.updated - rpc_socios.created - rpc_socios.updated - rpc_acto.created - rpc_acto.updated - shareholder_relation.created - shareholder_relation.updated - shareholder_relation_source.created - rug_garantia.created - rug_garantia.updated - buro_de_credito_report.created - buro_de_credito_report.updated - background_check.created - sat_certificate.created - sat_certificate.updated - company_verification_report.created - company_verification_report.updated WebhookEndpointContentType: type: string description: Content type used for webhook delivery payloads enum: - application/ld+json - application/json WebhookEndpointEnabled: type: boolean example: true description: Whether Syntage sends matching events to this endpoint WebhookEndpoint: type: object properties: "@id": type: string format: iri-reference description: Webhook endpoint IRI example: /webhook-endpoints/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: WebhookEndpoint id: $ref: "#/components/schemas/uuid" url: $ref: "#/components/schemas/WebhookEndpointUrl" signingSecret: type: string description: Secret used to verify `X-Syntage-Signature` delivery headers example: 54471a278d46c86ec6cd365983552a28 events: type: array example: - extraction.updated - invoice.created description: Event types delivered to this endpoint items: $ref: "#/components/schemas/WebhookEndpointEventType" enabled: default: true allOf: - $ref: "#/components/schemas/WebhookEndpointEnabled" contentType: default: application/ld+json anyOf: - $ref: "#/components/schemas/WebhookEndpointContentType" createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" WebhookEndpointCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/WebhookEndpoint "@id": default: /webhook-endpoints "hydra:member": items: $ref: "#/components/schemas/WebhookEndpoint" WebhookRequestUrl: type: string format: url description: Endpoint URL used for the delivery attempt example: https://example.com/webhooks/syntage WebhookRequestResponseStatusCode: type: integer description: HTTP status code returned by the endpoint, or `0` when Syntage did not receive a response example: 200 WebhookRequest: type: object properties: "@id": type: string format: iri-reference description: Webhook request IRI example: /webhook-requests/91106968-1abd-4d64-85c1-4e73d96fb997 "@type": type: string default: WebhookRequest id: $ref: "#/components/schemas/uuid" webhookEndpoint: description: Webhook endpoint that received the delivery attempt $ref: "#/components/schemas/WebhookEndpoint" url: $ref: "#/components/schemas/WebhookRequestUrl" responseStatusCode: $ref: "#/components/schemas/WebhookRequestResponseStatusCode" responseTime: type: number description: Delivery response time in seconds example: 0.21983 createdAt: $ref: "#/components/schemas/createdAt" updatedAt: $ref: "#/components/schemas/updatedAt" WebhookRequestCollection: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/WebhookRequest "@id": default: /webhook-requests "hydra:member": items: $ref: "#/components/schemas/WebhookRequest" responses: File: description: File resource response content: application/ld+json: schema: $ref: "#/components/schemas/File" TagInvoicesBatch: description: Result of a batch tag operation content: application/ld+json: schema: $ref: "#/components/schemas/TagInvoicesBatch" TagEntitiesBatch: description: Result of a batch entity tag operation content: application/ld+json: schema: $ref: "#/components/schemas/TagEntitiesBatch" UnprocessableEntity: description: Unprocessable Entity content: application/ld+json: schema: type: object properties: "@context": type: string default: /contexts/Error "@type": type: string default: hydra:Error hydra:title: type: string default: An error occurred hydra:description: type: string description: Concatenated violation messages example: "exampleField: Syntage score already exists." DatasourceMXSyntageScoreCalculate: description: Syntage Score calculation started Unauthorized: description: Unauthorized content: application/json: schema: type: object properties: message: type: string BadRequest: description: Bad Request content: application/json: schema: type: object properties: message: type: string NotFound: description: Not found content: application/json: schema: type: object properties: message: type: string Forbidden: description: Forbidden content: application/ld+json: schema: type: object properties: "@context": type: string default: /contexts/Error "@type": type: string default: hydra:Error hydra:title: type: string default: An error occurred hydra:description: type: string example: Access Denied. Accepted: description: The request has been accepted and there's no content to return. TooManyRequests: description: Too many requests headers: X-RateLimit-Limit: schema: type: integer description: Request limit defined for the time window. X-RateLimit-Remaining: schema: type: integer description: The number of requests left for the time window. X-RateLimit-Reset: schema: type: string format: date-time description: The UTC date/time at which the current rate limit window resets. content: application/json: schema: type: object properties: message: type: string DownloadFile: description: File content content: text/xml: schema: type: string example: ... application/pdf: schema: type: string format: binary example: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary example: application/json: schema: type: string example: - example: null application/zip: schema: type: string format: binary example: Export: description: Export resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/Export - $ref: "#/components/schemas/Export" ExportCollection: description: Export collection response content: application/ld+json: schema: $ref: "#/components/schemas/ExportCollection" InsightReport: description: Report resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/InsightReport - $ref: "#/components/schemas/InsightReport" InsightReportCollection: description: Report collection response content: application/ld+json: schema: $ref: "#/components/schemas/InsightReportCollection" ConstraintViolation: description: Validation error content: application/ld+json: schema: type: object properties: "@context": type: string default: /contexts/ConstraintViolation "@type": type: string default: ConstraintViolation hydra:title: type: string default: An error occurred hydra:description: type: string description: Concatenated violation messages example: "exampleField: This value should not be blank." violations: type: array items: type: object properties: propertyPath: type: string description: Property access path example: exampleField message: type: string description: Validaton error message example: This value should not be blank. code: type: [string, "null"] description: "Machine-readable code of the failed check in snake_case, such as `is_blank` or `no_such_choice`. `null` when the check has no code." example: is_blank AddEntityConstraintViolation: description: "Validation error. Syntage validates the request in three steps and stops at the first step that fails, returning every violation that step found, one entry in `violations` each. 1) The request fields: several can fail at once. 2) The entity name: `rfc_valid_no_name_on_file`, always returned alone. 3) The new entity: an RFC that already has an entity. The violations below depend on the data sent. A request that does not follow this endpoint's schema, such as one without `type`, returns other violations, with codes such as `is_blank` or `no_such_choice`." content: application/ld+json: schema: type: object properties: "@context": type: string default: /contexts/ConstraintViolation "@type": type: string default: ConstraintViolation hydra:title: type: string default: An error occurred hydra:description: type: string description: "Every violation as `field: message`, one per line" violations: type: array description: One entry per failed check. Pick a violation below to see its exact `propertyPath`, `message` and `code`. items: oneOf: - title: "Value has an invalid format" type: object description: "Fields: `rfc`, `identifiers[N].value`. The value is not a well-formed RFC or CURP." properties: propertyPath: type: string description: "One of `rfc`, `identifiers[N].value`. `N` is the item position, starting at 0." example: "rfc" message: type: string const: "This value is not valid." code: type: string const: "regex_failed" - title: "Value is too long" type: object description: "Fields: `rfc`, `identifiers[N].value`. RFCs have 12 or 13 characters." properties: propertyPath: type: string description: "One of `rfc`, `identifiers[N].value`. `N` is the item position, starting at 0." example: "rfc" message: type: string const: "This value is too long. It should have 13 characters or less." code: type: string const: "too_long" - title: "Value is too short" type: object description: "Fields: `identifiers[N].value`. RFC identifiers have 12 or 13 characters." properties: propertyPath: type: string description: "One of `identifiers[N].value`. `N` is the item position, starting at 0." example: "identifiers[0].value" message: type: string const: "This value is too short. It should have 12 characters or more." code: type: string const: "too_short" - title: "Value has the wrong length" type: object description: "Fields: `identifiers[N].value`. CURP identifiers have exactly 18 characters." properties: propertyPath: type: string description: "One of `identifiers[N].value`. `N` is the item position, starting at 0." example: "identifiers[0].value" message: type: string const: "This value should have exactly 18 characters." code: type: string const: "not_equal_length" - title: "Type contradicts the RFC" type: object description: "Fields: `type`. A 12-character RFC belongs to a company and a 13-character RFC to a person." properties: propertyPath: type: string description: "One of `type`. `N` is the item position, starting at 0." example: "type" message: type: string enum: - "The RFC belongs to a company, so the type must be \"company\"." - "The RFC belongs to a person, so the type must be \"person\"." code: type: string const: "type_contradicts_rfc" - title: "No legal name on file" type: object description: "Fields: `name`. Syntage has no legal name on file for the RFC. Retry with an explicit `name`." properties: propertyPath: type: string description: "One of `name`. `N` is the item position, starting at 0." example: "name" message: type: string const: "RFC is valid, but no legal name is available for this RFC. Send name explicitly to create the entity." code: type: string const: "rfc_valid_no_name_on_file" - title: "Entity already exists" type: object description: "Fields: `taxpayer`. The organization already has an entity with this RFC." properties: propertyPath: type: string description: "One of `taxpayer`. `N` is the item position, starting at 0." example: "taxpayer" message: type: string const: "The entity already exists." code: type: string const: "entity_already_exists" - title: "Other violation" type: object description: "A violation from a request that does not follow this endpoint's schema, such as a missing `type` (`is_blank`) or an unknown datasource (`no_such_choice`)." properties: propertyPath: type: string description: Property access path example: "datasources[0][name]" message: type: string description: Validation error message example: "The value you selected is not a valid choice." code: type: [string, "null"] description: "Machine-readable code of the failed check in snake_case. `null` when the check has no code." not: enum: [ "regex_failed", "too_long", "too_short", "not_equal_length", "type_contradicts_rfc", "rfc_valid_no_name_on_file", "entity_already_exists", ] example: "no_such_choice" examples: "Several request fields fail at once": summary: "Several request fields fail at once" value: "@context": /contexts/ConstraintViolation "@type": ConstraintViolation hydra:title: An error occurred hydra:description: "rfc: This value is not valid.\nidentifiers[0].value: This value should have exactly 18 characters." violations: - propertyPath: "rfc" message: "This value is not valid." code: "regex_failed" - propertyPath: "identifiers[0].value" message: "This value should have exactly 18 characters." code: "not_equal_length" "No legal name on file for the RFC": summary: "No legal name on file for the RFC" value: "@context": /contexts/ConstraintViolation "@type": ConstraintViolation hydra:title: An error occurred hydra:description: "name: RFC is valid, but no legal name is available for this RFC. Send name explicitly to create the entity." violations: - propertyPath: "name" message: "RFC is valid, but no legal name is available for this RFC. Send name explicitly to create the entity." code: "rfc_valid_no_name_on_file" "Type contradicts the RFC": summary: "Type contradicts the RFC" value: "@context": /contexts/ConstraintViolation "@type": ConstraintViolation hydra:title: An error occurred hydra:description: "type: The RFC belongs to a company, so the type must be \"company\"." violations: - propertyPath: "type" message: "The RFC belongs to a company, so the type must be \"company\"." code: "type_contradicts_rfc" "Entity already exists": summary: "Entity already exists" value: "@context": /contexts/ConstraintViolation "@type": ConstraintViolation hydra:title: An error occurred hydra:description: "taxpayer: The entity already exists." violations: - propertyPath: "taxpayer" message: "The entity already exists." code: "entity_already_exists" CredentialCollection: description: Credential collection response content: application/ld+json: schema: $ref: "#/components/schemas/CredentialCollection" Credential: description: Credential resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/Credential - $ref: "#/components/schemas/Credential" EventCollection: description: Event collection response content: application/ld+json: schema: $ref: "#/components/schemas/EventCollection" Tag: description: Tag resource response content: application/ld+json: schema: $ref: "#/components/schemas/Tag" TagCollection: description: Tag collection response content: application/ld+json: schema: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/Tag "@id": example: /tags "hydra:member": items: $ref: "#/components/schemas/Tag" EntityTag: description: Entity tag resource response content: application/ld+json: schema: $ref: "#/components/schemas/EntityTag" EntityTagCollection: description: Entity tag collection response content: application/ld+json: schema: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/LinkTag "@id": example: /entity-tags "hydra:member": items: $ref: "#/components/schemas/EntityTag" EntityIdentifier: description: Entity identifier resource response content: application/ld+json: schema: $ref: "#/components/schemas/EntityIdentifier" EntityIdentifierCollection: description: Entity identifier collection response content: application/ld+json: schema: $ref: "#/components/schemas/EntityIdentifierCollection" BilReport: description: BIL report resource response content: application/ld+json: schema: $ref: "#/components/schemas/BilReport" BilReportCollection: description: BIL report collection response content: application/ld+json: schema: $ref: "#/components/schemas/BilReportCollection" InfonavitOverdueCredit: description: Infonavit overdue credit resource response content: application/ld+json: schema: $ref: "#/components/schemas/InfonavitOverdueCredit" InfonavitOverdueCreditCollection: description: Infonavit overdue credit collection response content: application/ld+json: schema: $ref: "#/components/schemas/InfonavitOverdueCreditCollection" Event: description: Event resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/Event - $ref: "#/components/schemas/Event" ExtractionCollection: description: Extraction collection response content: application/ld+json: schema: $ref: "#/components/schemas/ExtractionCollection" Extraction: description: Extraction resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/Extraction - $ref: "#/components/schemas/Extraction" ElectronicAccountingRecord: description: Electronic Accounting Record resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/ElectronicAccountingRecord - $ref: "#/components/schemas/ElectronicAccountingRecord" DuplicateExtraction: description: | One or more requested extractions are already `pending` or `running` for the same entity, extractor, and options. The response lists the extractors whose equivalent extraction is already in progress; remove them before retrying the request. content: application/ld+json: schema: type: object required: - conflictingExtractors properties: conflictingExtractors: type: array description: Extractors whose equivalent extraction is already in progress. minItems: 1 uniqueItems: true items: $ref: "#/components/schemas/ExtractionExtractor" Invoice: description: Invoice resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/Invoice - $ref: "#/components/schemas/Invoice" InvoiceCollectionItem: description: Invoice resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/Invoice - $ref: "#/components/schemas/InvoiceCollectionItem" InvoiceCFDI: description: Invoice CFDI response content: application/json: schema: type: object example: Version: 3.3 Serie: FA Folio: 6787763004 Fecha: "2019-01-03T21:10:40" Sello: pd77md8+...wiMlMQ== FormaPago: "04" NoCertificado: 1000000502192402 Certificado: MIIGTDCC...rOSkAn8= CondicionesDePago: Tarjeta de Credito SubTotal: 45905 Descuento: 0 Moneda: MXN Total: 53249.8 TipoDeComprobante: I MetodoPago: PUE LugarExpedicion: "01210" Emisor: Rfc: AOM920820BEA Nombre: APPLE OPERATIONS MEXICO S.A. DE C.V. RegimenFiscal: 601 Receptor: Rfc: PEIC211118IS0 Nombre: Pedro Infante Cruz UsoCFDI: G03 Conceptos: Concepto: - ClaveProdServ: 43211503 NoIdentificacion: Z0V0 Cantidad: 1 ClaveUnidad: H87 Unidad: "06" Descripcion: MBP 15.4 SPACE GRAY ValorUnitario: 45905 Importe: 45905 Descuento: 0 Impuestos: Traslados: Traslado: Base: 45905 Impuesto: "002" TipoFactor: Tasa TasaOCuota: 0.16 Importe: 7344.8 InformacionAduanera: NumeroPedimento: 19 47 1692 9000010 Impuestos: TotalImpuestosTrasladados: 7344.8 Traslados: Traslado: Impuesto: "002" TipoFactor: Tasa TasaOCuota: 0.16 Importe: 7344.8 Complemento: TimbreFiscalDigital: Version: 1.1 UUID: e0a24894-7fbf-48ae-bfb0-efaae30a6319 RfcProvCertif: SAT970701NN3 FechaTimbrado: "2019-01-03T23:10:40" SelloCFD: pd77md8+...wiMlMQ== NoCertificadoSAT: 1000000514965721 SelloSAT: R9TebKU2...q7lDgA== text/xml: schema: type: string format: xml example: ... example: | application/pdf: schema: type: string format: binary example: InvoicePaymentCollection: description: Invoice payment collection response content: application/ld+json: schema: $ref: "#/components/schemas/InvoicePaymentCollection" InvoiceCreditNoteCollection: description: Invoice credit notes collection response content: application/ld+json: schema: $ref: "#/components/schemas/InvoiceCreditNoteCollection" RpcEntidade: description: RPC entidade resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/RpcEntidade - $ref: "#/components/schemas/RpcEntidade" RpcActo: description: RPC acto resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/RpcActo - $ref: "#/components/schemas/RpcActo" RpcSocio: description: RPC socio resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/RpcSocio - $ref: "#/components/schemas/RpcSocio" RugOperacion: description: RUG operación resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/RugOperacion - $ref: "#/components/schemas/RugOperacionFull" RugGarantia: description: RUG garantia resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/RugGarantia - $ref: "#/components/schemas/RugGarantia" SchedulerRule: description: Scheduler rule resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/SchedulerRule - $ref: "#/components/schemas/SchedulerRule" Scheduler: description: Scheduler resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/Scheduler - $ref: "#/components/schemas/Scheduler" SchedulerCollection: description: Scheduler collection response content: application/ld+json: schema: $ref: "#/components/schemas/SchedulerCollection" InvoicePayment: description: Invoice payment resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/InvoicePayment - $ref: "#/components/schemas/InvoicePayment" InvoiceCreditNote: description: Invoice credit note resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/InvoiceCreditNote - $ref: "#/components/schemas/InvoiceCreditNote" InvoiceBatchPaymentCollection: description: Invoice batch payment collection response content: application/ld+json: schema: $ref: "#/components/schemas/InvoiceBatchPaymentCollection" InvoiceBatchPayment: description: Invoice batch payment resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/InvoiceBatchPayment - $ref: "#/components/schemas/InvoiceBatchPayment" TaxRetention: description: Tax retention resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/TaxRetention - $ref: "#/components/schemas/TaxRetention" TaxRetentionCFDI: description: Tax retention CFDI response content: application/json: schema: type: object example: Version: 1 Folio: 6787763004 Sello: pd77md8+...wiMlMQ== NumCert: 1000000502192402 Cert: MIIGTDCC...rOSkAn8= FechaExp: "2019-01-03T21:10:40" CveRetenc: "26" Emisor: RFCEmisor: AOM920820BEA NomDenRazSocE: APPLE OPERATIONS MEXICO S.A. DE C.V. Receptor: Nacionalidad: Nacional Nacional: RFCRecep: PEIC211118IS0 NomDenRazSocR: Pedro Infante Cruz Periodo: MesIni: 4 MesFin: 4 Ejerc: 2020 Totales: MontoTotOperacion: 59.78 MontoTotGrav: 59.78 MontoTotExent: 0 MontoTotRet: 6.56 ImpRetenidos: - BaseRet": 59.78 Impuesto": "02" MontoRet": 4.77 TipoPagoRet": Pago definitivo - BaseRet": 59.78 Impuesto": "01" MontoRet": 1.79 TipoPagoRet": Pago definitivo Complemento: TimbreFiscalDigital: Version: 1 UUID: e0a24894-7fbf-48ae-bfb0-efaae30a6319 FechaTimbrado: "2019-01-03T23:10:40" SelloCFD: pd77md8+...wiMlMQ== NoCertificadoSAT: 1000000514965721 SelloSAT: R9TebKU2...q7lDgA== text/xml: schema: type: string format: xml example: ... example: | application/pdf: schema: type: string format: binary example: TaxpayerTaxRetentionCollection: description: Taxpayer tax retention collection response content: application/ld+json: schema: $ref: "#/components/schemas/TaxpayerTaxRetentionCollection" EntityCollection: description: Entity collection response content: application/ld+json: schema: $ref: "#/components/schemas/EntityCollection" Entity: description: Entity resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/Entity - $ref: "#/components/schemas/Entity" IssuedInvoiceCollection: description: Invoice collection response content: application/ld+json: schema: $ref: "#/components/schemas/InvoiceCollection" TaxReturn: description: Tax return resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/TaxReturn - $ref: "#/components/schemas/TaxReturn" TaxComplianceCheck: description: Tax compliance check resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/TaxComplianceCheck - $ref: "#/components/schemas/TaxComplianceCheck" TaxReturnData: description: Extracted data from tax returns content: application/json: schema: type: object examples: financial_statements_2022: summary: Financial statements 2022 format value: ESTADO DE RESULTADOS: Pérdida neta: Notas: This field may contains a comment from the respective line Total: 123 Partes Relacionadas: Partes No Relacionadas: Utilidad neta: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Ingresos Netos: Notas: Total: 123 Sin Ingresos: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Otros Ingresos: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Primas cedidas: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Primas emitidas: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Partes Relacionadas: 0 Gastos por intereses: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Ingresos por intereses: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Partes No Relacionadas: 123 Ventas y/o servicios nacionales: Notas: Total: 123 Partes Relacionadas: 0 Partes No Relacionadas: 123 Ventas y/o servicios extranjeros: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Estimación preventiva para riesgos crediticios: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Devoluciones, descuentos y bonificaciones nacionales: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Devoluciones, descuentos y bonificaciones extranjeras: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Estimación preventiva para riesgos crediticios (Recuperaciones): Notas: Total: Partes Relacionadas: Partes No Relacionadas: Pérdida Bruta: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Utilidad Bruta: Notas: Total: 123 Partes Relacionadas: Partes No Relacionadas: Costo de ventas: Notas: Total: 123 Maquilas: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Otros costos: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Gastos Indirectos: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Partes Relacionadas: 0 Sin Costo de ventas: Notas: Total: 0 Partes Relacionadas: 0 Partes No Relacionadas: 0 Partes No Relacionadas: 123 Deducciones de inversiones: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Mano de obra directa de fabricación: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Gastos relacionados a la mano de obra: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Mano de obra indirecta de fabricación: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Costo de servicios: Notas: Total: 0 Costo de servicios: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Partes Relacionadas: 0 Partes No Relacionadas: 0 Sin Costo de servicios: Notas: Total: 0 Partes Relacionadas: 0 Partes No Relacionadas: 0 Costo neto de adquisición: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Comisiones y tarifas pagadas: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Comisiones y tarifas cobradas: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Otros ingresos (egresos) de la operación: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Incremento neto de otras reservas técnicas: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Costo neto de siniestralidad, reclamaciones y otras obligaciones pendientes de cumplir: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Incremento neto de las reservas técnicas (Riesgos en curso, obligaciones pendientes de cumplir, riesgos catastróficos): Notas: Total: Partes Relacionadas: Partes No Relacionadas: Gastos de operación: Notas: Total: 123 Gastos de venta: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Gastos generales: Notas: Total: 123 Partes Relacionadas: 0 Partes No Relacionadas: 123 Partes Relacionadas: 0 Partes No Relacionadas: 123 Sin Gastos de operación: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Gastos de administración: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Pérdida de operación: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Utilidad de operación: Notas: Total: 123 Partes Relacionadas: Partes No Relacionadas: Impuestos a la utilidad: Notas: Total: 0 Partes Relacionadas: 0 Partes No Relacionadas: 0 Impuesto sobre la renta: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Sin Impuestos a la utilidad: Notas: Total: 0 Partes Relacionadas: 0 Partes No Relacionadas: 0 Impuesto sobre la renta diferido: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Operaciones discontinuadas: Notas: Total: 0 Partes Relacionadas: 0 Partes No Relacionadas: 0 Operaciones discontinuadas: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Sin Operaciones discontinuadas: Notas: Total: 0 Partes Relacionadas: 0 Partes No Relacionadas: 0 Pérdida de enajenación de acciones: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Utilidad de enajenación de acciones: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Participación de los Trabajadores en las Utilidades: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Pérdida de segmento del negocio o segmento geográfico: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Utilidad de segmento del negocio o segmento geográfico: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Participación en asociadas: Notas: Total: 0 Partes Relacionadas: 0 Partes No Relacionadas: 0 Sin Participación en asociadas: Notas: Total: 0 Partes Relacionadas: 0 Partes No Relacionadas: 0 Pérdida neta por participación en los resultados de subsidiarias no consolidadas, asociadas y negocios conjuntos: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Utilidad neta por participación en los resultados de subsidiarias no consolidadas, asociadas y negocios conjuntos: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Pérdida de operaciones continuas: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Utilidad de operaciones continuas: Notas: Total: 123 Partes Relacionadas: Partes No Relacionadas: Resultado Integral de Financiamiento: Notas: Total: 0 Ganancia cambiaria: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Gastos Financieros: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Pérdida cambiaria: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Partes Relacionadas: 0 Productos Financieros: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Partes No Relacionadas: 0 Intereses devengados a cargo nacionales: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Intereses devengados a favor nacionales: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Intereses moratorios a cargo nacionales: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Intereses moratorios a favor nacionales: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Sin Resultado Integral de Financiamiento: Notas: Total: 0 Partes Relacionadas: 0 Partes No Relacionadas: 0 Intereses devengados a cargo del extranjero: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Intereses devengados a favor del extranjero: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Intereses moratorios a cargo del extranjero: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Intereses moratorios a favor del extranjero: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Resultado por posición monetaria favorable: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Resultado por posición monetaria desfavorable: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Cambios en el valor razonable de activos y pasivos financieros deudor: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Cambios en el valor razonable de activos y pasivos financieros acreedor: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Pérdida antes de Impuestos a la utilidad: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Utilidad antes de Impuestos a la utilidad: Notas: Total: 123 Partes Relacionadas: Partes No Relacionadas: Total de materiales utilizados o comercializados: Notas: Total: 123 Inventario Final: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Inventario Inicial: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Partes Relacionadas: 0 Partes No Relacionadas: 123 Compras netas nacionales: Notas: Total: 123 Partes Relacionadas: 0 Partes No Relacionadas: 123 Compras netas extranjeras: Notas: Total: Partes Relacionadas: Partes No Relacionadas: Sin materiales utilizados o comercializados: Notas: Total: Partes Relacionadas: Partes No Relacionadas: PFAE - ESTADO DE RESULTADOS: [] PFAE - ESTADO DE POSICIÓN FINANCIERA: [] ESTADO DE POSICIÓN FINANCIERA (BALANCE): ACTIVO: TOTAL DE ACTIVO: Notas: Total: 123 ACTIVO A CORTO PLAZO: Clientes: Notas: Total: 0 Sin Clientes: Notas: Total: Cartera de crédito vencida: Notas: Total: Cartera de crédito vigente: Notas: Total: Derechos de cobro adquiridos (neto): Notas: Total: Clientes nacionales partes relacionadas: Notas: Total: Clientes extranjeros partes relacionadas: Notas: Total: Clientes nacionales partes no relacionadas: Notas: Total: 0 Clientes extranjeros partes no relacionadas: Notas: Total: Estimación preventiva para riesgos crediticios: Notas: Total: Cartera de crédito con riesgo de crédito etapa 1: Notas: Total: Cartera de crédito con riesgo de crédito etapa 2: Notas: Total: Cartera de crédito con riesgo de crédito etapa 3: Notas: Total: Inventarios: Notas: Total: 0 Sin Inventarios: Notas: Total: 0 Bienes adjudicados: Notas: Total: Productos terminados: Notas: Total: Producción en proceso: Notas: Total: Pérdida por deterioro: Notas: Total: Mercancías en tránsito: Notas: Total: Estimación de obsolescencia: Notas: Total: Materiales y materias primas: Notas: Total: Estimación de bienes adjudicados: Notas: Total: Deudores diversos: Notas: Total: 123 Sin Deudores diversos: Notas: Total: Deudores por primas nacionales: Notas: Total: Deudores por primas del extranjero: Notas: Total: Deudores diversos partes relacionadas nacionales: Notas: Total: Deudores diversos partes no relacionadas nacionales: Notas: Total: 123 Deudores diversos partes relacionadas del extranjero: Notas: Total: Deudores diversos partes no relacionadas del extranjero: Notas: Total: Pagos anticipados: Notas: Total: 0 Pagos anticipados: Notas: Total: Sin Pagos anticipados: Notas: Total: 0 Depósitos en garantía: Notas: Total: Rentas pagadas por anticipado: Notas: Total: Impuestos pagados por anticipado: Notas: Total: Seguros y fianzas pagados por anticipado: Notas: Total: Anticipo a proveedores nacionales partes relacionadas: Notas: Total: Anticipo a proveedores extranjeros partes relacionadas: Notas: Total: Anticipo a proveedores nacionales partes no relacionadas: Notas: Total: Anticipo a proveedores extranjeros partes no relacionadas: Notas: Total: Impuesto por recuperar: Notas: Total: 123 Otros activos a corto plazo: Notas: Total: Total de Activo a corto plazo: Notas: Total: 123 Activos disponibles para venta: Notas: Total: 0 Cuentas y documentos por cobrar: Notas: Total: 0 Deudores por reporto: Notas: Total: Préstamo de valores: Notas: Total: Instrumentos Financieros Derivados: Notas: Total: Sin Cuentas y documentos por cobrar: Notas: Total: Cuentas y documentos por cobrar a partes relacionadas nacionales: Notas: Total: Cuentas y documentos por cobrar a partes no relacionadas nacionales: Notas: Total: 0 Cuentas y documentos por cobrar a partes relacionadas del extranjero: Notas: Total: Cuentas y documentos por cobrar a partes no relacionadas del extranjero: Notas: Total: Estimación de cuentas incobrables: Notas: Total: 0 Efectivo y equivalentes de efectivo: Notas: Total: 123 Cuentas de margen: Notas: Total: Sin Efectivo y equivalentes de efectivo: Notas: Total: Efectivo y equivalentes de efectivo nacionales: Notas: Total: 123 Efectivo y equivalentes de efectivo del extranjero: Notas: Total: Efectivo y equivalentes de efectivo, restringido nacionales: Notas: Total: Efectivo y equivalentes de efectivo, restringido del extranjero: Notas: Total: Instrumentos financieros de negociación: Notas: Total: 0 Sin Inversiones en valores con Instituciones: Notas: Total: 0 Inversiones permanentes en acciones nacionales: Notas: Total: Inversiones permanentes en acciones del extranjero: Notas: Total: Inversiones en instrumentos financieros negociables: Notas: Total: Inversiones en valores con Instituciones nacionales: Notas: Total: Inversiones en valores con Instituciones extranjeras: Notas: Total: Inversiones en instrumentos financieros para cobrar o vender: Notas: Total: ACTIVO A LARGO PLAZO: Crédito mercantil: Notas: Total: 0 Activos intangibles: Notas: Total: 0 Activos intangibles: Notas: Total: Sin Activos intangibles: Notas: Total: 0 Derechos de usufructo adquirido en el ejercicio: Notas: Total: Anticipo a proveedores: Notas: Total: 0 Pagos anticipados: Notas: Total: Depósitos en garantía: Notas: Total: Sin Anticipo a proveedores: Notas: Total: 0 Impuestos pagados por anticipado: Notas: Total: Seguros y fianzas pagados por anticipado: Notas: Total: Anticipo a proveedores nacionales a largo plazo (partes relacionadas): Notas: Total: Anticipo a proveedores extranjeros a largo plazo (partes relacionadas): Notas: Total: Anticipo a proveedores nacionales a largo plazo (partes no relacionadas): Notas: Total: Anticipo a proveedores extranjeros a largo plazo (partes no relacionadas): Notas: Total: Inversiones en asociadas: Notas: Total: 0 Otros activos a largo plazo: Notas: Total: Propiedades, plantas y equipo: Notas: Total: 0 Terrenos: Notas: Total: Maquinaria: Notas: Total: Construcciones: Notas: Total: Equipo de Computo: Notas: Total: Mobiliario y Equipo: Notas: Total: Equipo de Transporte: Notas: Total: Depreciación de maquinaria: Notas: Total: Mejoras a inmuebles arrendados: Notas: Total: Depreciación de construcciones: Notas: Total: Sin Propiedades, plantas y equipo: Notas: Total: 0 Depreciación de equipo de computo: Notas: Total: Depreciación de mobiliario y equipo: Notas: Total: Depreciación de equipo de transporte: Notas: Total: Total de Activo a largo plazo: Notas: Total: 0 Cuentas y documentos por cobrar a largo plazo: Notas: Total: 0 Sin Cuentas y documentos por cobrar a largo plazo: Notas: Total: 0 Cuentas y documentos por cobrar a largo plazo de partes relacionadas nacionales: Notas: Total: Cuentas y documentos por cobrar a largo plazo de partes relacionadas extranjeras: Notas: Total: Cuentas y documentos por cobrar a largo plazo de partes no relacionadas nacionales: Notas: Total: Cuentas y documentos por cobrar a largo plazo de partes no relacionadas extranjeras: Notas: Total: Instrumentos financieros por cobrar a largo plazo: Notas: Total: 0 PASIVO: TOTAL DE PASIVO: Notas: Total: 123 PASIVO A CORTO PLAZO: Proveedores: Notas: Total: 0 Sin Proveedores: Notas: Total: 0 Proveedores nacionales partes relacionadas: Notas: Total: Proveedores nacionales partes no relacionadas: Notas: Total: Proveedores del extranjero partes relacionadas: Notas: Total: Proveedores del extranjero partes no relacionadas: Notas: Total: Provisiones: Notas: Total: 0 Acreedores diversos: Notas: Total: 123 Préstamo de valores: Notas: Total: Acreedores por reporto: Notas: Total: Sin Acreedores diversos: Notas: Total: Pasivo por arrendamiento: Notas: Total: Reaseguradores y reafianzadores: Notas: Total: Acreedores por cuentas de margen: Notas: Total: Impuestos a la utilidad por pagar: Notas: Total: 0 Colaterales vendidos o dados en garantía: Notas: Total: Acreedores por liquidación de operaciones: Notas: Total: Obligaciones en operaciones de bursatilización: Notas: Total: Acreedores por colaterales recibidos en efectivo: Notas: Total: Acreedores diversos nacionales partes relacionadas: Notas: Total: Acreedores diversos nacionales partes no relacionadas: Notas: Total: 123 Acreedores diversos del extranjero partes relacionadas: Notas: Total: Activos por derecho de uso derivados de arrendamientos: Notas: Total: Acreedores diversos del extranjero partes no relacionadas: Notas: Total: Impuestos por pagar: Notas: Total: 123 ISR diferido: Notas: Total: PTU por pagar: Notas: Total: Impuestos por pagar: Notas: Total: Impuestos retenidos: Notas: Total: 123 Sin Impuestos por pagar: Notas: Total: Otros pasivos a corto plazo: Notas: Total: Impuestos trasladados cobrados: Notas: Total: Impuestos trasladados por cobrar: Notas: Total: 0 Anticipo de clientes: Notas: Total: 0 Sin Anticipo de clientes: Notas: Total: Anticipos de clientes partes relacionadas nacionales: Notas: Total: Anticipos de clientes partes no relacionadas nacionales: Notas: Total: 0 Anticipos de clientes partes relacionadas del extranjero: Notas: Total: Anticipos de clientes partes no relacionadas del extranjero: Notas: Total: Préstamos bancarios: Notas: Total: 0 Instrumentos financieros: Notas: Total: 0 Sin Instrumentos financieros: Notas: Total: 0 Instrumentos financieros nacionales partes relacionadas: Notas: Total: Instrumentos financieros derivados con fines de cobertura: Notas: Total: Ajustes de valuación por cobertura de pasivos financieros: Notas: Total: Instrumentos financieros nacionales partes no relacionadas: Notas: Total: Instrumentos financieros del extranjero partes relacionadas: Notas: Total: Instrumentos financieros derivados con fines de negociación: Notas: Total: Instrumentos financieros del extranjero partes no relacionadas: Notas: Total: Total de Pasivo a corto plazo: Notas: Total: 123 Cuentas y documentos por pagar: Notas: Total: 0 Captación tradicional: Notas: Total: Otras reservas técnicas: Notas: Total: Sin Cuentas y documentos por pagar: Notas: Total: 0 Préstamos interbancarios y de otros organismos: Notas: Total: Cuentas y documentos por pagar a partes relacionadas nacionales: Notas: Total: Cuentas y documentos por pagar a partes no relacionadas nacionales: Notas: Total: Cuentas y documentos por pagar a partes relacionadas del extranjero: Notas: Total: Cuentas y documentos por pagar a partes no relacionadas del extranjero: Notas: Total: Reservas técnicas (Riesgos en curso, obligaciones pendientes de cumplir, riesgos catastróficos): Notas: Total: PASIVO A LARGO PLAZO: Beneficio a empleados: Notas: Total: 0 Provisiones a largo plazo: Notas: Total: 0 Otros pasivos a largo plazo: Notas: Total: Total de Pasivo a largo plazo: Notas: Total: 0 Rentas cobradas por anticipado: Notas: Total: 0 Instrumentos financieros a largo plazo: Notas: Total: 0 Sin Instrumentos financieros a largo plazo: Notas: Total: 0 Instrumentos financieros a largo plazo nacionales de partes relacionadas: Notas: Total: Instrumentos financieros a largo plazo nacionales de partes no relacionadas: Notas: Total: Instrumentos financieros a largo plazo del extranjero de partes relacionadas: Notas: Total: Instrumentos financieros a largo plazo del extranjero de partes no relacionadas: Notas: Total: Impuesto a la utilidad diferido por pagar: Notas: Total: 0 Cuentas y documentos por pagar a largo plazo: Notas: Total: 0 Sin Cuentas y documentos por pagar a largo plazo: Notas: Total: 0 Cuentas y documentos por pagar a largo plazo de partes relacionadas nacionales: Notas: Total: Cuentas y documentos por pagar a largo plazo de partes no relacionadas nacionales: Notas: Total: Cuentas y documentos por pagar a largo plazo de partes relacionadas del extranjero: Notas: Total: Cuentas y documentos por pagar a largo plazo de partes no relacionadas del extranjero: Notas: Total: Aportaciones para futuros aumentos de capital: Notas: Total: 0 CAPITAL: CAPITAL CONTABLE: Capital Social: Notas: Total: 123 Reserva Legal: Notas: Total: Sin Capital social: Notas: Total: Reservas de capital: Notas: Total: Prima en venta de acciones: Notas: Total: Capital social (aportaciones): Notas: Total: 123 Capital social (capitalización): Notas: Total: Actualización del capital contable: Notas: Total: Exceso en la actualización del capital: Notas: Total: Aportaciones para futuros aumentos de capital: Notas: Total: Insuficiencia en la actualización del capital: Notas: Total: Utilidades acumuladas: Notas: Total: -123 Pérdida neta: Notas: Total: 0 Utilidad neta: Notas: Total: 123 Pérdidas acumuladas: Notas: Total: -123 Utilidades acumuladas: Notas: Total: 123 Sin Utilidades acumuladas: Notas: Total: Otros resultados integrales: Notas: Total: 0 Participación controladora: Notas: Total: -123 Participación no controladora: Notas: Total: 0 TOTAL DE CAPITAL CONTABLE: Notas: Total: -123 TOTAL DE PASIVO Y CAPITAL CONTABLE: Notas: Total: 123 financial_statements_2014: summary: Financial statements 2014 format value: ESTADO DE RESULTADOS: VENTAS Y/O SERVICIOS NACIONALES: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 25447832 TOTAL: 25447832 VENTAS Y/O SERVICIOS EXTRANJEROS: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 12340 TOTAL: 12340 DEVOLUCIONES, DESCUENTOS Y BONIFICACIONES SOBRE VENTAS NACIONALES: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 DEVOLUCIONES, DESCUENTOS Y BONIFICACIONES SOBRE VENTAS AL EXTRANJERO: PARTES RELACIONADAS: 0 PARTES NO RELACIONADAS: 0 TOTAL: 0 INGRESOS NETOS: PARTES RELACIONADAS: 0 PARTES NO RELACIONADAS: 17447933 TOTAL: 17447933 INVENTARIO INICIAL: null COMPRAS NETAS NACIONALES: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 5100423 TOTAL: 5100423 COMPRAS NETAS DE IMPORTACIÓN: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 1124038 TOTAL: 1124038 INVENTARIO FINAL: null COSTO DE LAS MERCANCÍAS: 6024467 MANO DE OBRA: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 MAQUILAS: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 GASTOS INDIRECTOS DE FABRICACIÓN: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 COSTO DE VENTAS Y/O SERVICIOS: PARTES RELACIONADAS: 6024467 PARTES NO RELACIONADAS: 0 TOTAL: 6024467 UTILIDAD BRUTA: 9423466 PÉRDIDA BRUTA: 0 GASTOS DE OPERACIÓN: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 8155730 TOTAL: 8155730 UTILIDAD DE OPERACIÓN: 267734 PÉRDIDA DE OPERACIÓN: null INTERESES DEVENGADOS A FAVOR NACIONALES: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 INTERESES DEVENGADOS A FAVOR DEL EXTRANJERO: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 INTERESES MORATORIOS A FAVOR NACIONALES: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 INTERESES MORATORIOS A FAVOR DEL EXTRANJERO: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 GANANCIA CAMBIARIA: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 INTERESES DEVENGADOS A CARGO NACIONALES: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 INTERESES DEVENGADOS A CARGO DEL EXTRANJERO: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 INTERESES MORATORIOS A CARGO NACIONALES: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 INTERESES MORATORIOS A CARGO DEL EXTRANJERO: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 PÉRDIDA CAMBIARIA: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 RESULTADO POR POSICIÓN MONETARIA FAVORABLE: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: null TOTAL: null RESULTADO POR POSICIÓN MONETARIA DESFAVORABLE: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: null TOTAL: null OTRAS OPERACIONES FINANCIERAS NACIONALES: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 OTRAS OPERACIONES FINANCIERAS EXTRANJERAS: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 OTRAS OPERACIONES FINANCIERAS: 0 RESULTADO INTEGRAL DE FINANCIAMIENTO: 0 OTROS GASTOS NACIONALES: 125381 OTROS GASTOS EXTRANJEROS: null OTROS GASTOS: 125381 OTROS PRODUCTOS NACIONALES: 0 OTROS PRODUCTOS EXTRANJEROS: 0 OTROS PRODUCTOS: 0 INGRESOS POR PARTIDAS DISCONTINUAS Y EXTRAORDINARIAS: null GASTOS POR PARTIDAS DISCONTINUAS Y EXTRAORDINARIAS: null UTILIDAD ANTES DE IMPUESTOS: 82354 PÉRDIDA ANTES DE IMPUESTOS: null ISR: null IETU: null IMPAC: null PTU: null UTILIDAD EN PARTICIPACIÓN SUBSIDIARIA: null PÉRDIDA EN PARTICIPACIÓN SUBSIDIARIA: null EFECTOS DE REEXPRESIÓN FAVORABLES EXCEPTO RESULTADO POR POSICIÓN MONETARIA: null EFECTOS DE REEXPRESIÓN DESFAVORABLES EXCEPTO RESULTADO POR POSICIÓN MONETARIA: null UTILIDAD NETA: 52355 PÉRDIDA NETA: null ESTADO DE POSICIÓN FINANCIERA (BALANCE): ACTIVOS: EFECTIVO EN CAJA Y DEPÓSITOS EN INSTITUCIONES DE CRÉDITO NACIONALES: 115202 EFECTIVO EN CAJA Y DEPÓSITOS EN INSTITUCIONES DE CRÉDITO DEL EXTRANJERO: null INVERSIONES EN VALORES CON INSTITUCIONES NACIONALES (EXCEPTO ACCIONES): null INVERSIONES EN VALORES CON INSTITUCIONES EXTRANJERAS (EXCEPTO ACCIONES): null CUENTAS Y DOCUMENTOS POR COBRAR NACIONALES: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 230000 TOTAL: 230000 CUENTAS Y DOCUMENTOS POR COBRAR DEL EXTRANJERO: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 CONTRIBUCIONES A FAVOR: 43212 INVENTARIOS: 0 OTROS ACTIVOS CIRCULANTES: 5728 INVERSIONES EN ACCIONES NACIONALES: null INVERSIONES EN ACCIONES DEL EXTRANJERO: 0 INVERSIONES EN ACCIONES (TOTAL): 0 TERRENOS: null CONSTRUCCIONES: null CONSTRUCCIONES EN PROCESO: null MAQUINARIA Y EQUIPO: null MOBILIARIO Y EQUIPO DE OFICINA: null EQUIPO DE CÓMPUTO: null EQUIPO DE TRANSPORTE: null OTROS ACTIVOS FIJOS: null DEPRECIACIÓN ACUMULADA: null CARGOS Y GASTOS DIFERIDOS: null AMORTIZACIÓN ACUMULADA: null SUMA ACTIVOS: 493142 PASIVOS: CUENTAS Y DOCUMENTOS POR PAGAR NACIONALES: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 976911 TOTAL: 976911 CUENTAS Y DOCUMENTOS POR PAGAR DEL EXTRANJERO: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 CONTRIBUCIONES POR PAGAR: 10474 ANTICIPOS DE CLIENTES: PARTES RELACIONADAS: null PARTES NO RELACIONADAS: 0 TOTAL: 0 APORTACIONES PARA FUTUROS AUMENTOS DE CAPITAL: null OTROS PASIVOS: null SUMA PASIVOS: 987385 CAPITAL CONTABLE: CAPITAL SOCIAL PROVENIENTE DE APORTACIONES: 100000 CAPITAL SOCIAL PROVENIENTE DE CAPITALIZACIÓN: null RESERVAS: null OTRAS CUENTAS DE CAPITAL: null APORTACIONES PARA FUTUROS AUMENTOS DE CAPITAL: null UTILIDADES ACUMULADAS: 1399808 UTILIDAD DEL EJERCICIO: 62355 PÉRDIDAS ACUMULADAS: -2456702 PÉRDIDA DEL EJERCICIO: null EXCESO EN LA ACTUALIZACIÓN DEL CAPITAL: null INSUFICIENCIA EN LA ACTUALIZACIÓN DEL CAPITAL: 0 ACTUALIZACIÓN DEL CAPITAL CONTABLE: null SUMA CAPITAL CONTABLE: -694233 SUMA PASIVO MÁS CAPITAL CONTABLE: 493132 provisional_variables: summary: Provisional variables value: variables: sales_revenue: 1234567.89 cash_inflow: 987654.32 cash_outflow: 654321.10 number_of_employees: 15 payroll_amount: 234567.89 TaxStatus: description: Tax status resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/TaxStatus - $ref: "#/components/schemas/TaxStatus" TaxpayerInvoiceCollection: description: Taxpayer invoice collection response content: application/ld+json: schema: $ref: "#/components/schemas/InvoiceCollection" TaxpayerTaxReturnCollection: description: Taxpayer tax return collection response content: application/ld+json: schema: $ref: "#/components/schemas/TaxpayerTaxReturnCollection" TaxpayerTaxComplianceCheckCollection: description: Taxpayer tax compliance check collection response content: application/ld+json: schema: $ref: "#/components/schemas/TaxpayerTaxComplianceCheckCollection" TaxpayerTaxStatusCollection: description: Taxpayer tax status collection response content: application/ld+json: schema: $ref: "#/components/schemas/TaxpayerTaxStatusCollection" TaxpayerElectronicAccountingRecordCollection: description: Electronic accounting record collection response content: application/ld+json: schema: $ref: "#/components/schemas/TaxpayerElectronicAccountingRecordCollection" TaxpayerRpcEntidadeCollection: description: RPC entidades collection response content: application/ld+json: schema: $ref: "#/components/schemas/TaxpayerRpcEntidadeCollection" EntityRpcActoCollection: description: RPC actos collection response content: application/ld+json: schema: $ref: "#/components/schemas/EntityRpcActoCollection" TaxpayerRugOperacionCollection: description: RUG operación collection response content: application/ld+json: schema: $ref: "#/components/schemas/TaxpayerRugOperacionCollection" TaxpayerRugGarantiaCollection: description: RUG garantia collection response content: application/ld+json: schema: $ref: "#/components/schemas/TaxpayerRugGarantiaCollection" CashFlowInsight: description: Entity cash flow content: application/ld+json: schema: type: object properties: data: description: Cash flow data grouped by period and dimension type: array items: type: object properties: type: description: Used to identify the flow enum: - inflow - outflow type: string example: inflow date: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. deprecated: true type: string example: "202408" dateLabel: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. Human-readable label for the period. deprecated: true type: string example: 2024/Aug startDate: description: The start date of the period in `YYYY-MM-DD` format. type: string format: date example: "2024-08-01" transactions: description: Number of invoices processed to get this record type: integer example: 6 amount: description: Total amount in the original currency type: number example: 5938.88 mxnAmount: description: | **Deprecated.** Use `metric` instead. Amount converted to `MXN` using the exchange rate at the time the invoice was issued. Always non-negative. deprecated: true type: number example: 114638.76 metric: description: Signed MXN amount. Positive for inflows, negative for outflows. type: number example: 114638.76 dimension: description: | The dimension value for the selected `options[type]` grouping. | `options[type]` | `dimension` values | | --- | --- | | `total` | `"total"` | | `currency` | ISO 4217 code — e.g. `MXN`, `USD`, `EUR` | | `payment-method` | `" ()"` — e.g. `"Efectivo (01)"`, `"Transferencia electrónica de fondos (03)"`. Falls back to the raw numeric code when no mapping exists. | | `invoice-type` | `" ()"` — e.g. `"Ingreso (I)"`, `"Egreso (E)"`, `"Pago (P)"`, `"Traslado (T)"`, `"Nómina (N)"`. | Additionally, `"unknown"` appears for any `options[type]` whenever the underlying value was `NULL` in the database. type: string example: total label: description: Human-readable display label for the row's dimension. Same value as `dimension`. type: string example: total groupName: description: | **Deprecated.** Use `dimension` instead. Same value as `dimension`. deprecated: true type: string example: total stats: description: Data quality statistics per period, indicating how many invoices had the required fields for accurate calculation. type: array items: type: object properties: total: description: Total number of invoices in this period type: integer example: 50 hits: description: Number of invoices with sufficient data for accurate calculation type: integer example: 48 date: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. deprecated: true type: string example: "202408" dateLabel: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. Human-readable label for the period. deprecated: true type: string example: 2024/Aug startDate: description: The start date of the period in `YYYY-MM-DD` format type: string format: date example: "2024-08-01" RpcShareholdersInsight: description: RPC Shareholders content: application/json: schema: type: object properties: data: type: array items: type: object properties: name: description: Name type: string example: FOO BAR, S.A. DE C.V. rfc: description: RFC type: string example: PEIC211118IS0 shares: description: Number of shares type: number example: 12345 percentage: description: Shares percentage type: number format: float example: 100 ShareholdersInsight: description: Shareholders insight content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/Collection" - type: object properties: "@context": default: /contexts/GetShareholdersInsight "@id": example: /entities/91ab5678-1234-5678-9abc-def012345678/insights/shareholders?relations.relationType=shareholders "hydra:member": type: array items: type: object properties: id: description: Shareholder ID type: string format: uuid example: 91ab5678-1234-5678-9abc-def012345678 name: description: Shareholder name type: string example: "EJEMPLO HOLDINGS, S.A. DE C.V." rfc: description: Shareholder RFC, when available type: [string, "null"] example: "EHO240101AB1" shares: description: Number of shares recorded for the relation type: string example: "500" percentage: description: Ownership percentage for this shareholder relation type: string example: "50.00" relationId: description: Shareholder relation ID type: string format: uuid example: 82cd9012-3456-7890-abcd-ef1234567890 sources: description: Comma-separated sources that support the relation type: string example: company_verification entityId: description: Entity ID created for the shareholder, when the shareholder has been promoted type: [string, "null"] format: uuid example: 3f6b8b52-60f3-4af1-8459-6f23a0a0c944 sourceId: description: Source record ID for the latest RPC source, when available type: [string, "null"] format: uuid example: 11d2c236-bbd0-4024-8e59-089aa0d4359d scores: description: Scores available for the promoted shareholder entity type: array items: type: object properties: id: description: Score source record ID, when available type: [string, "null"] format: uuid example: 76e6d0ec-9e6a-40c7-85e2-4ce02b5d9568 source: description: Score source type: string example: buro_de_credito type: description: Score type type: string example: informe_buro score: description: Score value, when available type: [string, "null"] example: "533" generatedAt: description: Date and time when the score was generated type: string format: date-time example: "2024-10-04T20:53:09+00:00" metadata: description: Additional score metadata type: object additionalProperties: true BalanceSheetMetricInsight: description: Balance sheet response content: application/json: schema: allOf: - type: object properties: taxRegime: $ref: "#/components/schemas/TaxRegime" data: type: array items: type: object providedByYear: type: object additionalProperties: type: boolean description: Whether SAT's annual declaration of each fiscal year of the period includes this statement, keyed by fiscal year. A year is `false` when its declaration does not include the statement, as for the declarations of digital platforms (625) and native RESICO (626) personas físicas, and its column in `data` has no value. A year whose column has a value is `true`, including when another year's declaration provides it. The declarations are read the same way in every `X-Insight-Format`. Years with no extracted annual declaration are left out. example: taxRegime: id: 601 providedByYear: "2021": true "2022": true "2023": true data: - "2021": Total: 51234 Comment: "2022": Total: 48961 Comment: "2023": Total: 48790 Comment: category: Activo children: - "2021": Total: 51234 Comment: "2022": Total: 48961 Comment: "2023": Total: 48790 Comment: category: Activo a corto plazo children: - "2021": Total: 51234 Comment: "2022": Total: 48961 Comment: "2023": Total: 48790 Comment: category: Efectivo y equivalentes de efectivo children: - "2021": Total: 51234 Comment: "2022": Total: 48961 Comment: "2023": Total: 48790 Comment: category: Efectivo y equivalentes de efectivo nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Efectivo y equivalentes de efectivo del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Efectivo y equivalentes de efectivo, restringido nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Efectivo y equivalentes de efectivo, restringido del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas de margen - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Efectivo y equivalentes de efectivo - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Instrumentos financieros de negociación children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Inversiones en valores con Instituciones nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Inversiones en valores con Instituciones extranjeras - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Inversiones permanentes en acciones nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Inversiones permanentes en acciones del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Inversiones en instrumentos financieros negociables - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Inversiones en instrumentos financieros para cobrar o vender - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Inversiones en valores con Instituciones - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Clientes children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Clientes nacionales partes relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Clientes extranjeros partes relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Clientes nacionales partes no relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Clientes extranjeros partes no relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cartera de crédito vigente - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cartera de crédito vencida - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cartera de crédito con riesgo de crédito etapa 1 - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cartera de crédito con riesgo de crédito etapa 2 - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cartera de crédito con riesgo de crédito etapa 3 - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Estimación preventiva para riesgos crediticios - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Derechos de cobro adquiridos (neto) - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Clientes - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Cuentas y documentos por cobrar children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por cobrar a partes relacionadas nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por cobrar a partes relacionadas del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por cobrar a partes no relacionadas nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por cobrar a partes no relacionadas del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Deudores por reporto - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Préstamo de valores - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Instrumentos Financieros Derivados - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Cuentas y documentos por cobrar - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Deudores diversos children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Deudores diversos partes relacionadas nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Deudores diversos partes relacionadas del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Deudores diversos partes no relacionadas nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Deudores diversos partes no relacionadas del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Deudores por primas nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Deudores por primas del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Deudores diversos - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Estimación de cuentas incobrables - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Impuesto por recuperar - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Inventarios children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Productos terminados - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Producción en proceso - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Materiales y materias primas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pérdida por deterioro - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Mercancías en tránsito - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Estimación de obsolescencia - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Bienes adjudicados - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Estimación de bienes adjudicados - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Inventarios - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Pagos anticipados children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Rentas pagadas por anticipado - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Anticipo a proveedores nacionales partes relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Anticipo a proveedores extranjeros partes relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Anticipo a proveedores nacionales partes no relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Anticipo a proveedores extranjeros partes no relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pagos anticipados - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Impuestos pagados por anticipado - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Depósitos en garantía - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Seguros y fianzas pagados por anticipado - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Pagos anticipados - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Activos disponibles para venta - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Otros activos a corto plazo - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Activo a largo plazo children: - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Propiedades, plantas y equipo children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Terrenos - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Construcciones - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Depreciación de construcciones - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Maquinaria - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Depreciación de maquinaria - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Equipo de Transporte - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Depreciación de equipo de transporte - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Mobiliario y Equipo - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Depreciación de mobiliario y equipo - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Equipo de Computo - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Propiedades, plantas y equipo - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Mejoras a inmuebles arrendados - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Depreciación de equipo de computo - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Cuentas y documentos por cobrar a largo plazo children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por cobrar a largo plazo de partes relacionadas nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por cobrar a largo plazo de partes relacionadas extranjeras - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por cobrar a largo plazo de partes no relacionadas nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por cobrar a largo plazo de partes no relacionadas extranjeras - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Cuentas y documentos por cobrar a largo plazo - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Anticipo a proveedores children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Anticipo a proveedores nacionales a largo plazo (partes relacionadas) - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Anticipo a proveedores extranjeros a largo plazo (partes relacionadas) - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Anticipo a proveedores nacionales a largo plazo (partes no relacionadas) - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Anticipo a proveedores extranjeros a largo plazo (partes no relacionadas) - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pagos anticipados - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Impuestos pagados por anticipado - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Depósitos en garantía - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Seguros y fianzas pagados por anticipado - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Anticipo a proveedores - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Crédito mercantil - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Activos intangibles children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Activos intangibles - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Derechos de usufructo adquirido en el ejercicio - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Activos intangibles - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Inversiones en asociadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Instrumentos financieros por cobrar a largo plazo - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Otros activos a largo plazo - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pasivo children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pasivo a corto plazo children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Préstamos bancarios - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Proveedores children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Proveedores nacionales partes relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Proveedores del extranjero partes relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Proveedores nacionales partes no relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Proveedores del extranjero partes no relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Proveedores - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Cuentas y documentos por pagar children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por pagar a partes relacionadas nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por pagar a partes relacionadas del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por pagar a partes no relacionadas nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por pagar a partes no relacionadas del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Captación tradicional - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Préstamos interbancarios y de otros organismos - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Reservas técnicas (Riesgos en curso, obligaciones pendientes de cumplir, riesgos catastróficos) - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Otras reservas técnicas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Cuentas y documentos por pagar - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Instrumentos financieros children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Instrumentos financieros nacionales partes relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Instrumentos financieros del extranjero partes relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Instrumentos financieros nacionales partes no relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Instrumentos financieros del extranjero partes no relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Instrumentos financieros derivados con fines de negociación - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Instrumentos financieros derivados con fines de cobertura - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Ajustes de valuación por cobertura de pasivos financieros - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Instrumentos financieros - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Acreedores diversos children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Acreedores diversos nacionales partes relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Acreedores diversos del extranjero partes relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Acreedores diversos nacionales partes no relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Acreedores diversos del extranjero partes no relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Acreedores por reporto - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Préstamo de valores - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Colaterales vendidos o dados en garantía - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Obligaciones en operaciones de bursatilización - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pasivo por arrendamiento - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Acreedores por liquidación de operaciones - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Acreedores por cuentas de margen - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Acreedores por colaterales recibidos en efectivo - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Reaseguradores y reafianzadores - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Acreedores diversos - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Activos por derecho de uso derivados de arrendamientos - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Impuestos a la utilidad por pagar - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Anticipo de clientes children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Anticipos de clientes partes relacionadas nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Anticipos de clientes partes relacionadas del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Anticipos de clientes partes no relacionadas nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Anticipos de clientes partes no relacionadas del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Anticipo de clientes - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Provisiones - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Impuestos por pagar children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Impuestos retenidos - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Impuestos trasladados cobrados - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Impuestos trasladados por cobrar - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Impuestos por pagar - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: ISR diferido - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: PTU por pagar - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Impuestos por pagar - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Otros pasivos a corto plazo - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pasivo a largo plazo children: - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Cuentas y documentos por pagar a largo plazo children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por pagar a largo plazo de partes relacionadas nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por pagar a largo plazo de partes relacionadas del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por pagar a largo plazo de partes no relacionadas nacionales - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cuentas y documentos por pagar a largo plazo de partes no relacionadas del extranjero - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Cuentas y documentos por pagar a largo plazo - "2021": Total: 0 Comment: "2022": Total: 0 Comment: "2023": Total: 0 Comment: category: Instrumentos financieros a largo plazo children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Instrumentos financieros a largo plazo nacionales de partes relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Instrumentos financieros a largo plazo del extranjero de partes relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Instrumentos financieros a largo plazo nacionales de partes no relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Instrumentos financieros a largo plazo del extranjero de partes no relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Instrumentos financieros a largo plazo - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Rentas cobradas por anticipado - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Aportaciones para futuros aumentos de capital - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Impuesto a la utilidad diferido por pagar - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Beneficio a empleados - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Provisiones a largo plazo - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Otros pasivos a largo plazo - "2021": Total: 51234 Comment: "2022": Total: 48961 Comment: "2023": Total: 48790 Comment: category: Capital children: - "2021": Total: 51234 Comment: "2022": Total: 48961 Comment: "2023": Total: 48790 Comment: category: Capital contable children: - "2021": Total: 51234 Comment: "2022": Total: 51234 Comment: "2023": Total: 51234 Comment: category: Capital Social children: - "2021": Total: 51234 Comment: "2022": Total: 51234 Comment: "2023": Total: 51234 Comment: category: Capital social (aportaciones) - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Capital social (capitalización) - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Aportaciones para futuros aumentos de capital - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Reserva Legal - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Exceso en la actualización del capital - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Insuficiencia en la actualización del capital - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Actualización del capital contable - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Reservas de capital - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Prima en venta de acciones - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Capital social - "2021": Total: 0 Comment: "2022": Total: -1039 Comment: "2023": Total: -1210 Comment: category: Utilidades acumuladas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Utilidades acumuladas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Utilidad neta - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pérdidas acumuladas - "2021": Total: Comment: "2022": Total: -1039 Comment: "2023": Total: -1210 Comment: category: Pérdida neta - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Utilidades acumuladas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Otros resultados integrales - "2021": Total: 51234 Comment: "2022": Total: 48961 Comment: "2023": Total: 48790 Comment: category: Participación controladora - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Participación no controladora IncomeStatementMetricsInsight: description: Income statement response content: application/json: schema: allOf: - type: object properties: taxRegime: $ref: "#/components/schemas/TaxRegime" data: type: array items: type: object providedByYear: type: object additionalProperties: type: boolean description: Whether SAT's annual declaration of each fiscal year of the period includes this statement, keyed by fiscal year. A year is `false` when its declaration does not include the statement, as for the form F25 declarations of agricultural (AGAPES, 622) personas morales, and its column in `data` has no value. A year whose column has a value is `true`, including when another year's declaration provides it. The declarations are read the same way in every `X-Insight-Format`. Years with no extracted annual declaration are left out. example: taxRegime: id: 601 providedByYear: "2021": true "2022": true "2023": true data: - "2021": Total: Comment: "2022": Total: 123123123 Comment: "2023": Total: 321321321 Comment: category: Ingresos Netos children: - "2021": Total: Comment: "2022": Total: 123123123 Comment: "2023": Total: 321321321 Comment: category: Ventas y/o servicios nacionales children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: 123123123 Comment: "2023": Total: 321321321 Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Ventas y/o servicios extranjeros children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Devoluciones, descuentos y bonificaciones nacionales children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Devoluciones, descuentos y bonificaciones extranjeras children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Ingresos por intereses children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Gastos por intereses children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Estimación preventiva para riesgos crediticios children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Estimación preventiva para riesgos crediticios (Recuperaciones) children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Primas emitidas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Primas cedidas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Ingresos children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Otros Ingresos children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Total de materiales utilizados o comercializados children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Inventario Inicial children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Compras netas nacionales children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Compras netas extranjeras children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Inventario Final children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin materiales utilizados o comercializados children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Costo de ventas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Mano de obra directa de fabricación children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Mano de obra indirecta de fabricación children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Gastos relacionados a la mano de obra children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Maquilas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Gastos Indirectos children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Deducciones de inversiones children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Otros costos children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Costo de ventas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Costo de servicios children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Costo de servicios children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Comisiones y tarifas cobradas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Comisiones y tarifas pagadas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Otros ingresos (egresos) de la operación children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Incremento neto de las reservas técnicas (Riesgos en curso, obligaciones pendientes de cumplir, riesgos catastróficos) children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Costo neto de adquisición children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Costo neto de siniestralidad, reclamaciones y otras obligaciones pendientes de cumplir children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Incremento neto de otras reservas técnicas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Costo de servicios children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Utilidad Bruta children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pérdida Bruta children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: 4271628 Comment: "2023": Total: 28242903 Comment: category: Gastos de operación children: - "2021": Total: Comment: "2022": Total: 4271628 Comment: "2023": Total: 28242903 Comment: category: Gastos generales children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: 4271628 Comment: "2023": Total: 28242903 Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Gastos de administración children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Gastos de venta children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Gastos de operación children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Utilidad de operación children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pérdida de operación children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Resultado Integral de Financiamiento children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Intereses devengados a favor nacionales children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Intereses devengados a favor del extranjero children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Intereses moratorios a favor nacionales children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Intereses moratorios a favor del extranjero children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Ganancia cambiaria children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Intereses devengados a cargo nacionales children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Intereses devengados a cargo del extranjero children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Intereses moratorios a cargo nacionales children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Intereses moratorios a cargo del extranjero children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pérdida cambiaria children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Resultado por posición monetaria favorable children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Resultado por posición monetaria desfavorable children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cambios en el valor razonable de activos y pasivos financieros deudor children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Cambios en el valor razonable de activos y pasivos financieros acreedor children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Productos Financieros children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Resultado Integral de Financiamiento children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Gastos Financieros children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Participación en asociadas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Utilidad neta por participación en los resultados de subsidiarias no consolidadas, asociadas y negocios conjuntos children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pérdida neta por participación en los resultados de subsidiarias no consolidadas, asociadas y negocios conjuntos children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Participación en asociadas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Utilidad antes de Impuestos a la utilidad children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pérdida antes de Impuestos a la utilidad children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Impuestos a la utilidad children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Impuesto sobre la renta children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Impuesto sobre la renta diferido children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Impuestos a la utilidad children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Utilidad de operaciones continuas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pérdida de operaciones continuas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Operaciones discontinuadas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Participación de los Trabajadores en las Utilidades children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Sin Operaciones discontinuadas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Utilidad de enajenación de acciones children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pérdida de enajenación de acciones children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Utilidad de segmento del negocio o segmento geográfico children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pérdida de segmento del negocio o segmento geográfico children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Operaciones discontinuadas children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Utilidad neta children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Pérdida neta children: - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes Relacionadas - "2021": Total: Comment: "2022": Total: Comment: "2023": Total: Comment: category: Partes No Relacionadas InvoicingConcentrationInsight: description: Entity invoicing concentration content: application/json: schema: allOf: - type: array items: type: object properties: name: type: string description: Counterparty name total: type: string description: Total amount of transactions share: type: string description: Share in percentage of all invoicing transactions: type: array description: Monthly transaction amount items: type: object properties: date: type: string format: date total: type: number TrialBalanceInsight: description: Entity trial balance content: application/json: schema: allOf: - type: array items: type: object properties: data: type: object description: Data properties: periods: type: object description: Reporting periods keyed by `YYYY-MM` properties: 2020-12: type: object description: Period data properties: year: type: integer description: Year example: 2020 month: type: integer description: Year example: 12 accounts: type: object description: Accounts keyed by code properties: "100": type: object description: Account properties: code: type: string description: Code example: "100" description: type: string description: Description example: Bancos trialBalance: type: object description: Period data properties: 2020-12: type: object description: Period data properties: initialBalance: type: number description: Initial balance data example: 431147.87 credits: type: number description: Credits data example: 5081813.59 debits: type: number description: Debits data example: 3339130.2 endingBalance: type: number description: Ending balance data example: 2173831.27 children: type: object description: Children data properties: "102": type: object description: Account properties: code: type: string description: Code example: "102" description: type: string description: Description example: Bancos nacionales trialBalance: type: object description: Period data properties: 2020-12: type: object description: Period data properties: initialBalance: type: number description: Initial balance data example: 431147.87 credits: type: number description: Credits data example: 5081813.59 debits: type: number description: Debits data example: 3339130.2 endingBalance: type: number description: Ending balance data example: 2173831.27 ScoresInsight: description: Entity scores content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/Scores - $ref: "#/components/schemas/Scores" WebhookEndpointCollection: description: Webhook endpoint collection response content: application/ld+json: schema: $ref: "#/components/schemas/WebhookEndpointCollection" WebhookEndpoint: description: Webhook endpoint resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/WebhookEndpoint - $ref: "#/components/schemas/WebhookEndpoint" WebhookRequestCollection: description: Webhook request collection response content: application/ld+json: schema: $ref: "#/components/schemas/WebhookRequestCollection" WebhookRequest: description: Webhook request resource response content: application/ld+json: schema: allOf: - type: object properties: "@context": type: string default: /contexts/WebhookRequest - $ref: "#/components/schemas/WebhookRequest" requestBodies: TagInvoice: required: true content: application/json: schema: $ref: "#/components/schemas/TagInvoiceInput" TagInvoicesBatch: required: true content: application/json: schema: $ref: "#/components/schemas/TagInvoicesBatchInput" TagEntitiesBatch: required: true content: application/json: schema: $ref: "#/components/schemas/TagEntitiesBatchInput" TagCreate: required: true content: application/json: schema: $ref: "#/components/schemas/TagCreateInput" TagUpdate: required: true content: application/merge-patch+json: schema: $ref: "#/components/schemas/TagUpdateInput" EntityUpdate: required: true content: application/merge-patch+json: schema: $ref: "#/components/schemas/EntityUpdateInput" EntityTagCreate: required: true content: application/json: schema: $ref: "#/components/schemas/EntityTagCreateInput" EntityIdentifierCreate: required: true content: application/json: schema: $ref: "#/components/schemas/EntityIdentifierCreateInput" EntityTagUpdate: required: true content: application/merge-patch+json: schema: $ref: "#/components/schemas/EntityTagUpdateInput" SchedulerRuleCreate: required: true content: application/json: schema: $ref: "#/components/schemas/SchedulerRuleInput" SchedulerRuleUpdate: required: true content: application/json: schema: $ref: "#/components/schemas/SchedulerRuleUpdateInput" SchedulerCreate: required: true content: application/json: schema: $ref: "#/components/schemas/SchedulerInput" SchedulerUpdate: required: true content: application/json: schema: $ref: "#/components/schemas/SchedulerUpdateInput" CreateExport: required: true content: application/json: examples: invoices: summary: Invoice example value: format: xlsx fileTypes: - invoice.cfdi.xml uri: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/invoices?usage=I01&type=I&issuedAt[after]=2020-01-01 tax_returns: summary: Tax returns example value: format: csv fileTypes: - tax_return.transcript uri: /entities/{entityId}/tax-returns?itemsPerPage=20 report_pdf: summary: Report PDF example value: format: pdf uri: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/reports/9137b53f-1abd-4d64-85c1-4e73d96fb997?exporting=true schema: type: object required: - format - uri properties: format: description: |- Format for your resource. Use `csv`, `xlsx`, or `json` for collection URIs. Use `pdf` only for report URIs. type: string enum: - csv - xlsx - json - pdf fileTypes: description: Optional file types to include in the generated export; when specified, the export file includes the matching content files type: array minItems: 1 example: - invoice.cfdi.xml items: type: string enum: - invoice.cfdi.xml - invoice.cfdi.pdf - tax_return.transcript - tax_return.ack_receipt - tax_return.payment_receipt uri: description: |- Collection URI used as the export source. Use the collection's query parameters to filter the exported data. ### Example of supported URI values - /entities - /entities/{entityId}/tax-returns - /entities/{entityId}/invoices - /entities/{entityId}/reports/{reportId}?exporting=true ### Report PDF exports To download a [report](/api-reference/reports/list-reports) as a PDF document, set `format` to `pdf` and `uri` to `/entities/{entityId}/reports/{reportId}?exporting=true`. The `exporting=true` query parameter is required; other query parameters are not supported on report URIs. The generated PDF renders the report the same way the dashboard shows it to the requesting user, in the user's locale and over the report's default period, and is attached to the export as a `report.insights.pdf` file. type: string example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/invoices?issuedAt[after]=2026-01-01 InsightReportSave: required: true content: application/json: schema: type: object required: - name - insights properties: name: type: string description: Report name shown in the dashboard's report selector example: Credit review insights: type: array description: Ordered layout of insight entries and groups rendered by the report items: $ref: "#/components/schemas/InsightReportInsightEntryInput" organizational: type: boolean description: Share the report with every user in the organization instead of keeping it personal default: false CredentialCreate: required: true content: application/json: schema: oneOf: - $ref: "#/components/schemas/CredentialCiecInput" - $ref: "#/components/schemas/CredentialEfirmaInput" discriminator: propertyName: type mapping: ciec: "#/components/schemas/CredentialCiecInput" efirma: "#/components/schemas/CredentialEfirmaInput" ExtractionCreate: required: true content: application/json: schema: $ref: "#/components/schemas/ExtractionRequest" WebhookEndpointCreate: required: true content: application/json: schema: type: object required: - url - events - enabled - contentType properties: url: $ref: "#/components/schemas/WebhookEndpointUrl" events: type: array example: - extraction.updated - invoice.created description: Event types delivered to this endpoint items: $ref: "#/components/schemas/WebhookEndpointEventType" enabled: default: true allOf: - $ref: "#/components/schemas/WebhookEndpointEnabled" contentType: default: application/ld+json description: Payload content type for webhook deliveries anyOf: - $ref: "#/components/schemas/WebhookEndpointContentType" WebhookEndpointUpdate: required: true content: application/json: schema: type: object required: - url - events - enabled - contentType properties: url: $ref: "#/components/schemas/WebhookEndpointUrl" events: type: array example: - extraction.updated - invoice.created description: Event types delivered to this endpoint items: $ref: "#/components/schemas/WebhookEndpointEventType" enabled: default: true allOf: - $ref: "#/components/schemas/WebhookEndpointEnabled" contentType: default: application/ld+json description: Payload content type for webhook deliveries anyOf: - $ref: "#/components/schemas/WebhookEndpointContentType" security: - ApiKey: [] paths: /entities/{entityId}/datasources/mx/buro-de-credito/reports: get: tags: - DS MX Buró de Crédito Reports operationId: GetEntityMxBuroDeCreditoReports summary: Get an entity's Buró de Crédito reports description: List Buró de Crédito reports generated for an entity parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": description: Buró de Crédito Reports content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/BuroDeCreditoReport "@id": example: /entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/datasources/mx/buro-de-credito/reports "hydra:member": type: array items: $ref: "#/components/schemas/BuroDeCreditoReport" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /datasources/mx/buro-de-credito/reports/{id}: get: tags: - DS MX Buró de Crédito Reports operationId: GetEntityMxBuroDeCreditoReport summary: Get a Buró de Crédito report description: Get a single Buró de Crédito report by report ID parameters: - $ref: "#/components/parameters/resourceId" responses: "200": description: Buró de Crédito Report content: application/ld+json: schema: type: object allOf: - type: object properties: "@context": default: /contexts/BuroDeCreditoReport "@id": example: /entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/datasources/mx/buro-de-credito/reports/9bd4a640-9f41-4cd5-a158-20767b386cb0 - $ref: "#/components/schemas/BuroDeCreditoReport" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/datasources/bil/reports: get: tags: - DS MX BIL Reports operationId: ListEntityBilReports summary: List an entity's BIL reports description: List Buró de Investigaciones Legales reports generated for an entity. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/BilReportCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /datasources/bil/reports/{id}: get: tags: - DS MX BIL Reports operationId: GetBilReport summary: Retrieve a BIL report description: Retrieve a single Buró de Investigaciones Legales report by ID. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/BilReport" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/datasources/infonavit/overdue-credits: get: tags: - DS MX Infonavit Overdue Credits operationId: ListEntityInfonavitOverdueCredits summary: List an entity's Infonavit overdue credits description: List the Infonavit Créditos Firmes records found for an entity. Each record represents an employer registration published in the public Infonavit list of firm (overdue) housing-credit obligations matched to the entity by name. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/InfonavitOverdueCreditCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /datasources/infonavit/overdue-credits/{id}: get: tags: - DS MX Infonavit Overdue Credits operationId: GetInfonavitOverdueCredit summary: Retrieve an Infonavit overdue credit description: Retrieve a single Infonavit Créditos Firmes record by ID. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/InfonavitOverdueCredit" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /datasources/mx/buro-de-credito/authorizations: get: tags: - DS MX Buró de Crédito Authorizations operationId: GetMxBuroDeCreditoAuthorizations summary: Get Buró de Crédito authorizations description: List Buró de Crédito authorizations for the organization parameters: - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": description: Buró de Crédito Authorizations content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/BuroDeCreditoAuthorization "@id": example: /datasources/mx/buro-de-credito/authorizations "hydra:member": type: array items: $ref: "#/components/schemas/BuroDeCreditoAuthorization" "401": $ref: "#/components/responses/Unauthorized" /entities/{entityId}/datasources/mx/buro-de-credito/authorizations: get: tags: - DS MX Buró de Crédito Authorizations operationId: GetEntityMxBuroDeCreditoAuthorization summary: Get an entity's Buró de Crédito authorizations description: List Buró de Crédito authorizations associated with an entity parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": description: Buró de Crédito Authorizations content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/BuroDeCreditoAuthorization "@id": example: /entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/datasources/mx/buro-de-credito/authorizations "hydra:member": type: array items: $ref: "#/components/schemas/BuroDeCreditoAuthorization" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" post: tags: - DS MX Buró de Crédito Authorizations operationId: CreateMxBuroDeCreditoAuthorization summary: Create a Buró de Crédito authorization description: Create a Buró de Crédito authorization for an entity so report extractions can use it parameters: - $ref: "#/components/parameters/entityId" requestBody: required: true content: application/json: schema: oneOf: - title: "Person" properties: authorizedAt: type: string format: date-time description: Date and time when authorization was granted example: "2024-01-31T00:00:00+00:00" taxpayer: type: object description: Person identity and address data authorized for Buró de Crédito required: - rfc - nationality - birthdate - firstName - firstLastName - secondLastName - address properties: rfc: type: string description: Person RFC example: "PRPU800101HM2" nationality: type: string description: Two-letter nationality code example: "MX" birthdate: type: string format: date description: Person birth date example: "1980-01-01" firstName: type: string description: Person first name example: "UNO" middleName: type: [string, "null"] description: Person middle name example: "DOS" firstLastName: type: string description: Person first last name example: "PRUEBA" secondLastName: type: string description: Person second last name example: "PROSPECTOR" address: type: object description: Mexico address data in the format required by Buró de Crédito required: - address - city - municipality - state - postalCode - neighborhood - country properties: address: type: string description: Street name example: "Jaime Balmes" city: type: string description: City example: "Cd de Mexico" municipality: type: string description: Municipality or borough example: "Miguel Hidalgo" state: type: string description: Buró de Crédito state code example: "CMX" postalCode: type: string description: Five-digit postal code example: "11510" exteriorNumber: type: [string, "null"] description: Exterior number example: "8" interiorNumber: type: [string, "null"] description: Interior number example: "" neighborhood: type: string description: Neighborhood example: "Los morales" country: type: string description: Two-letter country code example: "MX" - title: Company properties: authorizedAt: type: string format: date-time description: Date and time when authorization was granted example: "2024-01-31T00:00:00+00:00" taxpayer: type: object description: Company identity and address data authorized for Buró de Crédito properties: rfc: type: string description: Company RFC example: "AGS930324RN7" nationality: type: string description: Two-letter nationality code example: "MX" tradeName: type: string description: Company trade or legal name example: "ALMACENES GHINOS, SA DE CV" address: type: object description: Mexico address data in the format required by Buró de Crédito required: - address - city - municipality - state - postalCode - neighborhood - country properties: address: type: string description: Street name example: "AV IGNACIO ALLENDE LOTE 11-B LOCAL 2" city: type: string description: City example: "TEPEAPULCO" municipality: type: string description: Municipality or borough example: "Cd de Mexico" state: type: string description: Buró de Crédito state code example: "CMX" postalCode: type: string description: Five-digit postal code example: "11510" exteriorNumber: type: [string, "null"] description: Exterior number example: "8" interiorNumber: type: [string, "null"] description: Interior number example: "" neighborhood: type: string description: Neighborhood example: "CD SAHAGUN HGO" country: type: string description: Two-letter country code example: "MX" required: - rfc - nationality - tradeName - address required: - authorizedAt - taxpayer required: - authorizedAt - taxpayer responses: "201": description: Buró de Crédito Authorization created successfully "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /datasources/mx/buro-de-credito/authorizations/{id}: get: tags: - DS MX Buró de Crédito Authorizations operationId: GetMxBuroDeCreditoAuthorization summary: Get a Buró de Crédito authorization description: Get a single Buró de Crédito authorization by authorization ID parameters: - $ref: "#/components/parameters/resourceId" responses: "200": description: Buró de Crédito Authorization content: application/ld+json: schema: type: object allOf: - type: object properties: "@context": default: /contexts/BuroDeCreditoAuthorization "@id": example: /entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/datasources/mx/buro-de-credito/authorizations/9bd4a640-9f41-4cd5-a158-20767b386cb0 - $ref: "#/components/schemas/BuroDeCreditoAuthorization" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" delete: tags: - DS MX Buró de Crédito Authorizations operationId: DeleteMxBuroDeCreditoAuthorization summary: Delete a Buró de Crédito authorization description: Delete a Buró de Crédito authorization by authorization ID parameters: - $ref: "#/components/parameters/resourceId" responses: "204": description: Buró de Crédito Authorization deleted "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/datasources/mx/sat/certificados: get: tags: - DS MX SAT Certificates operationId: GetEntityMxSatCertificates summary: List an entity's SAT certificates description: | List SAT certificates associated with an entity. These digital certificates are used for electronic signatures and digital sealing in Mexico's tax system. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - $ref: "#/components/parameters/validFromBefore" - $ref: "#/components/parameters/validFromStrictlyBefore" - $ref: "#/components/parameters/validFromAfter" - $ref: "#/components/parameters/validFromStrictlyAfter" - $ref: "#/components/parameters/validToBefore" - $ref: "#/components/parameters/validToStrictlyBefore" - $ref: "#/components/parameters/validToAfter" - $ref: "#/components/parameters/validToStrictlyAfter" - $ref: "#/components/parameters/orderValidFrom" - $ref: "#/components/parameters/orderValidTo" - $ref: "#/components/parameters/serialNumberFilter" - $ref: "#/components/parameters/certificateTypeFilter" responses: "200": description: SAT Certificates content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/Collection" - type: object properties: "@context": default: /contexts/SatCertificate "@id": example: /entities/91ab5678-1234-5678-9abc-def012345678/datasources/mx/sat/certificados "hydra:member": type: array items: $ref: "#/components/schemas/SatCertificate" "hydra:search": type: object properties: "@type": type: string default: hydra:IriTemplate "hydra:template": example: "/entities/91ab5678-1234-5678-9abc-def012345678/datasources/mx/sat/certificados{?validFrom[before],validFrom[strictly_before],validFrom[after],validFrom[strictly_after],validTo[before],validTo[strictly_before],validTo[after],validTo[strictly_after],order[validFrom],order[validTo],serialNumber,type}" hydra:variableRepresentation: type: string default: BasicRepresentation hydra:mapping: type: array items: type: object properties: "@type": type: string default: IriTemplateMapping variable: type: string property: type: string required: type: boolean default: false example: - "@type": IriTemplateMapping variable: "validFrom[before]" property: validFrom required: false - "@type": IriTemplateMapping variable: "validFrom[strictly_before]" property: validFrom required: false - "@type": IriTemplateMapping variable: "validFrom[after]" property: validFrom required: false - "@type": IriTemplateMapping variable: "validFrom[strictly_after]" property: validFrom required: false - "@type": IriTemplateMapping variable: "validTo[before]" property: validTo required: false - "@type": IriTemplateMapping variable: "validTo[strictly_before]" property: validTo required: false - "@type": IriTemplateMapping variable: "validTo[after]" property: validTo required: false - "@type": IriTemplateMapping variable: "validTo[strictly_after]" property: validTo required: false - "@type": IriTemplateMapping variable: "order[validFrom]" property: validFrom required: false - "@type": IriTemplateMapping variable: "order[validTo]" property: validTo required: false - "@type": IriTemplateMapping variable: serialNumber property: serialNumber required: false - "@type": IriTemplateMapping variable: type property: type required: false "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /datasources/mx/sat/certificados/{id}: get: tags: - DS MX SAT Certificates operationId: GetMxSatCertificate summary: Retrieve a SAT certificate description: | Retrieve a SAT certificate by ID. The `file` property references the certificate file. Use the file download endpoint to retrieve the certificate content. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": description: SAT Certificate content: application/ld+json: schema: type: object allOf: - type: object properties: "@context": default: /contexts/SatCertificate "@id": example: /datasources/mx/sat/certificados/0197a365-6c09-7019-b072-6c756008cd2d - $ref: "#/components/schemas/SatCertificate" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/metrics/invoicing-annual-comparison: get: tags: - Invoicing Annual Comparison Insight operationId: GetInvoicingAnnualComparison summary: Get invoicing annual comparison description: Year-over-year totals of issued and received invoicing activity, one row per fiscal year. parameters: - $ref: "#/components/parameters/entityId" responses: "200": description: Success content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/HydraView" - type: object properties: "@context": default: /contexts/GetInvoicingAnnualComparison "@id": example: /entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/insights/metrics/invoicing-annual-comparison "hydra:member": type: array items: type: object properties: period: type: string example: "2021" totalSalesRevenue: type: string format: float example: "161227.35" description: "Total sales revenue from active issued invoices (type I, status VIGENTE)" totalIncome: type: string format: float example: "161227.35" description: "Total income including sales revenue and payroll (totalSalesRevenue + incomePayroll)" incomePaymentPending: type: string format: float example: "24206.10" totalIncomeCancelled: type: string format: float example: "0.00" incomeDiscounts: type: string format: float example: "11754.18" incomeCreditNotes: type: string format: float example: "0.00" netIncome: type: string format: float example: "125267.06" incomeDueUponReceipt: type: string format: float example: "0.0051" incomeDueOverTime: type: string format: float example: "0.9949" collectedIncomeDueOverTime: type: string format: float example: "0.8596" incomePayroll: type: string format: float example: "0.00" description: Payroll received by the entity (income for PF/PFAE) totalExpenses: type: string format: float example: "120439.39" receivedPaymentPending: type: string format: float example: "26514.75" totalExpensesCancelled: type: string format: float example: "0.00" expensesDiscounts: type: string format: float example: "5670.48" expensesCreditNotes: type: string format: float example: "0.00" payroll: type: string format: float example: "0.00" netExpensesPlusPayroll: type: string format: float example: "88254.16" margin: type: string format: float example: "0.2955" expensesDueUponReceipt: type: string format: float example: "0.3511" expensesDueOverTime: type: string format: float example: "0.6489" paidExpensesDueOverTime: type: string format: float example: "0.0193" daysPayableOutstanding: type: string format: float example: "14.00" daysSalesOutstanding: type: string format: float example: "-1.33" netExpenses: type: string format: float example: "88254.16" netIncomePlusPayroll: type: string format: float example: "125267.06" description: "Net income plus payroll received (net_income + income_payroll)" profitOrLoss: type: string format: float example: "37012.90" description: "Profit or loss including payroll income ((net_income + income_payroll) - net_expenses_plus_payroll)" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/metrics/vendor-network: get: tags: - Vendor Network Insight operationId: GetVendorNetwork summary: Get vendor network description: Vendors the entity has purchased from, with invoiced totals and cancellation rates per counterparty. parameters: - $ref: "#/components/parameters/entityId" responses: "200": description: Success content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/HydraView" - type: object properties: "@context": default: /contexts/GetVendorNetwork "@id": example: /entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/insights/metrics/vendor-network "hydra:member": items: properties: vendor: type: string example: "Apple" description: "Vendor name" vendorRfc: type: string example: "APL920101AA1" description: "Vendor RFC" totalReceived: type: string format: float example: "15928890.28" totalCancelledReceived: type: string format: float example: "0.00" percentageCancelled: type: string format: float example: "0.0000" receivedDiscounts: type: string format: float example: "963836.78" receivedCreditNotes: type: string format: float example: "897457.12" receivedPaymentPending: type: string format: float example: "0.00" netReceived: type: string format: float example: "14067696.38" pueReceived: type: string format: float example: "15928890.28" ppdReceived: type: string format: float example: "0.00" ppdCount: type: integer example: 0 paymentAmount: type: string format: float example: "0.00" collectedInInstallments: type: string format: float example: "0.0000" daysPayableOutstanding: type: string format: float example: "0.00" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/metrics/customer-network: get: tags: - Customer Network Insight operationId: GetCustomerNetwork summary: Get customer network description: Customers the entity has sold to, with invoiced totals and cancellation rates per counterparty. parameters: - $ref: "#/components/parameters/entityId" responses: "200": description: Success content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/HydraView" - type: object properties: "@context": default: /contexts/GetCustomerNetwork "@id": example: /entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/insights/metrics/customer-network "hydra:member": items: properties: customer: type: string example: "PUBLICO EN GENERAL" description: "Customer name" customerRfc: type: string example: "XAXX010101000" description: "Customer RFC" totalReceived: type: string format: float example: "15928890.28" totalCancelledReceived: type: string format: float example: "0.00" percentageCancelled: type: string format: float example: "0.0000" receivedDiscounts: type: string format: float example: "963836.78" receivedCreditNotes: type: string format: float example: "897457.12" emittedPaymentPending: type: string format: float example: "0.00" netReceived: type: string format: float example: "14067696.38" pueReceived: type: string format: float example: "15928890.28" ppdReceived: type: string format: float example: "0.00" ppdCount: type: integer example: 0 paymentAmount: type: string format: float example: "0.00" collectedInInstallments: type: string format: float example: "0.0000" daysSalesOutstanding: type: string format: float example: "0.00" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /files/{id}: get: tags: - Files operationId: GetFile summary: Retrieve a file description: Retrieve file metadata, including type, filename, media type, size, and the resource associated with the file. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/File" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /files/{id}/download: get: tags: - Files operationId: DownloadFile summary: Download content description: The response includes the `Location` header with the URL to download the file (make sure to follow the redirection). parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/DownloadFile" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /exports: get: tags: - Exports operationId: ListExports summary: List all exports description: List the exports created by the authenticated user, newest first. Use this to recover the ID of an export you created earlier. Exports created by other users in your organization are not returned. Results are paginated with cursor pagination. parameters: - name: status in: query description: Filter exports by processing status (exact match) schema: type: string enum: - pending - running - finished - failed - stopping - stopped - name: format in: query description: Filter exports by output format (exact match) schema: type: string enum: - csv - xlsx - json - pdf - name: id in: query description: Filter exports by ID (exact match) example: 91106968-1abd-4d64-85c1-4e73d96fb997 schema: type: string format: uuid - name: order[id] in: query description: Order by export ID schema: $ref: "#/components/schemas/CollectionOrder" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/ExportCollection" "401": $ref: "#/components/responses/Unauthorized" post: tags: - Exports operationId: CreateExport summary: Export data description: Create an export from a supported collection URI. The export runs asynchronously and returns an Export resource that can be polled until the generated file is ready. requestBody: $ref: "#/components/requestBodies/CreateExport" responses: "202": $ref: "#/components/responses/Export" "400": $ref: "#/components/responses/ConstraintViolation" "401": $ref: "#/components/responses/Unauthorized" /exports/{id}: get: tags: - Exports operationId: GetExport summary: Retrieve an export description: Retrieve an export and its current processing status. When the export is finished, the response includes the generated file metadata. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/Export" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /reports: get: tags: - Reports operationId: ListReports summary: List all reports description: | List the reports available to the authenticated user: built-in reports, the user's personal reports, and organizational reports. Insight entries whose feature flags are not enabled for your organization are omitted from the `insights` layout. parameters: - $ref: "#/components/parameters/createdAtBefore" - $ref: "#/components/parameters/createdAtStrictlyBefore" - $ref: "#/components/parameters/createdAtAfter" - $ref: "#/components/parameters/createdAtStrictlyAfter" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/collectionPage" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/InsightReportCollection" "401": $ref: "#/components/responses/Unauthorized" post: tags: - Reports operationId: CreateReport summary: Create a report description: | Create a custom report with your own selection of insight entries. Set `organizational` to `true` to share the report with every user in your organization instead of keeping it personal. Reports created through the API are always custom reports: the report-level `builtIn` flag is set only by Syntage and cannot be set through the API. requestBody: $ref: "#/components/requestBodies/InsightReportSave" responses: "201": $ref: "#/components/responses/InsightReport" "401": $ref: "#/components/responses/Unauthorized" "422": $ref: "#/components/responses/UnprocessableEntity" /reports/{id}: get: tags: - Reports operationId: GetReport summary: Retrieve a report description: | Retrieve a report by ID. Use the report ID as the `uri` path segment when requesting a PDF download with the [Exports API](/api-reference/exports/export-data). parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/InsightReport" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" put: tags: - Reports operationId: UpdateReport summary: Update a report description: | Update a custom report's name, insight layout, or organizational visibility. Built-in reports cannot be updated. Personal reports can only be updated by their owner; organizational reports can only be updated by an admin. parameters: - $ref: "#/components/parameters/resourceId" requestBody: $ref: "#/components/requestBodies/InsightReportSave" responses: "200": $ref: "#/components/responses/InsightReport" "401": $ref: "#/components/responses/Unauthorized" "403": $ref: "#/components/responses/Forbidden" "404": $ref: "#/components/responses/NotFound" "422": $ref: "#/components/responses/UnprocessableEntity" delete: tags: - Reports operationId: DeleteReport summary: Delete a report description: | Delete a custom report. Built-in reports cannot be deleted. Personal reports can only be deleted by their owner; organizational reports can only be deleted by an admin. parameters: - $ref: "#/components/parameters/resourceId" responses: "204": description: Report resource deleted "401": $ref: "#/components/responses/Unauthorized" "403": $ref: "#/components/responses/Forbidden" "404": $ref: "#/components/responses/NotFound" /credentials: post: tags: - DS MX SAT Credentials operationId: CreateCredential summary: Create a credential description: | Create a SAT credential for an RFC. If the RFC is not already associated with your organization, Syntage creates the related entity association as part of credential creation. requestBody: $ref: "#/components/requestBodies/CredentialCreate" responses: "202": $ref: "#/components/responses/Credential" "400": $ref: "#/components/responses/ConstraintViolation" "401": $ref: "#/components/responses/Unauthorized" get: tags: - DS MX SAT Credentials operationId: ListCredential summary: List all credentials description: | List SAT credentials available to your organization. responses: "200": $ref: "#/components/responses/CredentialCollection" "401": $ref: "#/components/responses/Unauthorized" parameters: - name: type in: query description: Filter by type (exact match) schema: $ref: "#/components/schemas/CredentialType" - name: rfc in: query description: Filter by RFC (Registro Federal de Contribuyentes, partial match) schema: type: string minLength: 12 maxLength: 13 example: PEIC211118IS0 - name: status in: query description: Filter by status (exact match) schema: $ref: "#/components/schemas/CredentialStatus" - name: deactivatedAt[before] in: query description: Filter by deactivation date (less than or equal `<=`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: deactivatedAt[strictly_before] in: query description: Filter by deactivation date (less than `<`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: deactivatedAt[after] in: query description: Filter by deactivation date (greater than or equal `>=`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: deactivatedAt[strictly_after] in: query description: Filter by deactivation date (greater than `>`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - $ref: "#/components/parameters/createdAtBefore" - $ref: "#/components/parameters/createdAtStrictlyBefore" - $ref: "#/components/parameters/createdAtAfter" - $ref: "#/components/parameters/createdAtStrictlyAfter" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/collectionPage" - $ref: "#/components/parameters/collectionLimit" /credentials/{id}: get: tags: - DS MX SAT Credentials operationId: GetCredential summary: Retrieve a credential description: | Retrieve a SAT credential by ID, including its credential type, RFC, and validation status. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/Credential" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" delete: tags: - DS MX SAT Credentials summary: Delete a credential operationId: DeleteCredential description: | Delete a SAT credential so it can no longer be used for new extraction work. parameters: - $ref: "#/components/parameters/resourceId" responses: "204": description: Credential resource deleted "400": $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /credentials/{id}/revalidate: post: tags: - DS MX SAT Credentials operationId: RevalidateCredential summary: Revalidate a credential description: | Request validation for a SAT credential that is not already valid. parameters: - $ref: "#/components/parameters/resourceId" responses: "202": $ref: "#/components/responses/Accepted" "400": $ref: "#/components/responses/BadRequest" "429": $ref: "#/components/responses/TooManyRequests" "404": $ref: "#/components/responses/NotFound" /events: get: tags: - Events operationId: ListEvent summary: List all events description: List recent events for resources in your organization. Events are ordered and paginated with cursor pagination. responses: "200": $ref: "#/components/responses/EventCollection" "401": $ref: "#/components/responses/Unauthorized" parameters: - name: type in: query description: Filter events by type (exact match) schema: $ref: "#/components/schemas/EventType" - name: taxpayer.id in: query description: Filter events by RFC (exact match) example: PEIC211118IS0 schema: $ref: "#/components/schemas/TaxpayerID" - name: source in: query description: Filter events by source (exact match) schema: $ref: "#/components/schemas/EventSource" - name: resource in: query description: Filter events by resource (exact match) schema: $ref: "#/components/schemas/EventResource" - $ref: "#/components/parameters/createdAtBefore" - $ref: "#/components/parameters/createdAtStrictlyBefore" - $ref: "#/components/parameters/createdAtAfter" - $ref: "#/components/parameters/createdAtStrictlyAfter" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" /events/{id}: get: tags: - Events operationId: GetEvent summary: Retrieve an event description: Retrieve a single event by ID, including the event type and resource data captured when the event was created. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/Event" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/events: get: tags: - Events operationId: ListEntityEvents summary: List an entity's events description: List recent events for a specific entity. parameters: - $ref: "#/components/parameters/entityId" - name: type in: query description: Filter events by type (exact match) schema: $ref: "#/components/schemas/EventType" - name: source in: query description: Filter events by source (exact match) schema: $ref: "#/components/schemas/EventSource" - name: resource in: query description: Filter events by resource (exact match) schema: $ref: "#/components/schemas/EventResource" - $ref: "#/components/parameters/createdAtBefore" - $ref: "#/components/parameters/createdAtStrictlyBefore" - $ref: "#/components/parameters/createdAtAfter" - $ref: "#/components/parameters/createdAtStrictlyAfter" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/EventCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /extractions: post: tags: - Extractions operationId: CreateExtraction summary: Create an extraction description: | Create an extraction for a specific entity, extractor, and options. If an equivalent extraction is already `pending` or `running` for the same entity, extractor, and options, the API returns `409 Conflict` instead of starting a duplicate. Retrieve the in-progress extraction to track its status rather than retrying the request. x-codeSamples: - lang: bash label: Invoice source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d","extractor":"invoice","options":{"period":{"from":"2024-01-01","to":"2024-12-31"},"types":["I","E","P"],"issued":true,"received":true,"pdf":true,"xml":true}}' - lang: bash label: Tax retention source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d","extractor":"tax_retention","options":{"period":{"from":"2024-01-01","to":"2024-12-31"},"issued":true,"received":true}}' - lang: bash label: Annual tax return source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d","extractor":"annual_tax_return","options":{"period":{"from":"2020-01-01","to":"2024-12-31"}}}' - lang: bash label: Monthly tax return source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d","extractor":"monthly_tax_return","options":{"period":{"from":"2024-01-01","to":"2024-12-31"}}}' - lang: bash label: RIF tax return source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d","extractor":"rif_tax_return","options":{"period":{"from":"2024-01-01","to":"2024-12-31"}}}' - lang: bash label: Electronic accounting source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d","extractor":"electronic_accounting","options":{"period":{"from":"2023-01-01","to":"2024-12-31"}}}' - lang: bash label: RPC source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/91106968-1abd-4d64-85c1-4e73d96fb997","extractor":"rpc","options":{"nameThreshold":0.9,"nameLimit":25}}' - lang: bash label: Buró de Crédito report source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/91106968-1abd-4d64-85c1-4e73d96fb997","extractor":"buro_de_credito_report","options":{"productType":"INFORME_BURO"}}' - lang: bash label: Tax status source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d","extractor":"tax_status"}' - lang: bash label: Tax compliance source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d","extractor":"tax_compliance"}' - lang: bash label: SAT certificates source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/7b3a25a9-a53a-4846-abe6-f2574c9c2d5d","extractor":"sat_certificates"}' - lang: bash label: BIL source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/91106968-1abd-4d64-85c1-4e73d96fb997","extractor":"bil"}' - lang: bash label: RUG source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/91106968-1abd-4d64-85c1-4e73d96fb997","extractor":"rug"}' - lang: bash label: Background Check source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/91106968-1abd-4d64-85c1-4e73d96fb997","extractor":"background_check"}' - lang: bash label: Infonavit source: >- curl --request POST 'https://api.syntage.com/extractions' --header 'Content-Type: application/json' --header 'X-API-Key: YOUR_API_KEY' --data '{"entity":"/entities/91106968-1abd-4d64-85c1-4e73d96fb997","extractor":"infonavit"}' requestBody: $ref: "#/components/requestBodies/ExtractionCreate" responses: "202": $ref: "#/components/responses/Extraction" "400": $ref: "#/components/responses/ConstraintViolation" "401": $ref: "#/components/responses/Unauthorized" "409": $ref: "#/components/responses/DuplicateExtraction" get: tags: - Extractions operationId: ListExtraction summary: List all extractions description: List extraction tasks and filter them by entity, extractor, status, dates, or SAT rate limit state. responses: "200": $ref: "#/components/responses/ExtractionCollection" "401": $ref: "#/components/responses/Unauthorized" parameters: - name: taxpayer.id in: query description: Filter by RFC (Registro Federal de Contribuyentes, exact match) schema: type: string minLength: 12 maxLength: 13 example: PEIC211118IS0 - name: extractor in: query description: Filter by extractor (partial match) example: invoice schema: $ref: "#/components/schemas/ExtractionExtractor" - name: status in: query description: Filter by status (exact match) schema: $ref: "#/components/schemas/ExtractionStatus" - name: startedAt[before] in: query description: Filter by start date (less than or equal `<=`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: startedAt[strictly_before] in: query description: Filter by start date (less than `<`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: startedAt[after] in: query description: Filter by start date (greater than or equal `>=`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: startedAt[strictly_after] in: query description: Filter by start date (greater than `>`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: finishedAt[before] in: query description: Filter by finished date (less than or equal `<=`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: finishedAt[strictly_before] in: query description: Filter by finished date (less than `<`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: finishedAt[after] in: query description: Filter by finished date (greater than or equal `>=`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: finishedAt[strictly_after] in: query description: Filter by finished date (greater than `>`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: exists[rateLimitedAt] in: query description: Filter extractions that was rate limited by SAT example: "1" schema: type: boolean example: true - $ref: "#/components/parameters/createdAtBefore" - $ref: "#/components/parameters/createdAtStrictlyBefore" - $ref: "#/components/parameters/createdAtAfter" - $ref: "#/components/parameters/createdAtStrictlyAfter" - name: order[startedAt] in: query description: Order by start date schema: $ref: "#/components/schemas/CollectionOrder" - name: order[finishedAt] in: query description: Order by finished date schema: $ref: "#/components/schemas/CollectionOrder" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/orderUpdatedAt" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" /extractions/{id}: get: tags: - Extractions operationId: GetExtraction summary: Retrieve an extraction description: Retrieve a single extraction, including its extractor, options, status, timing, error code, and data point counts. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/Extraction" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /extractions/{id}/stop: delete: tags: - Extractions operationId: StopExtraction summary: Request the extraction to be stopped description: Request cancellation for a pending or running extraction. parameters: - $ref: "#/components/parameters/resourceId" responses: "204": description: Extraction stopping process started "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/{id}: get: tags: - DS MX SAT Invoices operationId: GetInvoice summary: Retrieve an invoice description: | Retrieve an invoice by ID, including SAT identifiers, issuer and receiver details, totals, payment status, file availability, and invoice relationships. parameters: - $ref: "#/components/parameters/invoiceId" responses: "200": $ref: "#/components/responses/InvoiceCollectionItem" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/{id}/tags: post: tags: - DS MX SAT Invoices operationId: TagInvoice summary: Tag an invoice description: | Add a tag to an invoice. parameters: - $ref: "#/components/parameters/resourceId" requestBody: $ref: "#/components/requestBodies/TagInvoice" responses: "200": $ref: "#/components/responses/Invoice" "401": $ref: "#/components/responses/Unauthorized" /invoices/{invoiceId}/tags/{tagId}: delete: tags: - DS MX SAT Invoices operationId: UntagInvoice summary: Untag an invoice description: | Remove a tag from an invoice. parameters: - name: invoiceId in: path required: true example: 91106968-1abd-4d64-85c1-4e73d96fb997 schema: type: string format: uuid - name: tagId in: path required: true example: 018d9dd9-459f-768e-bc55-a8a72d0d3e9a schema: type: string format: uuid responses: "204": description: Untagged invoice "401": $ref: "#/components/responses/Unauthorized" /invoices/batch/tags: post: tags: - DS MX SAT Invoices operationId: TagInvoicesBatch summary: Tag multiple invoices description: | Add one or more tags to up to 100 invoices in a single request. The operation is atomic: if any invoice or tag in the request cannot be found, no invoice is modified. Tags the invoice already has are kept as-is, so retrying the same request is safe. requestBody: $ref: "#/components/requestBodies/TagInvoicesBatch" responses: "201": $ref: "#/components/responses/TagInvoicesBatch" "401": $ref: "#/components/responses/Unauthorized" "404": description: An invoice or tag in the request was not found "422": description: Validation error, e.g. empty lists or more than 100 invoices / 50 tags /invoices/batch/tags/remove: post: tags: - DS MX SAT Invoices operationId: UntagInvoicesBatch summary: Untag multiple invoices description: | Remove one or more tags from up to 100 invoices in a single request. The operation is atomic: if any invoice or tag in the request cannot be found, no invoice is modified. Tags an invoice does not have are ignored, so retrying the same request is safe. requestBody: $ref: "#/components/requestBodies/TagInvoicesBatch" responses: "201": $ref: "#/components/responses/TagInvoicesBatch" "401": $ref: "#/components/responses/Unauthorized" "404": description: An invoice or tag in the request was not found "422": description: Validation error, e.g. empty lists or more than 100 invoices / 50 tags /invoices/{id}/cfdi: get: tags: - DS MX SAT Invoices operationId: GetInvoiceCFDI summary: Retrieve an invoice's CFDI description: | Retrieve the invoice CFDI in the requested format. By default, this endpoint returns the CFDI parsed from XML to JSON. Set `Accept: text/xml` to retrieve the original XML file, or `Accept: application/pdf` to retrieve the PDF representation when one is available. parameters: - $ref: "#/components/parameters/invoiceId" - name: Accept in: header schema: type: string description: | This header controls the output format: - **text/xml:** Original XML file - **application/pdf:** Original PDF file (XML's visual representation) - **application/json:** Original XML file converted to JSON enum: - text/xml - application/pdf - application/json default: application/json responses: "200": $ref: "#/components/responses/InvoiceCFDI" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /datasources/mx/sat/cfdis/{uuid}: get: tags: - DS MX SAT Invoices operationId: GetMxSatCfdi summary: Retrieve a SAT CFDI description: | Retrieve parsed SAT CFDI data by invoice UUID. When `X-Async-Process` is set to `1`, the endpoint can return `202 Accepted` while CFDI parsing continues asynchronously. parameters: - name: uuid in: path required: true description: Invoice UUID schema: type: string format: uuid example: def404af-5eef-4112-aa99-d1ec8493b89a - name: X-Async-Process in: header required: false description: Set to `1` to request asynchronous processing when the CFDI has not been parsed yet schema: type: string enum: - "0" - "1" default: "0" responses: "200": description: Parsed SAT CFDI response content: application/ld+json: schema: $ref: "#/components/schemas/MxSatCfdi" "202": description: CFDI parsing accepted content: application/json: schema: type: object properties: message: type: string description: Processing status message example: The CFDI is being processed and will be available soon. Please try again later. "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/payments: get: tags: - DS MX SAT Invoice Payments summary: List all invoice payments description: | List invoice payments applied to deferred invoices. operationId: ListPayment parameters: - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/InvoicePaymentCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /schedulers/rules: post: tags: - Scheduler Rules operationId: CreateSchedulerRule summary: Create a scheduler rule description: Create a rule that runs an extractor on a scheduler. requestBody: $ref: "#/components/requestBodies/SchedulerRuleCreate" responses: "202": $ref: "#/components/responses/SchedulerRule" "401": $ref: "#/components/responses/Unauthorized" /schedulers/rules/{id}: get: tags: - Scheduler Rules summary: Retrieve a scheduler rule operationId: GetTSchedulerRule description: Retrieve a scheduler rule by ID. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/SchedulerRule" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" put: tags: - Scheduler Rules summary: Update a scheduler rule operationId: UpdateSchedulerRule description: Update the extractor, options, or cron expression for a scheduler rule. parameters: - $ref: "#/components/parameters/resourceId" requestBody: $ref: "#/components/requestBodies/SchedulerRuleUpdate" responses: "200": $ref: "#/components/responses/SchedulerRule" "401": $ref: "#/components/responses/Unauthorized" delete: tags: - Scheduler Rules summary: Delete a scheduler rule operationId: DeleteSchedulerRule description: Delete a scheduler rule. parameters: - $ref: "#/components/parameters/resourceId" responses: "204": description: Scheduler rule resource deleted "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /schedulers: post: tags: - Schedulers operationId: CreateScheduler summary: Create a scheduler description: Create a scheduler that can run one or more extraction rules. requestBody: $ref: "#/components/requestBodies/SchedulerCreate" responses: "202": $ref: "#/components/responses/Scheduler" "401": $ref: "#/components/responses/Unauthorized" get: tags: - Schedulers summary: List schedulers description: | List all schedulers. operationId: ListSchedulers parameters: - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/SchedulerCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /schedulers/{id}: get: tags: - Schedulers summary: Retrieve a scheduler operationId: GetTScheduler description: Retrieve a scheduler by ID, including its rules and tags. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/Scheduler" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" put: tags: - Schedulers summary: Update a scheduler operationId: UpdateScheduler description: Update a scheduler's name or enabled state. parameters: - $ref: "#/components/parameters/resourceId" requestBody: $ref: "#/components/requestBodies/SchedulerUpdate" responses: "200": $ref: "#/components/responses/Scheduler" "401": $ref: "#/components/responses/Unauthorized" delete: tags: - Schedulers summary: Delete a scheduler operationId: DeleteScheduler description: Delete a scheduler. parameters: - $ref: "#/components/parameters/resourceId" responses: "204": description: Scheduler resource deleted "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/credit-notes: get: tags: - DS MX SAT Credit Notes summary: List credit notes description: | List credit notes related to invoices. operationId: ListInvoiceCreditNotes parameters: - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/InvoiceCreditNoteCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/invoices/credit-notes: get: tags: - DS MX SAT Credit Notes summary: List an entity's credit notes description: | List credit notes extracted for an entity. operationId: ListEntityInvoiceCreditNotes parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/InvoiceCreditNoteCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/credit-notes/{id}: get: tags: - DS MX SAT Credit Notes summary: Retrieve an invoice credit note operationId: GetInvoiceCreditNote description: | Retrieve a credit note by ID, including the issued invoice, applied invoice, amount, and cancellation status. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/InvoiceCreditNote" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/{invoiceId}/issued-credit-notes: get: tags: - DS MX SAT Credit Notes summary: List an invoice's issued credit notes operationId: ListInvoiceIssuedCreditNotes description: | List credit notes issued by the requested invoice. parameters: - $ref: "#/components/parameters/invoiceId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/InvoiceCreditNoteCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/{invoiceId}/applied-credit-notes: get: tags: - DS MX SAT Credit Notes summary: List an invoice's applied credit notes operationId: ListInvoiceAppliedCreditNotes description: | List credit notes applied to the requested invoice. parameters: - $ref: "#/components/parameters/invoiceId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/InvoiceCreditNoteCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/payments/{id}: get: tags: - DS MX SAT Invoice Payments summary: Retrieve an invoice payment operationId: GetInvoicePayment description: | Retrieve an invoice payment by ID, including the deferred invoice, batch payment, amount, balance, and cancellation status. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/InvoicePayment" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/batch-payments: get: tags: - DS MX SAT Invoice Batch Payments summary: List all invoice batch payments description: | List batch payments derived from invoice payment receipts. operationId: ListBatchPayment parameters: - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/InvoiceBatchPaymentCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/batch-payments/{id}: get: tags: - DS MX SAT Invoice Batch Payments summary: Retrieve an invoice batch payment operationId: GetInvoiceBatchPayment description: | Retrieve an invoice batch payment by ID, including transaction-level payment details and related invoice payments. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/InvoiceBatchPayment" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /tax-retentions/{id}: get: tags: - DS MX SAT Tax Retentions summary: Retrieve a tax retention operationId: GetTaxRetention description: | Retrieve a tax retention by ID, including issuer, receiver, retained taxes, fiscal period, totals, and file availability. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/TaxRetention" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /tax-retentions/{id}/cfdi: get: tags: - DS MX SAT Tax Retentions operationId: GetTaxRetentionCFDI summary: Retrieve a tax retention CFDI description: | Retrieve the tax retention CFDI in the requested format. By default, this endpoint returns the CFDI parsed from XML to JSON. Set `Accept: text/xml` to retrieve the original XML file, or `Accept: application/pdf` to retrieve the PDF representation when one is available. parameters: - $ref: "#/components/parameters/invoiceId" - name: Accept in: header schema: type: string description: | This header controls the output format: - **text/xml:** Original XML file - **application/pdf:** Original PDF file (XML's visual representation) - **application/json:** Original XML file converted to JSON enum: - text/xml - application/pdf - application/json default: application/json responses: "200": $ref: "#/components/responses/TaxRetentionCFDI" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/tax-retentions: get: tags: - DS MX SAT Tax Retentions operationId: ListTaxpayerTaxRetention summary: List an entity's tax retentions description: | List tax retentions extracted for an entity. parameters: - $ref: "#/components/parameters/entityId" - name: uuid in: query description: Filter by UUID/Folio Fiscal (exact match) schema: $ref: "#/components/schemas/TaxRetentionUUID" - name: version in: query description: Filter by CFDI version (exact match) example: 1 schema: $ref: "#/components/schemas/TaxRetentionVersion" - name: internalIdentifier in: query description: Internal identifier (exact match) example: 1495494 schema: $ref: "#/components/schemas/TaxRetentionInternalIdentifier" - name: pac in: query description: Filter by certification provider (partial match) schema: $ref: "#/components/schemas/TaxRetentionPac" - name: code in: query description: Filter by code (exact match) schema: $ref: "#/components/schemas/TaxRetentionCode" - name: issuer.rfc in: query example: AOM920820BEA description: Filter by issuer RFC (partial match) schema: $ref: "#/components/schemas/TaxpayerID" - name: issuer.name in: query description: Filter by issuer name (partial match) example: Apple schema: $ref: "#/components/schemas/TaxpayerName" - name: issuer.curp in: query description: Filter by issuer CURP (partial match) example: APPL91021XXXXXXXXX schema: $ref: "#/components/schemas/TaxpayerCurp" - name: receiver.rfc in: query description: Filter by receiver RFC (partial match) schema: $ref: "#/components/schemas/TaxpayerID" - name: receiver.name in: query description: Filter by receiver name (partial match) example: Pedro schema: $ref: "#/components/schemas/TaxpayerName" - name: receiver.curp in: query description: Filter by receiver CURP (partial match) example: PESL9127XXXXXXXXXX schema: $ref: "#/components/schemas/TaxpayerCurp" - name: receiver.nationality in: query description: Filter by receiver nationality (exact match) example: foreign schema: $ref: "#/components/schemas/TaxpayerNationality" - name: totalOperationAmount[between] in: query description: Filter by total operation amount between two values example: 12.99..15.99 schema: type: string - name: totalOperationAmount[gt] in: query description: Filter by total operation amount (greater than `>`) example: 12.99 schema: type: number - name: totalOperationAmount[gte] in: query description: Filter by total operation amount (greater than or equal `>=`) example: 12.99 schema: type: number - name: totalOperationAmount[lt] in: query description: Filter by total operation amount (less than `<`) example: 15.99 schema: type: number - name: totalOperationAmount[lte] in: query description: Filter by total operation amount (less than or equal `<=`) example: 15.99 schema: type: number - name: totalTaxableAmount[between] in: query description: Filter by total taxable amount between two values example: 12.99..15.99 schema: type: string - name: totalTaxableAmount[gt] in: query description: Filter by total taxable amount (greater than `>`) example: 12.99 schema: type: number - name: totalTaxableAmount[gte] in: query description: Filter by total taxable amount (greater than or equal `>=`) example: 12.99 schema: type: number - name: totalTaxableAmount[lt] in: query description: Filter by total taxable amount (less than `<`) example: 15.99 schema: type: number - name: totalTaxableAmount[lte] in: query description: Filter by total taxable amount (less than or equal `<=`) example: 15.99 schema: type: number - name: totalExemptAmount[between] in: query description: Filter by total exempt amount between two values example: 12.99..15.99 schema: type: string - name: totalExemptAmount[gt] in: query description: Filter by total exempt amount (greater than `>`) example: 12.99 schema: type: number - name: totalExemptAmount[gte] in: query description: Filter by total exempt amount (greater than or equal `>=`) example: 12.99 schema: type: number - name: totalExemptAmount[lt] in: query description: Filter by total exempt amount (less than `<`) example: 15.99 schema: type: number - name: totalExemptAmount[lte] in: query description: Filter by total exempt amount (less than or equal `<=`) example: 15.99 schema: type: number - name: totalRetainedAmount[between] in: query description: Filter by total retained amount between two values example: 12.99..15.99 schema: type: string - name: totalRetainedAmount[gt] in: query description: Filter by total retained amount (greater than `>`) example: 12.99 schema: type: number - name: totalRetainedAmount[gte] in: query description: Filter by total retained amount (greater than or equal `>=`) example: 12.99 schema: type: number - name: totalRetainedAmount[lt] in: query description: Filter by total retained amount (less than `<`) example: 15.99 schema: type: number - name: totalRetainedAmount[lte] in: query description: Filter by total retained amount (less than or equal `<=`) example: 15.99 schema: type: number - name: issuedAt[before] in: query description: Filter by issue date (less than or equal `<=`) schema: $ref: "#/components/schemas/TaxRetentionIssuedAt" - name: issuedAt[strictly_before] in: query description: Filter by issue date (less than `<`) schema: $ref: "#/components/schemas/TaxRetentionIssuedAt" - name: issuedAt[after] in: query description: Filter by issue date (greater than or equal `>=`) schema: $ref: "#/components/schemas/TaxRetentionIssuedAt" - name: issuedAt[strictly_after] in: query description: Filter by issue date (greater than `>`) schema: $ref: "#/components/schemas/TaxRetentionIssuedAt" - name: canceledAt[before] in: query description: Filter by cancellation date (less than or equal `<=`) schema: $ref: "#/components/schemas/TaxRetentionCanceledAt" - name: canceledAt[strictly_before] in: query description: Filter by cancellation date (less than `<`) schema: $ref: "#/components/schemas/TaxRetentionCanceledAt" - name: canceledAt[after] in: query description: Filter by cancellation date (greater than or equal `>=`) schema: $ref: "#/components/schemas/TaxRetentionCanceledAt" - name: canceledAt[strictly_after] in: query description: Filter by cancellation date (greater than `>`) schema: $ref: "#/components/schemas/TaxRetentionCanceledAt" - name: certifiedAt[before] in: query description: Filter by certification date (less than or equal `<=`) schema: $ref: "#/components/schemas/TaxRetentionCertifiedAt" - name: certifiedAt[strictly_before] in: query description: Filter by certification date (less than `<`) schema: $ref: "#/components/schemas/TaxRetentionCertifiedAt" - name: certifiedAt[after] in: query description: Filter by certification date (greater than or equal `>=`) schema: $ref: "#/components/schemas/TaxRetentionCertifiedAt" - name: certifiedAt[strictly_after] in: query description: Filter by certification date (greater than `>`) schema: $ref: "#/components/schemas/TaxRetentionCertifiedAt" - name: periodFrom[before] in: query description: Filter by "period from" date (less than or equal `<=`) schema: $ref: "#/components/schemas/TaxRetentionPeriodFrom" - name: periodFrom[strictly_before] in: query description: Filter by "period from" date (less than `<`) schema: $ref: "#/components/schemas/TaxRetentionPeriodFrom" - name: periodFrom[after] in: query description: Filter by "period from" date (greater than or equal `>=`) schema: $ref: "#/components/schemas/TaxRetentionPeriodFrom" - name: periodFrom[strictly_after] in: query description: Filter by "period from" date (greater than `>`) schema: $ref: "#/components/schemas/TaxRetentionPeriodFrom" - name: periodTo[before] in: query description: Filter by "period to" date (less than or equal `<=`) schema: $ref: "#/components/schemas/TaxRetentionPeriodTo" - name: periodTo[strictly_before] in: query description: Filter by "period to" date (less than `<`) schema: $ref: "#/components/schemas/TaxRetentionPeriodTo" - name: periodTo[after] in: query description: Filter by "period to" date (greater than or equal `>=`) schema: $ref: "#/components/schemas/TaxRetentionPeriodTo" - name: periodTo[strictly_after] in: query description: Filter by "period to" date (greater than `>`) schema: $ref: "#/components/schemas/TaxRetentionPeriodTo" - name: hasXml in: query description: Filter by tax retentions that have the CFDI available in XML format example: true schema: $ref: "#/components/schemas/TaxRetentionHasXML" - name: hasPdf in: query description: Filter by tax retentions that have the CFDI available in PDF format example: true schema: $ref: "#/components/schemas/TaxRetentionHasPDF" - name: order[issuedAt] in: query description: Order by issue date schema: $ref: "#/components/schemas/CollectionOrder" - name: order[canceledAt] in: query description: Order by cancellation date schema: $ref: "#/components/schemas/CollectionOrder" - name: order[certifiedAt] in: query description: Order by certification date schema: $ref: "#/components/schemas/CollectionOrder" - name: order[periodFrom] in: query description: Order by "period from" date schema: $ref: "#/components/schemas/CollectionOrder" - name: order[periodTo] in: query description: Order by "period to" date schema: $ref: "#/components/schemas/CollectionOrder" - name: order[totalOperationAmount] in: query description: Order by total operation amount date schema: $ref: "#/components/schemas/CollectionOrder" - name: order[totalTaxableAmount] in: query description: Order by total taxable amount date schema: $ref: "#/components/schemas/CollectionOrder" - name: order[totalExemptAmount] in: query description: Order by total exempt amount date schema: $ref: "#/components/schemas/CollectionOrder" - name: order[totalRetainedAmount] in: query description: Order by total retained amount date schema: $ref: "#/components/schemas/CollectionOrder" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/TaxpayerTaxRetentionCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities: get: tags: - Entities operationId: ListEntity summary: List all entities description: List entities in your organization and filter by RFC, name, person type, or dates. parameters: - name: isFavorite in: query description: Filter by the authenticated user's favorite state. schema: type: boolean - name: taxpayer.id in: query description: Filter by RFC (Registro Federal de Contribuyentes, partial match) schema: type: string minLength: 12 maxLength: 13 example: PEIC211118IS0 - name: taxpayer.name in: query description: Filter by taxpayer name (partial match) example: Pedro Infante schema: $ref: "#/components/schemas/TaxpayerName" - name: type in: query description: Filter by entity type (exact match) schema: $ref: "#/components/schemas/EntityType" - name: taxpayer.personType in: query description: Filter by taxpayer type (exact match) schema: $ref: "#/components/schemas/TaxpayerPersonType" - name: extractions.datasource in: query description: Entities with at least one extraction from the datasource (exact match). Combined with `extractions.status`, both conditions apply to the same extraction. schema: $ref: "#/components/schemas/DatasourceName" - name: extractions.status in: query description: Entities with at least one extraction in the status (exact match). `waiting` lists the entities whose extraction is blocked on a requirement they must fulfil, such as SAT credentials or a Buró de Crédito authorization. schema: $ref: "#/components/schemas/ExtractionStatus" - name: taxpayer.registrationDate[before] in: query description: Filter by taxpayer registration date (less than or equal `<=`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: taxpayer.registrationDate[strictly_before] in: query description: Filter by taxpayer registration date (less than `<`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: taxpayer.registrationDate[after] in: query description: Filter by taxpayer registration date (greater than or equal `>=`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - name: taxpayer.registrationDate[strictly_after] in: query description: Filter by taxpayer registration date (greater than `>`) example: "2020-01-17 11:47:27" schema: type: string format: date-time - $ref: "#/components/parameters/createdAtBefore" - $ref: "#/components/parameters/createdAtStrictlyBefore" - $ref: "#/components/parameters/createdAtAfter" - $ref: "#/components/parameters/createdAtStrictlyAfter" - $ref: "#/components/parameters/updatedAtBefore" - $ref: "#/components/parameters/updatedAtStrictlyBefore" - $ref: "#/components/parameters/updatedAtAfter" - $ref: "#/components/parameters/updatedAtStrictlyAfter" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/orderUpdatedAt" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/EntityCollection" "401": $ref: "#/components/responses/Unauthorized" post: tags: - Entities operationId: AddEntity summary: Add an Entity description: | Add an entity to your organization. If `datasources` contains one or more datasources, Syntage creates first-time extractions for the selected datasources. When a selected datasource has first-time scheduler rules, those rules determine which extractors and options are used. For selected datasources not covered by first-time scheduler rules, Syntage creates first-time extractions for the datasource's available extractors using the options from the request, or the extractor defaults. Omit `datasources` or send an empty array to create the entity without starting extractions. `name` is optional when you provide a valid RFC. If omitted or null, Syntage resolves the entity's legal name from taxpayer data during creation and stores that name on the entity. If no name is available for the RFC, the request fails with a validation error on `name` using the code `rfc_valid_no_name_on_file`; retry with an explicit `name` to create the entity. requestBody: content: application/json: schema: type: object required: - type properties: name: type: [string, "null"] writeOnly: true description: Entity name. Optional when `rfc` is provided; when omitted or null, Syntage resolves the legal name from taxpayer data during entity creation. example: Syntage rfc: type: string writeOnly: true description: Entity RFC if known; if it is not input here, extractions that require the RFC wait until the entity provides the RFC example: SAT970701NN3 type: type: string writeOnly: true description: Entity type, either company or person. When `rfc` is provided, the type must match it; a 12-character RFC belongs to a company and a 13-character RFC to a person. example: company enum: - company - person datasources: type: array writeOnly: true description: Datasources to extract for the new entity example: items: type: object required: - name properties: name: $ref: "#/components/schemas/DatasourceName" options: type: object description: Datasource options; these mirror extraction options identifiers: type: array writeOnly: true description: Optional country-specific identifiers to add to the entity items: $ref: "#/components/schemas/EntityIdentifierCreateInput" metadata: type: object writeOnly: true description: Optional entity metadata. In sandbox, use `sandbox.taxRegime` to shape the simulated fiscal profile and `sandbox.backgroundCheck` to shape the simulated background check findings; omit them to let sandbox decide stably per entity. Production accepts and persists this metadata but does not interpret it because sandbox extractors are unavailable there. properties: sandbox: type: object properties: taxRegime: type: integer description: Sandbox fiscal profile. Person entities support 605, 612, 621, 625, and 626; company entities support 601 and 626. When omitted, sandbox assigns one of the supported regimes for the entity type. enum: - 601 - 605 - 612 - 621 - 625 - 626 backgroundCheck: type: string description: Sandbox background check profile for the court records, adverse media, blacklists, and politically exposed persons extractors. `flagged` makes every source find the entity (several court cases with their publication history, one in the criminal matter, adverse media articles, a blacklist listing, and an office for a person entity); `clean` makes every source find nothing. When omitted, each source decides stably per entity. enum: - clean - flagged responses: "201": description: Add entity resource response content: application/ld+json: schema: type: object required: - id - name properties: "@context": type: string default: /contexts/EntityAddedResponse id: type: string example: "5c7c3ac7-5c49-49f4-be0a-7824bfcf3060" name: type: string example: Syntage rfc: type: string example: XAXX010101000 "onboardingUrl": type: string example: https://onboarding.syntage.com/onboarding/018f3f8f-4538-7bbb-b432-9e97e34a564a description: | Onboarding URL returned when Syntage still needs input from the entity to complete setup, such as a missing `rfc` or a required credential. If the request already provides everything Syntage needs to resolve the entity (for example, a valid `rfc`), this field is omitted or empty because no onboarding step is required. Onboarding URLs do not expire. "400": $ref: "#/components/responses/AddEntityConstraintViolation" "401": $ref: "#/components/responses/Unauthorized" /entities/{entityId}: get: tags: - Entities operationId: GetEntity summary: Retrieve an Entity description: Retrieve a single entity by ID, including taxpayer, credential, and tag information when available. parameters: - $ref: "#/components/parameters/entityId" responses: "200": $ref: "#/components/responses/Entity" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" patch: tags: - Entities operationId: UpdateEntity summary: Update an Entity description: Update an entity. Sending `tags` replaces the entity's existing tag assignments with the provided collection. parameters: - $ref: "#/components/parameters/entityId" requestBody: $ref: "#/components/requestBodies/EntityUpdate" responses: "200": $ref: "#/components/responses/Entity" "401": $ref: "#/components/responses/Unauthorized" delete: tags: - Entities summary: Delete an Entity operationId: DeleteEntity description: Delete an entity and the data associated with that entity. The entity's events stay available for the same 7 days as any other event. parameters: - $ref: "#/components/parameters/entityId" responses: "204": description: Entity resource deleted "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/favorites: post: tags: [Entities] operationId: FavoriteEntities summary: Add one or more entities to personal favorites description: Requires entity access and applies only to the authenticated user. Repeated requests are safe. Read-only users may use JWT authentication. requestBody: required: true content: application/json: schema: type: object required: [entities] additionalProperties: false properties: entities: type: array minItems: 1 maxItems: 100 description: Entity IRIs; duplicates are processed once. The entire batch fails if any entity is missing or inaccessible. items: type: string format: iri-reference example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997 responses: "204": description: Favorite state applied atomically; no response body "400": description: Invalid request or batch size, or an entity IRI that is invalid, missing, or inaccessible; no favorites changed "401": $ref: "#/components/responses/Unauthorized" "404": description: Entity access denied; no favorites changed delete: tags: [Entities] operationId: UnfavoriteEntities summary: Remove one or more entities from personal favorites description: Requires entity access and applies only to the authenticated user. Repeated requests are safe. Read-only users may use JWT authentication. requestBody: required: true content: application/json: schema: type: object required: [entities] additionalProperties: false properties: entities: type: array minItems: 1 maxItems: 100 description: Entity IRIs; duplicates are processed once. The entire batch fails if any entity is missing or inaccessible. items: type: string format: iri-reference example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997 responses: "204": description: Favorite state applied atomically; no response body "400": description: Invalid request or batch size, or an entity IRI that is invalid, missing, or inaccessible; no favorites changed "401": $ref: "#/components/responses/Unauthorized" "404": description: Entity access denied; no favorites changed /entities/batch/tags: post: tags: - Entities operationId: TagEntitiesBatch summary: Tag multiple entities description: | Add one or more tags to up to 100 entities in a single request. Tag IRIs are accepted in both the `/entity-tags/{id}` and `/link-tags/{id}` forms. The operation is atomic: if any entity or tag in the request cannot be found, no entity is modified. Tags an entity already has are kept as-is, so retrying the same request is safe. requestBody: $ref: "#/components/requestBodies/TagEntitiesBatch" responses: "201": $ref: "#/components/responses/TagEntitiesBatch" "401": $ref: "#/components/responses/Unauthorized" "404": description: An entity or tag in the request was not found "422": description: Validation error, e.g. empty lists or more than 100 entities / 50 tags /entities/batch/tags/remove: post: tags: - Entities operationId: UntagEntitiesBatch summary: Untag multiple entities description: | Remove one or more tags from up to 100 entities in a single request. Tag IRIs are accepted in both the `/entity-tags/{id}` and `/link-tags/{id}` forms. The operation is atomic: if any entity or tag in the request cannot be found, no entity is modified. Tags an entity does not have are ignored, so retrying the same request is safe. requestBody: $ref: "#/components/requestBodies/TagEntitiesBatch" responses: "201": $ref: "#/components/responses/TagEntitiesBatch" "401": $ref: "#/components/responses/Unauthorized" "404": description: An entity or tag in the request was not found "422": description: Validation error, e.g. empty lists or more than 100 entities / 50 tags /entities/{entityId}/tags: get: tags: - Entities operationId: ListEntityTags summary: List an entity's tags description: List the tags assigned to a specific entity. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/EntityTagCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/identifiers: get: tags: - Entities operationId: ListEntityIdentifiers summary: List an entity's identifiers description: List country-specific identifiers for an entity, such as RFC or CURP for Mexico. parameters: - $ref: "#/components/parameters/entityId" responses: "200": $ref: "#/components/responses/EntityIdentifierCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" post: tags: - Entities operationId: AddEntityIdentifier summary: Add an entity identifier description: Add a country-specific identifier to an entity. parameters: - $ref: "#/components/parameters/entityId" requestBody: $ref: "#/components/requestBodies/EntityIdentifierCreate" responses: "201": $ref: "#/components/responses/EntityIdentifier" "400": $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entity-tags: get: tags: - Entities operationId: ListAllEntityTags summary: List all entity tags description: List entity tags that can be assigned to entities. parameters: - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/EntityTagCollection" "401": $ref: "#/components/responses/Unauthorized" post: tags: - Entities operationId: CreateEntityTag summary: Create an entity tag description: | Create a tag that can be assigned to entities. The created tag is returned with an `/entity-tags/{id}` IRI. requestBody: $ref: "#/components/requestBodies/EntityTagCreate" responses: "201": $ref: "#/components/responses/EntityTag" "401": $ref: "#/components/responses/Unauthorized" /entity-tags/{id}: get: tags: - Entities operationId: GetEntityTag summary: Retrieve an entity tag description: Retrieve a single entity tag by ID. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/EntityTag" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" patch: tags: - Entities operationId: UpdateEntityTag summary: Update an entity tag description: Update the display name for an entity tag. parameters: - $ref: "#/components/parameters/resourceId" requestBody: $ref: "#/components/requestBodies/EntityTagUpdate" responses: "200": $ref: "#/components/responses/EntityTag" "401": $ref: "#/components/responses/Unauthorized" delete: tags: - Entities summary: Delete an entity tag operationId: DeleteEntityTag description: Delete an entity tag. parameters: - $ref: "#/components/parameters/resourceId" responses: "204": description: Entity tag resource deleted "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /tags: get: tags: - Tags operationId: ListTags summary: List all tags description: List tags that can be assigned to supported resources. parameters: - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/TagCollection" "401": $ref: "#/components/responses/Unauthorized" post: tags: - Tags operationId: CreateTag summary: Create a tag description: Create a tag for a supported resource type. requestBody: $ref: "#/components/requestBodies/TagCreate" responses: "201": $ref: "#/components/responses/Tag" "401": $ref: "#/components/responses/Unauthorized" /tags/{id}: patch: tags: - Tags operationId: UpdateTag summary: Update a tag description: Update a tag's display name or color. parameters: - $ref: "#/components/parameters/resourceId" requestBody: $ref: "#/components/requestBodies/TagUpdate" responses: "200": $ref: "#/components/responses/Tag" "401": $ref: "#/components/responses/Unauthorized" delete: tags: - Tags summary: Delete a tag operationId: DeleteTag description: Delete a tag. parameters: - $ref: "#/components/parameters/resourceId" responses: "204": description: Tag resource deleted "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/{id}/payments: get: tags: - DS MX SAT Invoice Payments summary: List an invoice's payments description: | List payments applied to the requested invoice. operationId: ListInvoicePayment parameters: - $ref: "#/components/parameters/invoiceId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/InvoicePaymentCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/{id}/batch-payments: get: tags: - DS MX SAT Invoice Batch Payments summary: List an invoice's batch payments description: | List all batch payments related to the requested invoice. operationId: ListInvoiceBatchPayments parameters: - $ref: "#/components/parameters/invoiceId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/InvoiceBatchPaymentCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/line-items/{id}: get: tags: - DS MX SAT Invoice Line Items summary: Retrieve an invoice line item operationId: GetInvoiceLineItem description: | Retrieve an invoice line item by ID, including product, quantity, amount, and tax details. parameters: - name: id in: path required: true schema: type: string format: uuid description: Invoice Line Item ID example: 91106968-1abd-4d64-85c1-4e73d96fb997 responses: "200": description: Invoice Line Items response content: application/ld+json: schema: $ref: "#/components/schemas/InvoiceLineItem" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/relations/{id}: get: tags: - DS MX SAT Invoice Relations summary: Retrieve an invoice relation operationId: GetInvoiceRelation description: | Retrieve an invoice relation by ID, including the source invoice, related invoice, related invoice UUID, and SAT relation type. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": description: Invoice relation response content: application/ld+json: schema: $ref: "#/components/schemas/InvoiceRelation" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/{invoiceId}/relations: get: tags: - DS MX SAT Invoice Relations summary: List an invoice's relations operationId: ListInvoiceRelations description: | List invoice relations for the requested invoice. parameters: - $ref: "#/components/parameters/invoiceId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": description: Invoice relations collection response content: application/ld+json: schema: $ref: "#/components/schemas/InvoiceRelationCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/invoices/{invoiceId}/relations: get: tags: - DS MX SAT Invoice Relations summary: List an entity's invoice relations operationId: ListEntityInvoiceRelations description: | List invoice relations for an invoice within an entity. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/invoiceId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": description: Entity invoice relations collection response content: application/ld+json: schema: $ref: "#/components/schemas/InvoiceRelationCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /invoices/{invoiceId}/line-items: get: tags: - DS MX SAT Invoice Line Items summary: List an invoice's line items description: | List line items from the requested invoice. operationId: ListInvoiceLineItems parameters: - $ref: "#/components/parameters/invoiceId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": description: Invoice's Line Items collection response content: application/ld+json: schema: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/InvoiceLineItem "@id": default: /invoices/line-items "hydra:member": items: $ref: "#/components/schemas/InvoiceLineItem" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/invoices/line-items: get: tags: - DS MX SAT Invoice Line Items summary: List an entity's invoice line items description: | List invoice line items extracted for an entity. operationId: ListEntityInvoiceLineItems parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": description: Entity's Invoice Line Items collection response content: application/ld+json: schema: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/InvoiceLineItem "@id": example: /entities/91ab5678-1234-5678-9abc-def012345678/invoices/line-items "hydra:member": items: $ref: "#/components/schemas/InvoiceLineItem" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /datasources/mx/rpc/entidades/{id}: get: tags: - DS MX RPC Entidades operationId: GetRpcEntidades summary: Retrieve RPC entidade description: Retrieve one RPC entidade by ID, including the company profile, related actos, and related socios extracted from Registro Publico de Comercio. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/RpcEntidade" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /rpc/actos/{id}: get: tags: - DS MX RPC Actos operationId: GetRpcActo summary: Retrieve RPC acto description: Retrieve one RPC acto by ID, including registry act metadata, parsed act data, and file reference when a registry document is available. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/RpcActo" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /datasources/rpc/socios/{id}: get: tags: - DS MX RPC Socios operationId: GetRpcSocio summary: Retrieve RPC socio description: Retrieve one RPC socio by ID, including shareholder details and the RPC entidade profile it belongs to. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/RpcSocio" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /datasources/mx/addresses/{postalCode}: get: tags: - Mexico Addresses operationId: GetMxAddressesByPostalCode summary: Retrieve Mexico addresses by postal code description: Retrieve Mexico address options for a postal code. Buró de Crédito and Buró Empresas require submitted addresses to match the postal-code address catalog, and a postal code can return multiple neighborhoods. parameters: - name: postalCode in: path description: Five-digit Mexico postal code required: true schema: type: string minLength: 5 maxLength: 5 pattern: "^[0-9]{5}$" example: "11510" responses: "200": description: Mexico address options for the postal code content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/Collection" - type: object properties: "@context": example: /contexts/MxPostalCodeAddress "@id": example: /datasources/mx/addresses/11510 "hydra:member": type: array items: type: object properties: "@id": type: string format: iri-reference example: /.well-known/genid/f2d82cee1ffcca39dbd2 "@type": type: string default: MxPostalCodeAddress postalCode: type: string description: Five-digit Mexico postal code example: "11510" neighborhood: type: string description: Neighborhood or settlement name example: "Los Morales" neighborhoodType: type: string description: Type of neighborhood or settlement example: "Colonia" municipality: type: string description: Municipality or borough example: "Miguel Hidalgo" state: type: string description: State name example: "Ciudad de México" stateCode: type: string description: Three-letter state code example: "CMX" city: type: string description: City name example: "Cd de Mexico" officeKey: type: string description: Postal office key associated with the address example: "01234" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/datasources/syntage/score/calculate: post: tags: - DS Syntage Score operationId: CalculateSyntageScore summary: Start Syntage Score calculation description: | Start an asynchronous Syntage Score calculation for a company entity. The entity must have the annual tax return and tax compliance data required by the score model. If a required extraction is still running, wait for it to finish before starting the calculation. parameters: - $ref: "#/components/parameters/entityId" responses: "201": $ref: "#/components/responses/DatasourceMXSyntageScoreCalculate" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" "422": $ref: "#/components/responses/UnprocessableEntity" /datasources/rug/operaciones/{id}: get: tags: - DS MX RUG Operaciones operationId: GetRugOperacion summary: Retrieve RUG operation description: Retrieve one RUG operation by ID, including operation type, seat number, guarantee number, grantors, parsed boleta data, and file reference when available. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/RugOperacion" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /datasources/rug/garantias/{id}: get: tags: - DS MX RUG Garantias operationId: GetRugGarantia summary: Retrieve RUG guarantee description: Retrieve one RUG guarantee by ID, including collateral details, creditor, grantors, contract dates, and related operations. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/RugGarantia" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /tax-returns/{id}: get: tags: - DS MX SAT Tax Returns operationId: GetTaxReturn summary: Retrieve a tax return description: | Retrieve a tax return by ID, including filing metadata, payment information, file references, and ISSIF availability. parameters: - $ref: "#/components/parameters/taxReturnId" responses: "200": $ref: "#/components/responses/TaxReturn" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /tax-returns/{id}/pdf: get: tags: - DS MX SAT Tax Returns operationId: DownloadTaxReturnPdf summary: Download a tax return PDF description: | Download the SAT transcript PDF for a tax return. parameters: - $ref: "#/components/parameters/taxReturnId" responses: "200": description: Tax return PDF content: application/pdf: schema: type: string format: binary example: "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /tax-compliance-checks/{id}: get: tags: - DS MX SAT Tax Compliance Checks operationId: GetTaxComplianceCheck summary: Retrieve a tax compliance check description: | Retrieve a tax compliance check by ID, including the SAT compliance result and source PDF file. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/TaxComplianceCheck" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /tax-returns/{id}/data: get: tags: - DS MX SAT Tax Returns operationId: GetTaxReturnData summary: Retrieve tax return data description: | Retrieve extracted data from a tax return. For annual tax returns, there are two available formats: - Financial statements 2022 format - This is available for non-pfae tax returns. Data will only be returned if the SAT provides the XLSX financial statements document. - Financial statements 2014 format - This is available for pfae annual tax returns from 2014 to now, and all other annual tax returns from 2014-2021, as long as we are able to retrieve the PDF. Annual tax returns of the digital platforms regime (625) have no balance sheet, and their income figures are not in the financial statement keys. Their data is under `PLATAFORMAS TECNOLÓGICAS`, as declared in that section of the return: `INGRESOS` (the year's platform income, in total and by type of service), `DEDUCCIONES AUTORIZADAS`, `RESULTADO FISCAL` (fiscal profit or loss, profit sharing, prior-year losses, and taxable profit), `PAGOS PROVISIONALES`, `ISR RETENIDO` (withheld by the platforms), and `DETERMINACIÓN DEL IMPUESTO`, which covers all of the return's income. A value is `null` when the return does not include it. Annual tax returns that personas físicas file natively under the RESICO regime (626) have no financial statements, because RESICO taxes the income received without deductions. Their data is under `RÉGIMEN SIMPLIFICADO DE CONFIANZA`, as declared in that section of the return: `INGRESOS` (the income collected, discounts, returns and rebates, income to decrease, additional income, the total income received from the activity and its breakdown into professional services, business activity, and agricultural, livestock, forestry and fishing activities, exempt agricultural income, and taxable income), `BASE GRAVABLE`, `PAGOS MENSUALES`, `ISR RETENIDO POR PERSONAS MORALES`, and `DETERMINACIÓN DEL IMPUESTO` (`BASE GRAVABLE`, `TASA APLICABLE` as a percentage, `ISR CAUSADO`, `PAGOS MENSUALES`, `PAGOS EFECTUADOS CON ANTERIORIDAD`, `ISR RETENIDO`, and the resulting `A FAVOR` or `IMPUESTO A CARGO`). A value is `null` when the return does not include it. RESICO returns that use the PFAE layout keep their data in the PFAE financial statement keys. For provisional (monthly) tax returns, the response contains extracted financial variables including sales revenue, cash inflow, cash outflow, number of employees, and payroll amount. The available variables depend on the tax regime (601, 606, 612, 622, 625, 626). For the AGAPES regime (622), sales revenue and cash inflow are the month's income, as declared in its "Ingresos del periodo"; the other variables are not available for these declarations and are `null`. For the digital platforms regime (625), sales revenue and cash inflow are the month's platform income, and for rental-only declarations of the leasing regime (606) the month's rental income; the other variables are not available for these declarations and are `null`. Declarations that contain none of the variables, such as those that declare only taxes withheld from others, IEPS, ISR on distributed dividends, IVA on an occasional act, or a person's ISR on the sale of real estate, on an acquisition of goods through a notary, or on other income, return all of them as `null`. A `404` means the declaration's variables could not be read. The response format here may change if SAT changes the categories or other formatting in the files they provide. parameters: - $ref: "#/components/parameters/taxReturnId" responses: "200": $ref: "#/components/responses/TaxReturnData" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /tax-status: get: tags: - DS MX SAT Tax Status operationId: ListTaxStatus summary: List tax status records description: | List tax status records available to your organization. parameters: - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": description: Tax status collection response content: application/ld+json: schema: allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/TaxStatus "@id": default: /tax-status "hydra:member": items: $ref: "#/components/schemas/TaxStatus" "401": $ref: "#/components/responses/Unauthorized" /tax-status/{id}: get: tags: - DS MX SAT Tax Status operationId: GetTaxStatus summary: Retrieve a tax status description: | Retrieve a tax status record by ID, including identity, address, activities, regimes, obligations, and the source PDF file. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/TaxStatus" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /electronic-accounting-records/{id}: get: tags: - DS MX SAT Electronic Accounting operationId: GetElectronicAccountingRecord summary: Retrieve an electronic accounting record description: | Retrieve an electronic accounting record by ID, including fiscal period, accounting file type, status, and related files. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/ElectronicAccountingRecord" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/invoices: get: tags: - DS MX SAT Invoices operationId: ListTaxpayerInvoice summary: List an entity's invoices description: | List invoices extracted for an entity. parameters: - $ref: "#/components/parameters/entityId" - name: uuid in: query description: Filter by UUID/Folio Fiscal (exact match) schema: $ref: "#/components/schemas/InvoiceID" - name: version in: query description: Filter by CFDI version (exact match) example: 3.2 schema: $ref: "#/components/schemas/InvoiceVersion" - name: type in: query description: Filter by type (exact match) example: I schema: $ref: "#/components/schemas/InvoiceType" - name: usage in: query description: Filter by usage (exact match) example: G03 schema: $ref: "#/components/schemas/InvoiceUsage" - name: paymentType in: query description: Filter by payment type (exact match) schema: $ref: "#/components/schemas/InvoicePaymentType" - name: paymentMethod in: query description: Filter by payment method (exact match) schema: $ref: "#/components/schemas/InvoicePaymentMethod" - name: issuer.rfc in: query example: AOM920820BEA description: Filter by issuer RFC (partial match) schema: $ref: "#/components/schemas/TaxpayerID" - name: issuer.name in: query description: Filter by issuer name (partial match) example: Apple schema: $ref: "#/components/schemas/TaxpayerName" - name: issuer.taxRegime in: query description: Filter by issuer tax regime (partial match) schema: $ref: "#/components/schemas/InvoiceIssuerTaxRegime" - name: issuer.blacklistStatus in: query description: Filter by issuer blacklist status example: presumed schema: $ref: "#/components/schemas/TaxpayerBlacklistStatus" - name: isIssuer in: query description: Filter by whether the invoice issuer is the entity's RFC example: true schema: $ref: "#/components/schemas/InvoiceIsIssuer" - name: receiver.rfc in: query description: Filter by receiver RFC (partial match) schema: $ref: "#/components/schemas/TaxpayerID" - name: receiver.name in: query description: Filter by receiver name (partial match) example: Pedro schema: $ref: "#/components/schemas/TaxpayerName" - name: receiver.blacklistStatus in: query description: Filter by receiver blacklist status example: definitive schema: $ref: "#/components/schemas/TaxpayerBlacklistStatus" - name: isReceiver in: query description: Filter by whether the invoice receiver is the entity's RFC example: false schema: $ref: "#/components/schemas/InvoiceIsReceiver" - name: currency in: query description: Filter by currency code (exact match) schema: $ref: "#/components/schemas/InvoiceCurrency" - name: status in: query description: Filter by status (exact match) schema: $ref: "#/components/schemas/InvoiceStatus" - name: pac in: query description: Filter by certification provider (partial match) schema: $ref: "#/components/schemas/InvoicePac" - name: cancellationStatus in: query description: Filter by cancellation status (partial match) schema: $ref: "#/components/schemas/InvoiceCancellationStatus" - name: cancellationStatusProcess in: query description: Filter by cancellation process status (partial match) schema: $ref: "#/components/schemas/InvoiceCancellationStatusProcess" - name: issuedAt[before] in: query description: Filter by issue date (less than or equal `<=`) schema: $ref: "#/components/schemas/InvoiceIssuedAt" - name: issuedAt[strictly_before] in: query description: Filter by issue date (less than `<`) schema: $ref: "#/components/schemas/InvoiceIssuedAt" - name: issuedAt[after] in: query description: Filter by issue date (greater than or equal `>=`) schema: $ref: "#/components/schemas/InvoiceIssuedAt" - name: issuedAt[strictly_after] in: query description: Filter by issue date (greater than `>`) schema: $ref: "#/components/schemas/InvoiceIssuedAt" - name: canceledAt[before] in: query description: Filter by cancellation date (less than or equal `<=`) schema: $ref: "#/components/schemas/InvoiceCanceledAt" - name: canceledAt[strictly_before] in: query description: Filter by cancellation date (less than `<`) schema: $ref: "#/components/schemas/InvoiceCanceledAt" - name: canceledAt[after] in: query description: Filter by cancellation date (greater than or equal `>=`) schema: $ref: "#/components/schemas/InvoiceCanceledAt" - name: canceledAt[strictly_after] in: query description: Filter by cancellation date (greater than `>`) schema: $ref: "#/components/schemas/InvoiceCanceledAt" - name: createdAt[before] in: query description: Filter by creation date (less than or equal `<=`) schema: $ref: "#/components/schemas/createdAt" - name: createdAt[strictly_before] in: query description: Filter by creation date (less than `<`) schema: $ref: "#/components/schemas/createdAt" - name: createdAt[after] in: query description: Filter by creation date (greater than or equal `>=`) schema: $ref: "#/components/schemas/createdAt" - name: createdAt[strictly_after] in: query description: Filter by creation date (greater than `>`) schema: $ref: "#/components/schemas/createdAt" - name: updatedAt[before] in: query description: Filter by update date (less than or equal `<=`) schema: $ref: "#/components/schemas/updatedAt" - name: updatedAt[strictly_before] in: query description: Filter by update date (less than `<`) schema: $ref: "#/components/schemas/updatedAt" - name: updatedAt[after] in: query description: Filter by update date (greater than or equal `>=`) schema: $ref: "#/components/schemas/updatedAt" - name: updatedAt[strictly_after] in: query description: Filter by update date (greater than `>`) schema: $ref: "#/components/schemas/updatedAt" - name: certifiedAt[before] in: query description: Filter by certified date (less than or equal `<=`) schema: $ref: "#/components/schemas/InvoiceCertifiedAt" - name: certifiedAt[strictly_before] in: query description: Filter by certified date (less than `<`) schema: $ref: "#/components/schemas/InvoiceCertifiedAt" - name: certifiedAt[after] in: query description: Filter by certified date (greater than or equal `>=`) schema: $ref: "#/components/schemas/InvoiceCertifiedAt" - name: certifiedAt[strictly_after] in: query description: Filter by certified date (greater than `>`) schema: $ref: "#/components/schemas/InvoiceCertifiedAt" - name: lastPaymentDate[before] in: query description: Filter by last payment date (less than or equal `<=`) schema: $ref: "#/components/schemas/InvoiceLastPaymentDate" - name: lastPaymentDate[strictly_before] in: query description: Filter by last payment date (less than `<`) schema: $ref: "#/components/schemas/InvoiceLastPaymentDate" - name: lastPaymentDate[after] in: query description: Filter by last payment date (greater than or equal `>=`) schema: $ref: "#/components/schemas/InvoiceLastPaymentDate" - name: lastPaymentDate[strictly_after] in: query description: Filter by last payment date (greater than `>`) schema: $ref: "#/components/schemas/InvoiceLastPaymentDate" - name: fullyPaidAt[before] in: query description: Filter by fully paid date (less than or equal `<=`) schema: $ref: "#/components/schemas/InvoiceFullyPaidAt" - name: fullyPaidAt[strictly_before] in: query description: Filter by fully paid date (less than `<`) schema: $ref: "#/components/schemas/InvoiceFullyPaidAt" - name: fullyPaidAt[after] in: query description: Filter by fully paid date (greater than or equal `>=`) schema: $ref: "#/components/schemas/InvoiceFullyPaidAt" - name: fullyPaidAt[strictly_after] in: query description: Filter by fully paid date (greater than `>`) schema: $ref: "#/components/schemas/InvoiceFullyPaidAt" - name: tax[between] in: query description: Filter by tax between two values example: 12.99..15.99 schema: type: string - name: tax[gt] in: query description: Filter by tax (greater than `>`) example: 12.99 schema: type: number - name: tax[gte] in: query description: Filter by tax (greater than or equal `>=`) example: 12.99 schema: type: number - name: tax[lt] in: query description: Filter by tax (less than `<`) example: 15.99 schema: type: number - name: tax[lte] in: query description: Filter by tax (less than or equal `<=`) example: 15.99 schema: type: number - name: discount[between] in: query description: Filter by discount between two values example: 12.99..15.99 schema: type: string - name: discount[gt] in: query description: Filter by discount (greater than `>`) example: 12.99 schema: type: number - name: discount[gte] in: query description: Filter by discount (greater than or equal `>=`) example: 12.99 schema: type: number - name: discount[lt] in: query description: Filter by discount (less than `<`) example: 15.99 schema: type: number - name: discount[lte] in: query description: Filter by discount (less than or equal `<=`) example: 15.99 schema: type: number - name: subtotal[between] in: query description: Filter by subtotal between two values example: 12.99..15.99 schema: type: string - name: subtotal[gt] in: query description: Filter by subtotal (greater than `>`) example: 12.99 schema: type: number - name: subtotal[gte] in: query description: Filter by subtotal (greater than or equal `>=`) example: 12.99 schema: type: number - name: subtotal[lt] in: query description: Filter by subtotal (less than `<`) example: 15.99 schema: type: number - name: subtotal[lte] in: query description: Filter by subtotal (less than or equal `<=`) example: 15.99 schema: type: number - name: total[between] in: query description: Filter by total between two values example: 12.99..15.99 schema: type: string - name: total[gt] in: query description: Filter by total (greater than `>`) example: 12.99 schema: type: number - name: total[gte] in: query description: Filter by total (greater than or equal `>=`) example: 12.99 schema: type: number - name: total[lt] in: query description: Filter by total (less than `<`) example: 15.99 schema: type: number - name: total[lte] in: query description: Filter by total (less than or equal `<=`) example: 15.99 schema: type: number - name: paidAmount[between] in: query description: Filter by paidAmount between two values example: 12.99..15.99 schema: type: string - name: paidAmount[gt] in: query description: Filter by paidAmount (greater than `>`) example: 12.99 schema: type: number - name: paidAmount[gte] in: query description: Filter by paidAmount (greater than or equal `>=`) example: 12.99 schema: type: number - name: paidAmount[lt] in: query description: Filter by paidAmount (less than `<`) example: 15.99 schema: type: number - name: paidAmount[lte] in: query description: Filter by paidAmount (less than or equal `<=`) example: 15.99 schema: type: number - name: dueAmount[between] in: query description: Filter by dueAmount between two values example: 12.99..15.99 schema: type: string - name: dueAmount[gt] in: query description: Filter by dueAmount (greater than `>`) example: 12.99 schema: type: number - name: dueAmount[gte] in: query description: Filter by dueAmount (greater than or equal `>=`) example: 12.99 schema: type: number - name: dueAmount[lt] in: query description: Filter by dueAmount (less than `<`) example: 15.99 schema: type: number - name: dueAmount[lte] in: query description: Filter by dueAmount (less than or equal `<=`) example: 15.99 schema: type: number - name: hasXml in: query description: Filter by invoices that have the CFDI available in XML format example: true schema: $ref: "#/components/schemas/InvoiceHasXML" - name: hasPdf in: query description: Filter by invoices that have the CFDI available in PDF format example: true schema: $ref: "#/components/schemas/InvoiceHasPDF" - name: order[issuedAt] in: query description: Order by issue date schema: $ref: "#/components/schemas/CollectionOrder" - name: order[certifiedAt] in: query description: Order by certification date schema: $ref: "#/components/schemas/CollectionOrder" - name: order[amount] in: query description: Order by amount schema: $ref: "#/components/schemas/CollectionOrder" - name: exists[paymentMethod] in: query description: Filter invoices that contains or not paymentMethod schema: type: boolean example: true - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/TaxpayerInvoiceCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/tax-returns: get: tags: - DS MX SAT Tax Returns operationId: ListTaxpayerTaxReturn summary: List an entity's tax returns description: | List tax returns extracted for an entity. parameters: - $ref: "#/components/parameters/entityId" - name: operationNumber in: query description: Filter by operation number (partial match) schema: $ref: "#/components/schemas/TaxReturnOperationNumber" - name: type in: query description: Filter by type (exact match) schema: $ref: "#/components/schemas/TaxReturnType" - name: intervalUnit in: query description: Filter by interval unit (exact match) schema: $ref: "#/components/schemas/TaxReturnIntervalUnit" - name: complementary in: query description: Filter by interval unit (partial match) schema: $ref: "#/components/schemas/TaxReturnComplementary" - name: captureLine in: query description: Filter by payment code (partial match) schema: $ref: "#/components/schemas/TaxReturnCaptureLine" - name: period in: query description: Filter by period (exact match) schema: $ref: "#/components/schemas/TaxReturnPeriod" - name: presentedAt[before] in: query description: Filter by filing date (less than or equal `<=`) schema: $ref: "#/components/schemas/TaxReturnPresentedAt" - name: presentedAt[strictly_before] in: query description: Filter by filing date (less than `<`) schema: $ref: "#/components/schemas/TaxReturnPresentedAt" - name: presentedAt[after] in: query description: Filter by filing date (greater than or equal `>=`) schema: $ref: "#/components/schemas/TaxReturnPresentedAt" - name: presentedAt[strictly_after] in: query description: Filter by filing date (greater than `>`) schema: $ref: "#/components/schemas/TaxReturnPresentedAt" - name: fiscalYear in: query description: Filter by fiscal year (exact match) schema: $ref: "#/components/schemas/TaxReturnFiscalYear" - name: order[period] in: query description: Order by period schema: $ref: "#/components/schemas/CollectionOrder" - name: order[presentedAt] in: query description: Order by filing date schema: $ref: "#/components/schemas/CollectionOrder" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/TaxpayerTaxReturnCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/tax-compliance-checks: get: tags: - DS MX SAT Tax Compliance Checks operationId: ListTaxpayerTaxComplianceCheck summary: List an entity's tax compliance checks description: | List tax compliance checks extracted for an entity. parameters: - $ref: "#/components/parameters/entityId" - name: internalIdentifier in: query schema: $ref: "#/components/schemas/TaxComplianceCheckInternalIdentifier" - name: taxpayer.rfc in: query schema: $ref: "#/components/schemas/TaxpayerID" - name: taxpayer.name in: query schema: $ref: "#/components/schemas/TaxpayerName" - name: result in: query schema: $ref: "#/components/schemas/TaxComplianceCheckResult" - name: checkedAt[before] in: query description: Filter by check date (less than or equal `<=`) schema: $ref: "#/components/schemas/TaxComplianceCheckCheckedAt" - name: checkedAt[strictly_before] in: query description: Filter by check date (less than `<`) schema: $ref: "#/components/schemas/TaxComplianceCheckCheckedAt" - name: checkedAt[after] in: query description: Filter by check date (greater than or equal `>=`) schema: $ref: "#/components/schemas/TaxComplianceCheckCheckedAt" - name: checkedAt[strictly_after] in: query description: Filter by check date (greater than `>`) schema: $ref: "#/components/schemas/TaxComplianceCheckCheckedAt" - name: createdAt[before] in: query description: Filter by creation date (less than or equal `<=`) schema: $ref: "#/components/schemas/createdAt" - name: createdAt[strictly_before] in: query description: Filter by creation date (less than `<`) schema: $ref: "#/components/schemas/createdAt" - name: createdAt[after] in: query description: Filter by creation date (greater than or equal `>=`) schema: $ref: "#/components/schemas/createdAt" - name: createdAt[strictly_after] in: query description: Filter by creation date (greater than `>`) schema: $ref: "#/components/schemas/createdAt" - name: order[checkedAt] in: query description: Order by check date schema: $ref: "#/components/schemas/CollectionOrder" - name: order[createdAt] in: query description: Order by creation date schema: $ref: "#/components/schemas/CollectionOrder" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/TaxpayerTaxComplianceCheckCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/tax-status: get: tags: - DS MX SAT Tax Status operationId: ListTaxpayerTaxStatus summary: List an entity's tax status records description: | List tax status records extracted for an entity. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/TaxpayerTaxStatusCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/electronic-accounting-records: get: tags: - DS MX SAT Electronic Accounting operationId: ListElectronicAccountingRecords summary: List an entity's electronic accounting records description: | List electronic accounting records extracted for an entity. parameters: - $ref: "#/components/parameters/entityId" - name: year in: query description: Filter by year (exact match) schema: $ref: "#/components/schemas/ElectronicAccountingRecordYear" - name: month in: query description: Filter by month (exact match) schema: $ref: "#/components/schemas/ElectronicAccountingRecordMonth" - name: type in: query description: Filter by type (exact match) schema: $ref: "#/components/schemas/ElectronicAccountingRecordType" - name: reason in: query description: Filter by reason (exact match) schema: $ref: "#/components/schemas/ElectronicAccountingRecordReason" - name: fileType in: query description: Filter by file type (exact match) schema: $ref: "#/components/schemas/ElectronicAccountingRecordXmlFileType" - name: filename in: query description: Filter by filename (partial match) schema: $ref: "#/components/schemas/ElectronicAccountingRecordFilename" - name: code in: query description: Filter by code (exact match) schema: $ref: "#/components/schemas/ElectronicAccountingRecordCode" - name: receivedAt[before] in: query description: Filter by date received (less than or equal `<=`) schema: $ref: "#/components/schemas/ElectronicAccountingRecordReceivedAt" - name: receivedAt[strictly_before] in: query description: Filter by date received (less than `<`) schema: $ref: "#/components/schemas/ElectronicAccountingRecordReceivedAt" - name: receivedAt[after] in: query description: Filter by date received (greater than or equal `>=`) schema: $ref: "#/components/schemas/ElectronicAccountingRecordReceivedAt" - name: receivedAt[strictly_after] in: query description: Filter by date received (greater than `>`) schema: $ref: "#/components/schemas/ElectronicAccountingRecordReceivedAt" - name: status in: query description: Filter by status (exact match) schema: $ref: "#/components/schemas/ElectronicAccountingRecordStatus" - name: order[year] in: query description: Order by year schema: $ref: "#/components/schemas/CollectionOrder" - name: order[month] in: query description: Order by month schema: $ref: "#/components/schemas/CollectionOrder" - name: order[receivedAt] in: query description: Order by date received schema: $ref: "#/components/schemas/CollectionOrder" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/TaxpayerElectronicAccountingRecordCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/datasources/mx/rpc/entidades: get: tags: - DS MX RPC Entidades operationId: ListRpcEntidades summary: List an entity's RPC entidades description: List RPC entidades extracted for an entity. Use this endpoint after an `rpc` extraction finishes to review the RPC company records found for the entity. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - name: lookupBy in: query description: Filter by RPC lookup type (exact match) schema: $ref: "#/components/schemas/RpcEntidadeLookupBy" responses: "200": $ref: "#/components/responses/TaxpayerRpcEntidadeCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/datasources/mx/rpc/actos: get: tags: - DS MX RPC Actos operationId: ListEntityRpcActos summary: List an entity's RPC actos description: List RPC actos extracted for an entity. Use this endpoint when your integration needs individual registry acts rather than the complete RPC entidade response. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - name: rpcEntidade.lookupBy in: query description: Filter by the lookup type of the related RPC entidade (exact match) schema: $ref: "#/components/schemas/RpcEntidadeLookupBy" responses: "200": $ref: "#/components/responses/EntityRpcActoCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/datasources/rug/operaciones: get: tags: - DS MX RUG Operaciones operationId: ListRugOperaciones summary: List an entity's RUG operations description: List RUG operations extracted for an entity. Use this endpoint after a `rug` extraction finishes to review registry acts related to the entity's guarantees. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - name: numeroDeAsiento in: query schema: $ref: "#/components/schemas/RugOperacionNumeroDeAsiento" - name: tipo in: query schema: $ref: "#/components/schemas/RugOperacionTipo" - name: numeroDeGarantia in: query schema: $ref: "#/components/schemas/RugNumeroDeGarantia" - name: fecha[before] in: query schema: $ref: "#/components/schemas/RugOperacionFecha" - name: fecha[strictly_before] in: query schema: $ref: "#/components/schemas/RugOperacionFecha" - name: fecha[after] in: query schema: $ref: "#/components/schemas/RugOperacionFecha" - name: fecha[strictly_after] in: query schema: $ref: "#/components/schemas/RugOperacionFecha" - $ref: "#/components/parameters/createdAtAfter" - $ref: "#/components/parameters/createdAtStrictlyAfter" - $ref: "#/components/parameters/createdAtBefore" - $ref: "#/components/parameters/createdAtStrictlyBefore" - $ref: "#/components/parameters/updatedAtAfter" - $ref: "#/components/parameters/updatedAtStrictlyAfter" - $ref: "#/components/parameters/updatedAtBefore" - $ref: "#/components/parameters/updatedAtStrictlyBefore" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/orderUpdatedAt" responses: "200": $ref: "#/components/responses/TaxpayerRugOperacionCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/datasources/rug/garantias: get: tags: - DS MX RUG Garantias operationId: ListRugGarantias summary: List an entity's RUG guarantees description: List RUG guarantees extracted for an entity. Use this endpoint after a `rug` extraction finishes to review movable collateral guarantees found for the entity. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - name: numeroDeGarantia in: query schema: $ref: "#/components/schemas/RugNumeroDeGarantia" - name: acreedor in: query schema: $ref: "#/components/schemas/RugGarantiaAcreedor" - name: tipoDeGarantia in: query schema: $ref: "#/components/schemas/RugTipoDeGarantia" - name: moneda in: query schema: $ref: "#/components/schemas/RugGarantiaMoneda" - name: descripcionDeLosBienes in: query schema: $ref: "#/components/schemas/RugGarantiaDescripcionDeLosBienes" - name: fechaDeInscripcion[before] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeInscripcion" - name: fechaDeInscripcion[strictly_before] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeInscripcion" - name: fechaDeInscripcion[after] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeInscripcion" - name: fechaDeInscripcion[strictly_after] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeInscripcion" - name: fechaDeCancelacion[before] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeCancelacion" - name: fechaDeCancelacion[strictly_before] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeCancelacion" - name: fechaDeCancelacion[after] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeCancelacion" - name: fechaDeCancelacion[strictly_after] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeCancelacion" - name: fechaDeCelebracionDelActoOContrato[before] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeCelebracionDelActoOContrato" - name: fechaDeCelebracionDelActoOContrato[strictly_before] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeCelebracionDelActoOContrato" - name: fechaDeCelebracionDelActoOContrato[after] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeCelebracionDelActoOContrato" - name: fechaDeCelebracionDelActoOContrato[strictly_after] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeCelebracionDelActoOContrato" - name: fechaDeTerminacionDelActoOContrato[before] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeTerminacionDelActoOContrato" - name: fechaDeTerminacionDelActoOContrato[strictly_before] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeTerminacionDelActoOContrato" - name: fechaDeTerminacionDelActoOContrato[after] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeTerminacionDelActoOContrato" - name: fechaDeTerminacionDelActoOContrato[strictly_after] in: query schema: $ref: "#/components/schemas/RugGarantiaFechaDeTerminacionDelActoOContrato" - name: monto[between] in: query schema: $ref: "#/components/schemas/RugGarantiaMonto" - name: monto[gt] in: query schema: $ref: "#/components/schemas/RugGarantiaMonto" - name: monto[gte] in: query schema: $ref: "#/components/schemas/RugGarantiaMonto" - name: monto[lt] in: query schema: $ref: "#/components/schemas/RugGarantiaMonto" - name: monto[lte] in: query schema: $ref: "#/components/schemas/RugGarantiaMonto" - $ref: "#/components/parameters/createdAtAfter" - $ref: "#/components/parameters/createdAtStrictlyAfter" - $ref: "#/components/parameters/createdAtBefore" - $ref: "#/components/parameters/createdAtStrictlyBefore" - $ref: "#/components/parameters/updatedAtAfter" - $ref: "#/components/parameters/updatedAtStrictlyAfter" - $ref: "#/components/parameters/updatedAtBefore" - $ref: "#/components/parameters/updatedAtStrictlyBefore" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/orderUpdatedAt" responses: "200": $ref: "#/components/responses/TaxpayerRugGarantiaCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/invoices/payments: get: tags: - DS MX SAT Invoice Payments summary: List an entity's invoice payments operationId: ListTaxpayerPayment description: | List invoice payments extracted for an entity. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" responses: "200": $ref: "#/components/responses/InvoicePaymentCollection" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/accounts-payable: get: tags: - Accounts Payable Insight operationId: GetAccountsPayableInsight summary: Get accounts payable description: | Returns accounts payable data showing amounts due and paid over time, including cumulative totals. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time default: "2014-01-01T00:00:00.000Z" - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time default: now - name: options[periodicity] in: query description: The data set is grouped by this field schema: enum: - daily - weekly - monthly - quarterly - yearly type: string default: monthly responses: "200": description: Accounts Payable content: application/ld+json: schema: type: object properties: data: type: object properties: nonCumulative: description: Non-cumulative amounts due and paid per period type: array items: $ref: "#/components/schemas/AccountsPayableReceivableRow" cumulative: description: Cumulative amounts due over time type: array items: $ref: "#/components/schemas/AccountsPayableReceivableRow" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/accounts-receivable: get: tags: - Accounts Receivable Insight operationId: GetAccountsReceivableInsight summary: Get accounts receivable description: | Returns accounts receivable data showing amounts due and paid over time, including cumulative totals. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time default: "2014-01-01T00:00:00.000Z" - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time default: now - name: options[periodicity] in: query description: The data set is grouped by this field schema: enum: - daily - weekly - monthly - quarterly - yearly type: string default: monthly responses: "200": description: Accounts Receivable content: application/ld+json: schema: type: object properties: data: type: object properties: nonCumulative: description: Non-cumulative amounts due and paid per period type: array items: $ref: "#/components/schemas/AccountsPayableReceivableRow" cumulative: description: Cumulative amounts due over time type: array items: $ref: "#/components/schemas/AccountsPayableReceivableRow" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/cash-flow-stats: get: tags: - Cash Flow Insight operationId: GetCashFlowInsight summary: Get cash flow description: Inflows and outflows over time, derived from issued and received invoices. parameters: - $ref: "#/components/parameters/entityId" - name: options[periodicity] in: query description: The data set is grouped by this field schema: enum: - daily - weekly - monthly - quarterly - yearly type: string default: monthly - name: options[type] in: query description: Group series by type schema: enum: - total - payment-method - currency - invoice-type type: string default: total - name: options[from] in: query description: Filter by issuing date (greater than) schema: type: string format: date-time default: "2014-01-01T00:00:00.000Z" - name: options[to] in: query description: Filter by issuing date (less than) schema: type: string format: date-time default: now responses: "200": $ref: "#/components/responses/CashFlowInsight" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/rpc-shareholders: get: tags: - RPC Shareholders Insight operationId: GetRpcShareholdersInsight deprecated: true summary: Get RPC Shareholders (beta) description: | **Deprecated:** Use [Get Shareholders](/api-reference/shareholders-insight/get-shareholders) instead. Shareholder information is obtained from the Registro Público de Comercio (RPC) and, when available for the entity, from Company Verification reports. When at least one shareholder for the entity has been ingested from a Company Verification report, the response returns only the Company Verification-sourced shareholders, and ownership percentages reflect the values recorded on the verification report. Otherwise, the response falls back to RPC-sourced shareholders, with percentages computed from share counts. Please be aware of the following limitations: - Not all companies are included in the RPC data source. - While some companies are listed in RPC, their shareholder information may not be available. - RPC data only includes initial shareholders and does not reflect changes in the shareholder structure, such as new or removed shareholders. Use Company Verification reports to get an up-to-date cap table. parameters: - $ref: "#/components/parameters/entityId" responses: "200": $ref: "#/components/responses/RpcShareholdersInsight" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/shareholders: get: tags: - Shareholders Insight operationId: GetShareholdersInsight summary: Get shareholders description: | Returns a paginated shareholder insight for an entity. Use `relations.relationType=shareholders` to list the entity's shareholders. Use `relations.relationType=shareholder_of` to list entities that this shareholder owns shares in. When `relations.relationType=shareholders` and Company Verification-sourced shareholder data is available, the response returns Company Verification-sourced shareholder rows from the entity's most recent report instead of older RPC-sourced rows. If a relation has both Company Verification and manual sources, manually entered values take precedence. If no Company Verification-sourced shareholders are available, the response returns the available shareholder relations from other sources such as RPC or manually entered data. This endpoint replaces the deprecated RPC Shareholders insight. parameters: - $ref: "#/components/parameters/entityId" - name: relations.relationType in: query required: true description: Shareholder relation direction to return schema: type: string enum: - shareholders - shareholder_of example: shareholders - name: page in: query description: Page number for pagination schema: type: integer minimum: 1 default: 1 - name: itemsPerPage in: query description: Number of items per page schema: type: integer minimum: 1 maximum: 1000 default: 1000 responses: "200": $ref: "#/components/responses/ShareholdersInsight" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/metrics/shareholders: get: tags: - Shareholders Insight operationId: GetMetricsShareholdersInsight summary: Get shareholders metrics description: | Returns a paginated shareholder metrics insight for an entity. Use `relations.relationType=shareholders` to list the entity's shareholders. Use `relations.relationType=shareholder_of` to list entities that this shareholder owns shares in. For `relations.relationType=shareholders`, when Company Verification-sourced shareholder data is available, the response returns shareholder rows from the entity's most recent Company Verification report. If a relation has both Company Verification and manual sources, manually entered values take precedence. If no Company Verification-sourced shareholders are available, the response returns the available shareholder relations from other sources such as RPC or manually entered data. parameters: - $ref: "#/components/parameters/entityId" - name: relations.relationType in: query required: true description: Shareholder relation direction to return schema: type: string enum: - shareholders - shareholder_of example: shareholders - name: page in: query description: Page number for pagination schema: type: integer minimum: 1 default: 1 - name: itemsPerPage in: query description: Number of items per page schema: type: integer minimum: 1 maximum: 1000 default: 1000 responses: "200": $ref: "#/components/responses/ShareholdersInsight" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/corporate-structure/current-powers: get: tags: - Corporate Structure Insight operationId: GetCorporateStructureCurrentPowersInsight summary: Get current powers description: | List the people and companies that hold at least one currently effective power of attorney, drawn from the most recent Company Verification report registered for the entity. Each row carries the identity of a person or company with at least one currently effective power from the entity's most recent Company Verification report. Holders whose powers have all expired are omitted. To retrieve shareholders and the latest capital table from Company Verification, use the shareholders metrics insight at `/entities/{entityId}/insights/metrics/shareholders`. When the entity has no Company Verification report yet, the response is an empty collection (`hydra:totalItems` of `0`). parameters: - $ref: "#/components/parameters/entityId" - name: page in: query description: Page number for pagination schema: type: integer minimum: 1 default: 1 - name: itemsPerPage in: query description: Number of items per page schema: type: integer minimum: 1 maximum: 1000 default: 1000 responses: "200": description: Corporate Structure Current Powers Insight content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/Collection" - type: object properties: "@context": default: /contexts/CorporateStructureCurrentPowersEntityResponse "@id": example: /entities/91ab5678-1234-5678-9abc-def012345678/insights/corporate-structure/current-powers "hydra:member": type: array items: $ref: "#/components/schemas/CorporateStructureCurrentPowersEntity" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/metrics/balance-sheet: get: tags: - Balance Sheet Insight operationId: GetMetricsBalanceSheet summary: Get balance sheet metric description: | Returns the entity's balance sheet organized in a tree of categories. The structure of the category tree changes according to: - The tax regime. - The year format (the year when SAT changes the structure, i.e., a breaking change) Supported tax regimes: - **601** (Personas Morales) - **612** (PFAE/Personas Físicas con Actividades Empresariales y Profesionales) - **622** (Actividades Agrícolas, Ganaderas, Silvícolas y Pesqueras) - companies use the 601 tree. Available formats: - **2014** - the data is extracted from annual [tax returns](#tag/TaxReturns) transcript **PDFs**. - **2022** - the data is extracted from annual [tax returns](#tag/TaxReturns) financial statements **XLSXs**. - **audited-financial-statements** - the data is extracted from audited annual [tax returns](#tag/TaxReturns) financial statements **XLSMs**. - **issif-financial-statements** - the data is extracted from Informative Statements on Tax Situation (**ISSIF**) financial statements **XLSMs**. Notes: - The **Comment** field in the response body refers to the content of the **Nota** column in the **XLSX** or **XLSM**. - The **2021** data may be extracted from the 2022 document (in 2022 format). parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by fiscal year (greater than) schema: type: string format: date-time - name: options[to] in: query description: Filter by fiscal year (less than) schema: type: string format: date-time - name: X-Insight-Format in: header schema: type: string description: | This header selects the financial statement source format: - **2014:** Returns only data available in the 2014 format. - **2022:** Returns only data available in the 2022 format. - **audited-financial-statements:** Returns only data from audited annual tax returns. - **issif-financial-statements:** Returns only data from Informative Statements on Tax Situation (ISSIF). enum: - "2014" - "2022" - audited-financial-statements - issif-financial-statements responses: "200": $ref: "#/components/responses/BalanceSheetMetricInsight" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/metrics/income-statement: get: tags: - Income Statement Insight operationId: GetMetricsIncomeStatementInsight summary: Get metrics income statement description: | Returns the entity's income statement organized in a tree of categories. The structure of the category tree changes according to: - The tax regime. - The year format (the year when SAT changes the structure, i.e., a breaking change) Supported tax regimes: - **601** (Personas Morales) - **612** (PFAE/Personas Físicas con Actividades Empresariales y Profesionales) - **622** (Actividades Agrícolas, Ganaderas, Silvícolas y Pesqueras) - companies use the 601 tree. Their annual declaration, form F25, has no income statement. - **626** (RESICO/Régimen Simplificado de Confianza) - companies use the 601 tree. Persons use the 612 tree or, when the latest annual return of the period was filed natively under RESICO, a tree of its income received from the activity by type of activity, exempt and taxable income, taxable base, and ISR caused (2014 format only). Years filed in the other layout have no values in that tree. Available formats: - **2014** - the data is extracted from annual [tax returns](#tag/TaxReturns) transcript **PDFs**. - **2022** - the data is extracted from annual [tax returns](#tag/TaxReturns) financial statements **XLSXs**. - **audited-financial-statements** - the data is extracted from audited annual [tax returns](#tag/TaxReturns) financial statements **XLSMs**. - **issif-financial-statements** - the data is extracted from Informative Statements on Tax Situation (**ISSIF**) financial statements **XLSMs**. Notes: - The **Comment** field in the response body refers to the content of the **Nota** column in the **XLSX** or **XLSM**. - The **2021** data may be extracted from the 2022 document (in 2022 format). - In the **2022** format, matched `Utilidad`/`Pérdida` pairs (`bruta`, `de operación`, `antes de impuestos`, `neta`) are returned under a single grouping parent row, with each side of the pair as an entry in the parent's `children` array. The parent's per-year `Total` reflects the populated side (SAT fills only one side per period). The **2014** format keeps its original grouping behavior. - **Sign convention:** revenue, profit and other inflow lines are returned as positive values; cost, expense, loss, tax and financial-charge lines (for example `Costo de ventas`, `Gastos de operación`, `Pérdida neta`, `Impuestos a la utilidad`, `Intereses a cargo`) are returned as **negative** values. Net or mixed parents (for example `Resultado Integral de Financiamiento`) keep their natural sign. Do not apply additional negation to outflow lines — they already carry the correct sign. See the [2026-06-22 changelog entry](/changelog/2026-06-22-income-statement-outflow-signs) for migration details. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by fiscal year (greater than) schema: type: string format: date-time - name: options[to] in: query description: Filter by fiscal year (less than) schema: type: string format: date-time - name: X-Insight-Format in: header schema: type: string description: | This header selects the financial statement source format: - **2014:** Returns only data available in the 2014 format. - **2022:** Returns only data available in the 2022 format. - **audited-financial-statements:** Returns only data from audited annual tax returns. - **issif-financial-statements:** Returns only data from Informative Statements on Tax Situation (ISSIF). enum: - "2014" - "2022" - audited-financial-statements - issif-financial-statements responses: "200": $ref: "#/components/responses/IncomeStatementMetricsInsight" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/invoicing-concentration: get: tags: - Invoicing Concentration Insight operationId: GetInvoicingConcentrationInsight summary: Get invoicing concentration deprecated: true description: | **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. Returns the concentration (top 10) of issued or received invoices. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time - name: options[type] in: query description: Filter by issued or received invoices required: true schema: type: string enum: - issued - received responses: "200": $ref: "#/components/responses/InvoicingConcentrationInsight" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/trial-balance: get: tags: - Trial Balance Insight operationId: GetTrialBalanceInsight summary: Get trial balance description: | Returns all trial balances accounts matching on the account catalogs. If not present it will be tagged/grouped as '000 - Undefined'. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time - name: options[periodicity] in: query description: Filter by periodicity (yearly as default) required: false schema: type: string enum: - yearly - monthly responses: "200": $ref: "#/components/responses/TrialBalanceInsight" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/metrics/scores: get: tags: - Scores Insight operationId: GetScoresInsight summary: Get scores description: Entity scores aggregated from every configured score source (Syntage Score and any third-party rating providers enabled for the organization). parameters: - $ref: "#/components/parameters/entityId" responses: "200": $ref: "#/components/responses/ScoresInsight" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /insights/metrics/scores/syntage/distribution: get: tags: - Scores Insight operationId: GetSyntageScoreDistribution summary: Get Syntage Score distribution description: Get the distribution of current Syntage Score values across score buckets. responses: "200": description: Syntage Score distribution content: application/ld+json: schema: $ref: "#/components/schemas/ScoreDistribution" "401": $ref: "#/components/responses/Unauthorized" /entities/{entityId}/insights/metrics/buro-de-credito/summary: get: tags: - Scores Insight operationId: GetBuroDeCreditoSummaryInsight summary: Get Buró de Crédito summary description: List Buró de Crédito report score summaries for an entity. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by report creation date on or after this date schema: type: string default: "2014-01-01" - name: options[to] in: query description: Filter by report creation date on or before this date schema: type: string default: now responses: "200": description: Buró de Crédito summary content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/HydraView" - type: object properties: "@context": default: /contexts/BuroDeCreditoSummary "@id": example: /entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/insights/metrics/buro-de-credito/summary "hydra:member": type: array items: $ref: "#/components/schemas/BuroDeCreditoSummaryInsight" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/metrics/buro-de-credito/summary/export: get: tags: - Scores Insight operationId: ExportBuroDeCreditoSummaryInsight summary: Export Buró de Crédito summary description: Export Buró de Crédito report score summaries for an entity as CSV or XLSX. parameters: - $ref: "#/components/parameters/entityId" - name: Accept in: header required: true description: Export format to return schema: type: string enum: - text/csv - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - name: options[from] in: query description: Filter by report creation date on or after this date schema: type: string default: "2014-01-01" - name: options[to] in: query description: Filter by report creation date on or before this date schema: type: string default: now responses: "200": description: Buró de Crédito summary export content: text/csv: schema: type: string application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" "422": $ref: "#/components/responses/UnprocessableEntity" /entities/{entityId}/insights/{insight}/export: get: tags: - Insight Exports operationId: ExportInsight summary: Export an insight description: | Export a supported insight for an entity as CSV or XLSX. Use the same `options[...]` query parameters supported by the corresponding insight endpoint. Unsupported insight names return `404`. parameters: - $ref: "#/components/parameters/entityId" - name: insight in: path required: true description: Insight name to export schema: type: string example: sales-revenue - name: Accept in: header required: true description: Export format to return schema: type: string enum: - text/csv - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet responses: "200": description: Insight export content: text/csv: schema: type: string application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary "400": $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" "422": $ref: "#/components/responses/UnprocessableEntity" /webhook-endpoints: post: tags: - Webhook Endpoints operationId: CreateWebhookEndpoint description: | Create a webhook endpoint for your organization. Syntage delivers matching events to the endpoint URL using HTTPS `POST` requests. Delivery attempts are successful when your endpoint returns a `2xx` HTTP status code. A delivery that times out after 3 seconds, fails before Syntage receives a response, or returns a non-`2xx` status code is retried up to 4 times. summary: Create webhook endpoint requestBody: $ref: "#/components/requestBodies/WebhookEndpointCreate" responses: "202": $ref: "#/components/responses/WebhookEndpoint" "400": $ref: "#/components/responses/ConstraintViolation" "401": $ref: "#/components/responses/Unauthorized" get: tags: - Webhook Endpoints operationId: ListWebhookEndpoint description: List webhook endpoints configured for your organization. summary: List webhook endpoints responses: "200": $ref: "#/components/responses/WebhookEndpointCollection" "401": $ref: "#/components/responses/Unauthorized" parameters: - name: url description: Filter by endpoint URL using exact match in: query schema: $ref: "#/components/schemas/WebhookEndpointUrl" - name: events description: Filter by event type using exact match in: query schema: $ref: "#/components/schemas/WebhookEndpointEventType" - name: enabled in: query description: Filter by enabled state schema: $ref: "#/components/schemas/WebhookEndpointEnabled" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" /webhook-endpoints/{id}: get: tags: - Webhook Endpoints operationId: GetWebhookEndpoint description: Get a webhook endpoint by ID. summary: Retrieve webhook endpoint parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/WebhookEndpoint" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" put: tags: - Webhook Endpoints summary: Update webhook endpoint operationId: UpdateWebhookEndpoint description: Replace a webhook endpoint's URL, event subscriptions, enabled state, and content type. parameters: - $ref: "#/components/parameters/resourceId" requestBody: $ref: "#/components/requestBodies/WebhookEndpointUpdate" responses: "200": $ref: "#/components/responses/WebhookEndpoint" "400": $ref: "#/components/responses/ConstraintViolation" "401": $ref: "#/components/responses/Unauthorized" delete: tags: - Webhook Endpoints summary: Delete webhook endpoint operationId: DeleteWebhookEndpoint description: Delete a webhook endpoint so Syntage stops sending matching events to it. parameters: - $ref: "#/components/parameters/resourceId" responses: "204": description: Webhook endpoint deleted "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /webhook-requests: get: tags: - Webhook Requests operationId: ListWebhookRequest description: List webhook delivery attempts for your organization. summary: List webhook requests responses: "200": $ref: "#/components/responses/WebhookRequestCollection" "401": $ref: "#/components/responses/Unauthorized" parameters: - name: url description: Filter by endpoint URL using exact match in: query schema: $ref: "#/components/schemas/WebhookRequestUrl" - name: responseStatusCode description: Filter by response status code in: query schema: $ref: "#/components/schemas/WebhookRequestResponseStatusCode" - name: event.id description: Filter by event ID in: query schema: $ref: "#/components/schemas/uuid" - name: event.type description: Filter by event type in: query schema: $ref: "#/components/schemas/EventType" - name: event.source description: Filter by event source in: query schema: $ref: "#/components/schemas/EventSource" - name: event.resource description: Filter by event resource in: query schema: $ref: "#/components/schemas/EventResource" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" /webhook-requests/{id}: get: tags: - Webhook Requests operationId: GetWebhookRequest summary: Retrieve webhook request description: | Get a webhook delivery attempt by ID. Use the response status code, response time, related event, and endpoint details to investigate delivery behavior. ### 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 hash you can do the following steps: #### Step 1: Extract the timestamp and signature from the header Split the header, using the ` , ` character as the separator. The value for the prefix `t` corresponds to the timestamp and `s` corresponds to the signature. #### Step 2: Prepare the signed_payload string The signed_payload string is created by concatenating (without spaces): - The timestamp (as a string in Unix format) example: `"1656569160"` - The character `.` (dot) - The actual JSON payload (that is, the request body) #### Step 3: Determine the expected signature Compute an HMAC with the SHA256 hash function. Use the endpoint’s signing secret as the key, and use the signed_payload string as the message. #### Step 4: Compare the signatures Compare the signature (or signatures) in the header to the expected signature. For an equality match, compute the difference between the current timestamp and the received timestamp, then decide if the difference is within your tolerance. To protect against timing attacks, use a constant-time string comparison to compare the expected signature to each of the received signatures. #### Here is a code example using PHP with a constant-time string: ```php function splitString(string $separator, $stringValue): array { return explode($separator, $stringValue); } ## X-Satws-Signature $xSatSignatureHeader = 't=1656569160,s=527124c570b27b3f268777b2ba96a9bbdc4b0ecde2885f688beda528f39c4e23'; list($timestamp, $signature) = array_map(function($signatureParam){ return splitString('=', $signatureParam)[1]; }, splitString(',', $xSatSignatureHeader)); $bodyPayload = '{ "@context": "/contexts/Event", "@id": "/events/88a88df8-5c55-44a4-a222-ef9999c999", "@type": "Event", "id": "88a88df8-5c55-44a4-a222-ef9999c999", "type": "credential.updated", "source": None, "createdAt": "2022-06-29 20:14:09", "updatedAt": "2022-06-29 20:14:09" }'; $signingSecret = '320639996d9eee9178bf89d26cdbc23d'; $hash = hash_hmac('sha256', sprintf('%d.%s', $timestamp, $bodyPayload), $signingSecret); print strcmp($hash, $signature); ``` parameters: - $ref: "#/components/parameters/resourceId" responses: "200": $ref: "#/components/responses/WebhookRequest" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/customer-concentration: get: tags: - Customer Concentration Insight operationId: GetCustomerConcentrationInsight summary: Get customer invoice concentration description: | Returns the concentration of issued or received invoices by customers. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time responses: "200": description: Entity invoicing concentration content: application/ld+json: schema: type: array items: type: object properties: name: type: string description: Customer name example: ASOCIACIóN CERVANTES DE ÁNGELES S.A.B. rfc: $ref: "#/components/schemas/TaxpayerID" total: type: number description: Total amount of all invoices in the given period example: 118260.18 share: type: number description: Percentage representing the amount invoiced vs. the total sales in the selected period example: 16.1 transactions: type: array items: type: object properties: date: type: string format: date description: Date period example: 2014-01-01 total: type: number description: Total amount of all transactions in the given period example: 37578.456999999995 "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/supplier-concentration: get: tags: - Vendor Concentration Insight operationId: GetVendorConcentrationInsight summary: Get vendor invoice concentration description: | Returns the concentration of issued or received invoices by vendors. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time responses: "200": description: Vendor invoicing concentration content: application/ld+json: schema: type: array items: type: object properties: name: type: string description: Supplier name example: CORPORACIóN ALVARADO-TORRES S.A.B. rfc: $ref: "#/components/schemas/TaxpayerID" total: type: number description: Total amount of all invoices in the given period example: 118260.18 share: type: number description: Percentage representing the amount invoiced vs. the total sales in the selected period example: 16.1 transactions: type: array items: type: object properties: date: type: string format: date description: Date period example: 2014-01-01 total: type: number description: Total amount of all transactions in the given period example: 37578.456999999995 "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/moratory-interest: get: tags: - Moratory Interest Insight operationId: GetMoratoryInterestInsight summary: Get moratory interest description: | Returns moratory-interest charges for the entity, aggregated from received financial-institution invoices. The response includes summary KPIs, monthly totals, monthly totals by financial institution, and institution-level totals. If no period is provided, the insight defaults to the last 12 full months. Charges are read from the last 18 full months, excluding the current month. Months of the requested period outside that window have no charges in the response: they appear as `0` in `monthly` and are not counted in `summary.periodTotal`, `monthlyByInstitution`, or `institutions`. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Start date of the period to analyze. schema: type: string format: date-time example: "2025-01-01T00:00:00.000Z" - name: options[to] in: query description: End date of the period to analyze. schema: type: string format: date-time example: "2025-12-31T23:59:59.999Z" responses: "200": description: Moratory Interest content: application/ld+json: schema: type: object properties: summary: type: object description: Summary KPIs for moratory-interest charges. properties: lastMonthTotal: type: number description: Total moratory interest in the last full month. example: 1250.75 threeMonthAverage: type: number description: Average monthly moratory interest over the last three full months. example: 940.25 twelveMonthTotal: type: number description: Total moratory interest over the last 12 full months. example: 18250.5 yoyThreeMonthPercentage: type: [number, "null"] description: Year-over-year percentage change for the latest three-month window. example: 18.45 lastMonthVsThreeMonthPercentage: type: [number, "null"] description: Percentage change between the last full month and the latest three-month average. example: 33.02 trendPercentage: type: [number, "null"] description: Trend percentage over the recent monthly series. example: 12.3 isRecurring: type: boolean description: Whether moratory-interest charges are recurring in the analyzed window. example: true institutionCount: type: integer description: Number of financial institutions charging moratory interest over the 12-month window. example: 2 periodTotal: type: number description: Total moratory interest for the selected period. example: 18250.5 periodInstitutionCount: type: integer description: Number of financial institutions charging moratory interest in the selected period. example: 2 periodFrom: type: string format: date description: Start date of the selected period. example: "2025-01-01" periodTo: type: string format: date description: End date of the selected period. example: "2025-12-31" monthly: type: array description: Monthly moratory-interest totals for the selected period. items: type: object properties: date: type: string format: date description: First day of the month. example: "2025-01-01" totalAmount: type: number description: Total moratory interest for the month. example: 1250.75 monthlyByInstitution: type: array description: Monthly moratory-interest totals broken down by financial institution. items: type: object properties: date: type: string format: date description: First day of the month. example: "2025-01-01" issuerRfc: $ref: "#/components/schemas/TaxpayerID" issuerName: type: string description: Financial institution's name as in the invoice. example: BANCO EJEMPLO SA legalName: type: [string, "null"] description: Legal name from the financial institutions catalog. example: BANCO EJEMPLO SA INSTITUCION DE BANCA MULTIPLE tradeName: type: [string, "null"] description: Trade or commercial name from the financial institutions catalog. example: Banco Ejemplo totalAmount: type: number description: Total moratory interest for this month from this institution. example: 1250.75 institutions: type: array description: Financial institution aggregates over the 12-month window, sorted by total amount descending. items: type: object properties: issuerRfc: $ref: "#/components/schemas/TaxpayerID" issuerName: type: [string, "null"] description: Financial institution's name as in the invoice. example: BANCO EJEMPLO SA legalName: type: [string, "null"] description: Legal name from the financial institutions catalog. example: BANCO EJEMPLO SA INSTITUCION DE BANCA MULTIPLE tradeName: type: [string, "null"] description: Trade or commercial name from the financial institutions catalog. example: Banco Ejemplo totalAmount: type: number description: Total moratory interest over the 12-month window. example: 18250.5 "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/employees: get: tags: - Employees Insight operationId: GetEmployeesInsight summary: Get employees description: Number of employees per period, derived from distinct payroll (CFDI Nómina) recipients. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time - name: options[periodicity] in: query description: The data set is grouped by this field schema: enum: - daily - weekly - monthly - quarterly - yearly type: string default: monthly responses: "200": description: Employees content: application/ld+json: schema: type: object properties: data: description: Employee counts per period type: array items: type: object properties: total: description: Number of employees in this period type: integer format: int32 example: 5 metric: description: Number of employees in this period. Same value as `total`. type: integer format: int32 example: 5 date: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. deprecated: true type: string example: "202408" dateLabel: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. Human-readable label for the period. deprecated: true type: string example: 2024/Aug startDate: description: The start date of the period in `YYYY-MM-DD` format. type: string format: date example: "2024-08-01" dimension: description: Always `"total"`. This insight does not support other dimensions. type: string example: total label: description: Always `"total"`. Same value as `dimension`. type: string example: total "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/expenditures: get: tags: - Expenditures Insight operationId: GetExpendituresInsight summary: Get expenditures description: Money the entity has spent over time, aggregated from received income invoices. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time - name: options[periodicity] in: query description: The data set is grouped by this field schema: enum: - daily - weekly - monthly - quarterly - yearly type: string default: monthly - name: options[type] in: query description: The type of expenditure schema: enum: - total - currency - counterparty - invoice-type - payment-type type: string default: total responses: "200": description: Expenditures content: application/ld+json: schema: type: object properties: data: description: Expenditure data grouped by period and dimension type: array items: type: object properties: amount: description: Total amount in the original currency type: number example: 5938.88 mxnAmount: description: | **Deprecated.** Use `metric` instead. Amount converted to `MXN` using the exchange rate at the time the invoice was issued. deprecated: true type: number example: 114638.76 metric: description: Amount converted to `MXN` using the exchange rate at the time the invoice was issued. type: number example: 114638.76 transactions: description: Number of invoices processed to get this record type: integer example: 6 date: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. deprecated: true type: string example: "202408" dateLabel: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. Human-readable label for the period. deprecated: true type: string example: 2024/Aug startDate: description: The start date of the period in `YYYY-MM-DD` format. type: string format: date example: "2024-08-01" dimension: description: | The dimension value for the selected `options[type]` grouping. | `options[type]` | `dimension` values | | --- | --- | | `total` | `"total"` | | `currency` | ISO 4217 code — e.g. `MXN`, `USD`, `EUR` | | `counterparty` | Issuer RFC | | `invoice-type` | `" ()"` — e.g. `"Ingreso (I)"`, `"Egreso (E)"`, `"Pago (P)"`, `"Traslado (T)"`, `"Nómina (N)"`. Falls back to the raw abbreviation when no mapping exists. | | `payment-type` | `"PUE"` or `"PPD"` | Two sentinel values can also appear for any `options[type]`: - `"unknown"` — the underlying value was `NULL` in the database. - `"others"` — aggregation bucket for high-cardinality dimensions (`counterparty`) when a row's share of the period total is below 10%. type: string example: total label: description: Human-readable display label. Equal to `dimension` for most types; for `counterparty` it is the counterparty name followed by the RFC in parentheses. type: string example: total groupName: description: | **Deprecated.** Use `dimension` instead. Same value as `dimension`. deprecated: true type: string example: total stats: description: Data quality statistics per period, indicating how many invoices had the required fields for accurate calculation. type: array items: type: object properties: total: description: Total number of invoices in this period type: integer example: 50 hits: description: Number of invoices with sufficient data for accurate calculation type: integer example: 48 date: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. deprecated: true type: string example: "202408" dateLabel: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. Human-readable label for the period. deprecated: true type: string example: 2024/Aug startDate: description: The start date of the period in `YYYY-MM-DD` format type: string format: date example: "2024-08-01" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/financial-institutions: get: tags: - Financial Institutions Insight operationId: GetFinancialInstitutionsInsight summary: Get financial institutions description: Banks and other financial institutions the entity has transacted with, derived from CFDI payments and third-party accounts on invoices. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time responses: "200": description: Financial Institutions content: application/ld+json: schema: type: object properties: data: type: array items: type: object properties: rfc: $ref: "#/components/schemas/TaxpayerID" legalName: type: string description: Legal name example: CORPORACIóN ALVARADO-TORRES S.A.B. tradeName: type: string description: Commercial name example: CATR website: type: string description: Company website URL example: example.com sector: type: string description: Sector example: Instituciones de banca múltiple total: type: number description: Total amount of all transactions example: 14786.68 transactions: type: array items: type: object properties: date: type: string description: Date period example: 2014-01 total: type: integer description: Total amount of all transactions in given date period format: int32 example: 0 "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/financial-ratios: get: tags: - Financial Ratios Insight operationId: GetFinancialRatiosInsight summary: Get financial ratios description: Liquidity, leverage, profitability, and efficiency ratios computed per fiscal year from the entity's annual tax filings. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time responses: "200": description: Financial Ratios content: application/ld+json: schema: type: object properties: data: type: object properties: liquidity: type: object properties: current_ratio: type: object properties: "2014": type: number example: 2.170153630241602 "2015": type: number example: 3.9382332732421896 "2016": type: number example: 1.4433204505794686 "2017": type: number example: 1.4715106437701448 "2018": type: number example: 1.1730789739846177 "2019": type: number example: 2.3687243725981255 "2020": type: number example: 1.3305483243873792 quick_ratio: type: object properties: "2014": type: number example: 1.8293385448664694 "2015": type: number example: 3.292934792905369 "2016": type: number example: 1.2009179843461073 "2017": type: number example: 1.1939344402370429 "2018": type: number example: 0.9524613210383901 "2019": type: number example: 2.047362926655386 "2020": type: number example: 1.165771941991342 cash_ratio: type: object properties: "2014": type: number example: 0.8457322529202494 "2015": type: number example: 0.9863829458972141 "2016": type: number example: 0.4934330804148122 "2017": type: number example: 0.5376921355145503 "2018": type: number example: 0.357758593415979 "2019": type: number example: 0.7029122106845779 "2020": type: number example: 0.4280589983565223 cash_to_assets: type: object properties: "2014": type: number example: 0.8457322529202494 "2015": type: number example: 0.9863829458972141 "2016": type: number example: 0.4934330804148122 "2017": type: number example: 0.5376921355145503 "2018": type: number example: 0.357758593415979 "2019": type: number example: 0.7029122106845779 "2020": type: number example: 0.4280589983565223 net_working_capital_to_sales: type: object properties: "2014": type: number example: 0.8457322529202494 "2015": type: number example: 0.9863829458972141 "2016": type: number example: 0.4934330804148122 "2017": type: number example: 0.5376921355145503 "2018": type: number example: 0.357758593415979 "2019": type: number example: 0.7029122106845779 "2020": type: number example: 0.4280589983565223 activity: type: object properties: total_asset_turnover: type: object properties: "2014": type: number example: 0.7571560970807056 "2015": type: number example: 0.7877245363542329 "2016": type: number example: 2.3693977000910613 "2017": type: number example: 0.6628963317110973 "2018": type: number example: 0.8299941484739886 "2019": type: number example: 1.3275331009476332 "2020": type: number example: 0.5645231967194583 inventory_turnover: type: object properties: "2014": type: number example: 0.9355785151784264 "2015": type: number example: 0.7176644321323731 "2016": type: number example: 1.828113585829089 "2017": type: number example: 0.7805613367433604 "2018": type: number example: 0.6717572448950851 "2019": type: number example: 1.8946440989913522 "2020": type: number example: 0.7171407160576209 fixed_asset_turnover_ratio: type: object properties: "2014": type: number example: 0.9355785151784264 "2015": type: number example: 0.7176644321323731 "2016": type: number example: 1.828113585829089 "2017": type: number example: 0.7805613367433604 "2018": type: number example: 0.6717572448950851 "2019": type: number example: 1.8946440989913522 "2020": type: number example: 0.7171407160576209 sales_to_capital_employed: type: object properties: "2014": type: number example: 0.9355785151784264 "2015": type: number example: 0.7176644321323731 "2016": type: number example: 1.828113585829089 "2017": type: number example: 0.7805613367433604 "2018": type: number example: 0.6717572448950851 "2019": type: number example: 1.8946440989913522 "2020": type: number example: 0.7171407160576209 accounts_payable_payment_period: type: object properties: "2014": type: number example: 0.9355785151784264 "2015": type: number example: 0.7176644321323731 "2016": type: number example: 1.828113585829089 "2017": type: number example: 0.7805613367433604 "2018": type: number example: 0.6717572448950851 "2019": type: number example: 1.8946440989913522 "2020": type: number example: 0.7171407160576209 accounts_receivable_collection_period: type: object properties: "2014": type: number example: 0.9355785151784264 "2015": type: number example: 0.7176644321323731 "2016": type: number example: 1.828113585829089 "2017": type: number example: 0.7805613367433604 "2018": type: number example: 0.6717572448950851 "2019": type: number example: 1.8946440989913522 "2020": type: number example: 0.7171407160576209 profitability: type: object properties: return_on_assets: type: object properties: "2014": type: number example: 0.8909660418010791 "2015": type: number example: 0.9170198717865244 "2016": type: number example: 0.8867081841792085 "2017": type: number example: 0.8763975270414898 "2018": type: number example: 0.7464401447048928 "2019": type: number example: 0.8589579515876329 "2020": type: number example: 0.8023060035397855 return_on_equity: type: object properties: "2014": type: number example: 1.2206153800050163 "2015": type: number example: 0.9472091208246147 "2016": type: number example: 0.8345801104504675 "2017": type: number example: 1.4492972599256255 "2018": type: number example: 0.5783242083326875 "2019": type: number example: 1.0231983929814674 "2020": type: number example: 0.8401368179614076 return_on_sales: type: object properties: "2014": type: number example: 1.1767270252941127 "2015": type: number example: 1.1641377530661918 "2016": type: number example: 0.37423358018163444 "2017": type: number example: 1.3220732792098786 "2018": type: number example: 0.8993318158655498 "2019": type: number example: 0.6470331707544488 "2020": type: number example: 1.4212099842878454 gross_profit_margin: type: object properties: "2014": type: number example: 1.267320660225698 "2015": type: number example: 1.0523144011638075 "2016": type: number example: 0.5410234037399851 "2017": type: number example: 1.0225926594543397 "2018": type: number example: 1.2427611679673494 "2019": type: number example: 0.6312249227085254 "2020": type: number example: 1.5823179451948328 return_on_investment: type: object properties: "2014": type: number example: 1.1767270252941127 "2015": type: number example: 1.1641377530661918 "2016": type: number example: 0.37423358018163444 "2017": type: number example: 1.3220732792098786 "2018": type: number example: 0.8993318158655498 "2019": type: number example: 0.6470331707544488 "2020": type: number example: 1.4212099842878454 leverage: type: object properties: total_debt_ratio: type: object properties: "2014": type: number example: 0.2700681505443447 "2015": type: number example: 0.03187178878916228 "2016": type: number example: -0.062460239677416485 "2017": type: number example: 0.3952948430424381 "2018": type: number example: -0.29069496650829235 "2019": type: number example: 0.16051671163718226 "2020": type: number example: 0.04502934952121079 debt_equity_ratio: type: object properties: "2014": type: number example: 0.836600142459244 "2015": type: number example: 0.6650153634660437 "2016": type: number example: 1.3233877546014627 "2017": type: number example: 0.8459680150547594 "2018": type: number example: 0.9916920082233325 "2019": type: number example: 0.7331621821311222 "2020": type: number example: 0.9173805946813605 coverage: type: object properties: "2014": type: number example: 1.6967874814292707 "2015": type: number example: 0.6353417929046555 "2016": type: number example: 1.3123395940652847 "2017": type: number example: 1.0541585331655516 "2018": type: number example: 1.2425865404494898 "2019": type: number example: 1.249555054360737 "2020": type: number example: 0.7879005075830647 capital_intensity_ratio: type: object properties: "2014": type: number example: 1.3207316217297917 "2015": type: number example: 1.269479308881536 "2016": type: number example: 0.42204818547834655 "2017": type: number example: 1.5085315035893407 "2018": type: number example: 1.2048277711819788 "2019": type: number example: 0.7532768857410559 "2020": type: number example: 1.7714063935922786 solvency: type: object properties: "2014": type: number example: 1.3207316217297917 "2015": type: number example: 1.269479308881536 "2016": type: number example: 0.42204818547834655 "2017": type: number example: 1.5085315035893407 "2018": type: number example: 1.2048277711819788 "2019": type: number example: 0.7532768857410559 "2020": type: number example: 1.7714063935922786 interest_expense_to_sales: type: object properties: "2014": type: number example: 1.3207316217297917 "2015": type: number example: 1.269479308881536 "2016": type: number example: 0.42204818547834655 "2017": type: number example: 1.5085315035893407 "2018": type: number example: 1.2048277711819788 "2019": type: number example: 0.7532768857410559 "2020": type: number example: 1.7714063935922786 "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/government-customers: get: tags: - Government Customers Insight operationId: GetGovernmentCustomersInsight summary: Get government customers description: The entity's customers that are Mexican federal, state, or municipal government bodies, with each one's share of total revenue. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time responses: "200": description: Government customer content: application/ld+json: schema: type: object properties: data: type: array items: type: object properties: rfc: $ref: "#/components/schemas/TaxpayerID" fullName: type: string description: Legal name example: Pemex Exploración y Producción shortName: type: string description: Short name example: CATR website: type: string description: Company website URL example: example.com total: type: number description: Total amount of all transactions example: 14786.68 percentageOfSales: type: number description: Percentage of sales example: 0.8379419130473325 transactions: type: array items: type: object properties: date: type: string description: Date period example: 2014-01 total: type: integer description: Total amount of all transactions in given date period format: int32 example: 0 "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/invoicing-blacklist: get: tags: - Blacklisted Counterparties Insight operationId: GetInvoicingBlacklistInsight summary: Get blacklisted counterparties description: Counterparties on the SAT's Artículo 69-B blacklist (EFOS/EDOS) that the entity has transacted with, split between issuers and receivers. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time responses: "200": description: Blacklisted counterparties content: application/ld+json: schema: type: object properties: data: type: object properties: issued: type: array items: type: object properties: invoices: type: integer description: Number of invoices in which the blacklisted taxpayer was found format: int32 example: 1 taxpayer: type: object properties: rfc: $ref: "#/components/schemas/TaxpayerID" name: $ref: "#/components/schemas/TaxpayerName" blacklistStatus: $ref: "#/components/schemas/BlacklistStatusSource" received: type: array items: type: object properties: invoices: type: integer description: Number of invoices in which the blacklisted taxpayer was found format: int32 example: 1 taxpayer: type: object properties: rfc: $ref: "#/components/schemas/TaxpayerID" name: $ref: "#/components/schemas/TaxpayerName" blacklistStatus: $ref: "#/components/schemas/BlacklistStatusSource" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/risks: get: tags: - Risks Insight operationId: GetRisksInsight summary: Get risk calculations description: Risk indicators (concentration, foreign-currency exposure, cash-transaction share, insolvency, tax compliance, etc.) computed from the entity's invoicing, payments, and tax-filing data. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time responses: "200": description: Risks content: application/ld+json: schema: type: object properties: data: type: object properties: taxCompliance: type: object properties: value: type: string example: positive risky: type: boolean blacklistStatus: type: object properties: value: type: string format: nullable risky: type: boolean blacklistedCounterparties: type: object properties: value: type: integer format: int32 example: 4 risky: type: boolean intercompanyTransactions: type: object properties: value: type: number example: 0.486 risky: type: boolean customerConcentration: type: object properties: value: type: integer format: int32 example: 858 risky: type: boolean supplierConcentration: type: object properties: value: type: integer format: int32 example: 1008 risky: type: boolean foreignExchangeRisk: type: object properties: value: type: number example: 0.06 risky: type: boolean cashTransactionRisk: type: object properties: value: type: number example: 0.04 risky: type: boolean accountingInsolvency: type: object properties: value: type: number example: 1.14 risky: type: boolean canceledIssuedInvoices: type: object properties: value: type: number example: 0.1 risky: type: boolean canceledReceivedInvoices: type: object properties: value: type: number example: 0.1 risky: type: boolean moratoryInterest: type: object description: Moratory-interest risk indicator. This key is present when the moratory-interest insight is enabled. properties: value: type: number description: Total moratory interest for the selected period. example: 18250.5 risky: type: boolean description: Whether the total exceeds the configured threshold or the charges are recurring. example: true isRecurring: type: boolean description: Whether moratory-interest charges are recurring in the analyzed window. example: true institutionCount: type: integer description: Number of financial institutions charging moratory interest in the selected period. example: 2 ordinaryInterestTotal: type: number description: Total ordinary interest for the selected period. Present when ordinary-interest comparison is enabled. example: 92000 penaltyRatio: type: [number, "null"] description: Share of total credit cost paid as penalties, calculated as moratory interest divided by ordinary plus moratory interest. Present when ordinary-interest comparison is enabled. example: 0.1655 sharedInstitutionCount: type: integer description: Number of financial institutions charging both ordinary and moratory interest in the selected period. Present when ordinary-interest comparison is enabled. example: 1 "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/products-and-services-bought: get: tags: - Products and Services Insight operationId: GetProductsAndServicesBoughtInsight summary: Get products and services bought description: | Returns a paginated list of products and services bought by the entity, including transaction details and share percentages. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time default: "2014-01-01T00:00:00.000Z" - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time default: now - name: page in: query description: Page number for pagination schema: type: integer minimum: 1 default: 1 - name: itemsPerPage in: query description: Number of items per page schema: type: integer minimum: 1 maximum: 500 default: 100 responses: "200": description: Products and Services Bought content: application/ld+json: schema: type: object properties: hydra:member: type: array description: List of products and services bought items: type: object properties: name: type: string description: Product or service identification/description example: Software total: type: number description: Total amount spent on this product/service in MXN example: 87000 share: type: number description: Percentage share of total expenditure example: 72.41 transactions: type: array description: Transaction breakdown by period items: type: object properties: date: type: string description: Date period example: 2025-10 total: type: number description: Total amount for this period in MXN example: 87000 hydra:totalItems: type: integer description: Total number of products/services example: 1 "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/products-and-services-sold: get: tags: - Products and Services Insight operationId: GetProductsAndServicesSoldInsight summary: Get products and services sold description: | Returns a paginated list of products and services sold by the entity, including transaction details and share percentages. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time default: "2014-01-01T00:00:00.000Z" - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time default: now - name: page in: query description: Page number for pagination schema: type: integer minimum: 1 default: 1 - name: itemsPerPage in: query description: Number of items per page schema: type: integer minimum: 1 maximum: 500 default: 100 responses: "200": description: Products and Services Sold content: application/ld+json: schema: type: object properties: hydra:member: type: array description: List of products and services sold items: type: object properties: name: type: string description: Product or service identification/description example: Marketing and distribution total: type: number description: Total revenue from this product/service in MXN example: 13208067.16 share: type: number description: Percentage share of total revenue example: 72.02 transactions: type: array description: Transaction breakdown by period items: type: object properties: date: type: string description: Date period example: 2025-10 total: type: number description: Total amount for this period in MXN example: 75000.00 hydra:totalItems: type: integer description: Total number of products/services example: 1 "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/sales-revenue: get: tags: - Sales Revenue Insight operationId: GetSalesRevenueInsight summary: Get sales revenue description: Money the entity has earned over time, aggregated from issued income invoices. parameters: - $ref: "#/components/parameters/entityId" - name: options[from] in: query description: Filter by invoice issuing date (greater than) schema: type: string format: date-time - name: options[to] in: query description: Filter by invoice issuing date (less than) schema: type: string format: date-time - name: options[periodicity] in: query description: The data set is grouped by this field schema: enum: - daily - weekly - monthly - quarterly - yearly type: string default: monthly - name: options[type] in: query description: The type of expenditure schema: enum: - total - currency - customers - export - customer-type - payment-type type: string default: total responses: "200": description: Sales Revenue content: application/ld+json: schema: type: object properties: data: description: Sales revenue data grouped by period and dimension type: array items: type: object properties: mxnAmount: description: | **Deprecated.** Use `metric` instead. Total revenue in `MXN` for the period. deprecated: true type: number example: 39934.827 metric: description: Total revenue in `MXN` for the period. type: number example: 39934.827 date: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. deprecated: true type: string example: "202408" dateLabel: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. Human-readable label for the period. deprecated: true type: string example: 2024/Aug startDate: description: The start date of the period in `YYYY-MM-DD` format. type: string format: date example: "2024-08-01" transactions: description: Number of invoices processed to get this record type: integer example: 6 dimension: description: | The dimension value for the selected `options[type]` grouping. | `options[type]` | `dimension` values | | --- | --- | | `total` | `"total"` | | `currency` | ISO 4217 code — e.g. `MXN`, `USD`, `EUR` | | `customers` | Receiver RFC | | `export` | `"exports"` (receiver RFC `XEXX010101000`) or `"national"` | | `customer-type` | `"legal"` (12-char RFC) or `"physical"` (13-char RFC). Generic RFCs `XAXX010101000` / `XEXX010101000` map to `"unknown"`. | | `payment-type` | `"PUE"` or `"PPD"` | Two sentinel values can also appear for any `options[type]`: - `"unknown"` — the underlying value was `NULL` in the database. - `"others"` — aggregation bucket for high-cardinality dimensions (`customers`) when a row's share of the period total is below 10%. type: string example: total label: description: Human-readable display label. Equal to `dimension` for most types; for `customers` it is the customer name followed by the RFC in parentheses. type: string example: total groupName: description: | **Deprecated.** Use `dimension` instead. Same value as `dimension`. deprecated: true type: string example: total stats: description: Data quality statistics per period, indicating how many invoices had the required fields for accurate calculation. type: array items: type: object properties: total: description: Total number of invoices in this period type: integer example: 50 hits: description: Number of invoices with sufficient data for accurate calculation type: integer example: 48 date: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. deprecated: true type: string example: "202408" dateLabel: description: | **Deprecated.** Use `startDate` together with `options[periodicity]` to format the period. Human-readable label for the period. deprecated: true type: string example: 2024/Aug startDate: description: The start date of the period in `YYYY-MM-DD` format type: string format: date example: "2024-08-01" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/insights/summary: get: tags: - Summary Insight operationId: GetSummaryInsight summary: Get entity summary description: Aggregated profile of the entity combining identity, economic activity, tax regimes, and headline figures from the latest annual tax return. parameters: - $ref: "#/components/parameters/entityId" responses: "200": description: Summary content: application/ld+json: schema: type: object properties: rfc: $ref: "#/components/schemas/TaxpayerID" name: description: Legal or full name of the entity. Taken from the latest Constancia de Situación Fiscal when available, otherwise the entity's stored name. type: [string, "null"] example: FOO BAR, S.A. DE C.V. fiscalAddress: description: Full fiscal address from the latest Constancia de Situación Fiscal, formatted as a single string. type: [string, "null"] example: AV. EJEMPLO 123, COL. CENTRO, 06000, CUAUHTÉMOC, CIUDAD DE MÉXICO address: description: | Structured fiscal address from the latest Constancia de Situación Fiscal, exposing the same components that back the `fiscalAddress` string. Use this object when you need to render address fields individually or geocode the address. `null` when the entity has no Tax Status on record. In CSV and XLSX exports, each component is flattened into its own column as `address.` (for example, `address.postalCode`). anyOf: - $ref: "#/components/schemas/TaxStatusAddress" - type: "null" fiscalAddressStatusRaw: description: Raw SAT status string for the fiscal address (e.g. domicilio localizado, no localizado). type: [string, "null"] example: Domicilio Localizado economicActivities: description: Economic activities registered with the SAT, filtered to those with no end date or an end date in the future. type: array items: type: object properties: name: type: string example: Comercio al por mayor de abarrotes percentage: type: integer example: 100 startDate: type: [string, "null"] format: date example: "2014-01-01" endDate: type: [string, "null"] format: date example: null taxRegimes: description: Tax regimes registered with the SAT, filtered to those with no end date or an end date in the future. type: array items: type: object properties: name: type: string example: Régimen General de Ley Personas Morales startDate: type: [string, "null"] format: date example: "2014-01-01" endDate: type: [string, "null"] format: date example: null totalEmployees: description: Number of employees reported in the previous calendar month's payroll invoices. type: [integer, "null"] example: 42 lastYearNetIncome: description: | **Deprecated.** Kept for backwards compatibility. Same value as `lastYearTotalIncome`. Total income for the latest annual tax return's fiscal year, in `MXN`. deprecated: true type: [integer, "null"] example: 12000000 lastYearTotalIncome: description: Total income for the latest annual tax return's fiscal year, in `MXN`. type: [integer, "null"] example: 12000000 totalRevenueLastTaxReturn: description: | **Deprecated.** Kept for backwards compatibility. Prefer `totalNetProfitLastTaxReturn`. Gross profit (or net loss as a negative value) from the latest annual tax return's income statement, in `MXN`. deprecated: true type: [integer, "null"] example: 5000000 totalNetProfitLastTaxReturn: description: Net profit (or net loss as a negative value) from the latest annual tax return's income statement, in `MXN`. type: [integer, "null"] example: 1500000 lastTaxReturnYear: description: Fiscal year of the most recent annual tax return used for the income figures above. type: [integer, "null"] example: 2024 totalSalesRevenueCurrentYear: description: Sales revenue in `MXN` for the current calendar year (from January 1st up to today). Returns `null` when invoice extractions do not sufficiently cover the year-to-date period. type: [number, "null"] example: 3500000.0 registrationDate: description: Date the entity was registered with the SAT. type: [string, "null"] format: date example: "2014-01-15" blacklistStatus: description: SAT blacklist status while the entity appears in a current 69-B publication source. type: [string, "null"] example: null lastEfirmaCertificate: description: Metadata about the most recent e.firma (FIEL) certificate on record. Only present when the feature is enabled. type: [object, "null"] properties: id: type: string format: uuid serialNumber: type: string example: "00001000000500000000" type: type: string example: efirma status: type: [string, "null"] example: active validFrom: type: [string, "null"] format: date-time validTo: type: [string, "null"] format: date-time revokedAt: type: [string, "null"] format: date-time "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /background-checks: get: tags: - Background Checks operationId: GetBackgroundChecks summary: List background checks description: | Lists background checks available to the organization. Use filters to narrow the list by processing status, country scope, or score. parameters: - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - $ref: "#/components/parameters/backgroundCheckStatusFilter" - $ref: "#/components/parameters/backgroundCheckCountryFilter" - $ref: "#/components/parameters/orderScore" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/orderUpdatedAt" responses: "200": description: Background Checks content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/Collection" - type: object properties: "@context": default: /contexts/BackgroundCheck "@id": example: /background-checks "hydra:member": type: array items: $ref: "#/components/schemas/BackgroundCheck" "401": $ref: "#/components/responses/Unauthorized" /background-checks/{id}: get: tags: - Background Checks operationId: GetBackgroundCheck summary: Retrieve a background check description: | Retrieves one background check, including its score, processing status, country scope, associated files, and links to related records. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": description: Background Check content: application/ld+json: schema: type: object allOf: - type: object properties: "@context": default: /contexts/BackgroundCheck "@id": example: /background-checks/91ab5678-1234-5678-9abc-def012345678 - $ref: "#/components/schemas/BackgroundCheck" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /background-checks/{id}/pdf: get: tags: - Background Checks operationId: GetBackgroundCheckPdf summary: Download background check PDF description: | Downloads the generated PDF report for a background check. The response body is the PDF file itself. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": description: Background Check PDF Report content: application/pdf: schema: type: string format: binary "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/background-checks: get: tags: - Background Checks operationId: GetEntityBackgroundChecks summary: List an entity's background checks description: | Lists background checks associated with an entity. Use this endpoint when your integration is working from a known entity ID. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - $ref: "#/components/parameters/backgroundCheckStatusFilter" - $ref: "#/components/parameters/backgroundCheckCountryFilter" - $ref: "#/components/parameters/orderScore" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/orderUpdatedAt" responses: "200": description: Entity Background Checks content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/Collection" - type: object properties: "@context": default: /contexts/BackgroundCheck "@id": example: /entities/91ab5678-1234-5678-9abc-def012345678/background-checks "hydra:member": type: array items: $ref: "#/components/schemas/BackgroundCheck" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /background-checks/{backgroundCheckId}/records: get: tags: - Background Checks operationId: GetBackgroundCheckRecords summary: List background check records description: | Lists the records found during a background check. Records contain the detailed source data behind the check and are organized by category and database. parameters: - $ref: "#/components/parameters/backgroundCheckId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - $ref: "#/components/parameters/backgroundCheckCategoryFilter" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/orderUpdatedAt" responses: "200": description: Background Check Records content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/BackgroundCheckRecord "@id": example: /background-checks/91ab5678-1234-5678-9abc-def012345678/records "hydra:member": type: array items: $ref: "#/components/schemas/BackgroundCheckRecord" "hydra:search": type: object properties: "@type": type: string default: hydra:IriTemplate "hydra:template": example: "/background-checks/91ab5678-1234-5678-9abc-def012345678/records{?category}" hydra:variableRepresentation: type: string default: BasicRepresentation hydra:mapping: type: array items: type: object properties: "@type": type: string default: IriTemplateMapping variable: type: string property: type: string required: type: boolean default: false example: - "@type": IriTemplateMapping variable: "category" property: category required: false "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /datasources/mx/company-verification/reports: get: tags: - Company Verification Reports operationId: GetCompanyVerificationReports summary: List company verification reports description: | Lists company verification reports available to the organization. Use this endpoint when you need to page through reports across entities. parameters: - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/orderUpdatedAt" responses: "200": description: Company Verification Reports content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/Collection" - type: object properties: "@context": default: /contexts/CompanyVerificationReport "@id": example: /datasources/mx/company-verification/reports "hydra:member": type: array items: $ref: "#/components/schemas/CompanyVerificationReport" "401": $ref: "#/components/responses/Unauthorized" /datasources/mx/company-verification/reports/{id}: get: tags: - Company Verification Reports operationId: GetCompanyVerificationReport summary: Retrieve a company verification report description: | Retrieves one company verification report, including its verification details, metadata, and supporting file references. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": description: Company Verification Report content: application/ld+json: schema: type: object allOf: - type: object properties: "@context": default: /contexts/CompanyVerificationReport "@id": example: /company-verification/reports/91ab5678-1234-5678-9abc-def012345678 - $ref: "#/components/schemas/CompanyVerificationReport" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /datasources/mx/company-verification/reports/{id}/pdf: get: tags: - Company Verification Reports operationId: GetCompanyVerificationReportPdf summary: Download company verification report PDF description: | Downloads the generated PDF for a company verification report. The response body is the PDF file itself. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": description: Company Verification Report PDF content: application/pdf: schema: type: string format: binary "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/datasources/mx/company-verification/reports: get: tags: - Company Verification Reports operationId: GetEntityCompanyVerificationReports summary: List an entity's company verification reports description: | Lists company verification reports associated with an entity. Use this endpoint when your integration is working from a known entity ID. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/orderUpdatedAt" responses: "200": description: Entity Company Verification Reports content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/Collection" - type: object properties: "@context": default: /contexts/CompanyVerificationReport "@id": example: /entities/91ab5678-1234-5678-9abc-def012345678/datasources/mx/company-verification/reports "hydra:member": type: array items: $ref: "#/components/schemas/CompanyVerificationReport" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /entities/{entityId}/shareholders: get: tags: - Shareholders operationId: GetEntityShareholders summary: List an entity's shareholders description: | Lists shareholders connected to an entity. Use filters to narrow the list by shareholder type, name, or RFC. parameters: - $ref: "#/components/parameters/entityId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - $ref: "#/components/parameters/shareholderTypeFilter" - $ref: "#/components/parameters/shareholderNameFilter" - $ref: "#/components/parameters/shareholderRfcFilter" - $ref: "#/components/parameters/orderName" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/orderUpdatedAt" responses: "200": description: Shareholders content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/Shareholder "@id": example: /entities/91ab5678-1234-5678-9abc-def012345678/shareholders "hydra:member": type: array items: $ref: "#/components/schemas/Shareholder" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" post: tags: - Shareholders operationId: CreateEntityShareholder summary: Create a new shareholder for an entity description: | Adds manually collected shareholder information to an entity. The request creates a shareholder and the relation between that shareholder and the entity. parameters: - $ref: "#/components/parameters/entityId" requestBody: required: true content: application/json: schema: type: object required: - relationType - name - shares properties: relationType: allOf: - $ref: "#/components/schemas/ShareholderRelationType" description: Direction of the ownership relation to create name: type: string description: Name of the shareholder to add example: "JUAN MANUEL PEREZ GONZALEZ" rfc: anyOf: - $ref: "#/components/schemas/TaxpayerID" - type: "null" description: Shareholder RFC, when available shares: type: number format: float description: Number of shares represented by the relation minimum: 0.01 example: 1500.50 responses: "201": description: Shareholder created successfully content: application/ld+json: schema: $ref: "#/components/schemas/Shareholder" "400": $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /shareholders: get: tags: - Shareholders operationId: GetShareholders summary: List shareholders description: | Lists shareholders available to the organization. Use this endpoint when you need to search shareholders across entities. parameters: - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - $ref: "#/components/parameters/shareholderTypeFilter" - $ref: "#/components/parameters/shareholderNameFilter" - $ref: "#/components/parameters/shareholderRfcFilter" - $ref: "#/components/parameters/orderName" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/orderUpdatedAt" responses: "200": description: Shareholders content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/Shareholder "@id": example: /shareholders "hydra:member": type: array items: $ref: "#/components/schemas/Shareholder" "401": $ref: "#/components/responses/Unauthorized" /shareholders/{id}: get: tags: - Shareholders operationId: GetShareholder summary: Retrieve a shareholder description: | Retrieves one shareholder by ID. parameters: - $ref: "#/components/parameters/resourceId" responses: "200": description: Shareholder content: application/ld+json: schema: $ref: "#/components/schemas/Shareholder" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" patch: tags: - Shareholders operationId: UpdateShareholder summary: Update a shareholder description: | Updates manually editable shareholder details such as the shareholder's name or RFC. parameters: - $ref: "#/components/parameters/resourceId" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: Updated shareholder name example: "JUAN MANUEL PEREZ GONZALEZ" rfc: anyOf: - $ref: "#/components/schemas/TaxpayerID" - type: "null" description: Updated shareholder RFC responses: "200": description: Shareholder updated successfully content: application/ld+json: schema: $ref: "#/components/schemas/Shareholder" "400": $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" delete: tags: - Shareholders operationId: DeleteShareholder summary: Delete a shareholder description: | Deletes a shareholder resource. parameters: - $ref: "#/components/parameters/resourceId" responses: "204": description: Shareholder deleted successfully "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /shareholders/{shareholderId}/relations: get: tags: - Shareholders operationId: GetShareholderRelations summary: List shareholder relations description: | Lists the entity relationships for a shareholder, including ownership direction and available ownership details. parameters: - $ref: "#/components/parameters/shareholderId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - $ref: "#/components/parameters/relationTypeFilter" - $ref: "#/components/parameters/orderShares" - $ref: "#/components/parameters/orderOwnership" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/orderUpdatedAt" responses: "200": description: Shareholder Relations content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/ShareholderRelation "@id": example: /shareholders/91ab5678-1234-5678-9abc-def012345678/relations "hydra:member": type: array items: $ref: "#/components/schemas/ShareholderRelation" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /shareholders/{shareholderId}/relations/{relationId}: get: tags: - Shareholders operationId: GetShareholderRelation summary: Retrieve a shareholder relation description: | Retrieves one shareholder relation by ID. parameters: - $ref: "#/components/parameters/shareholderId" - $ref: "#/components/parameters/relationId" responses: "200": description: Shareholder Relation content: application/ld+json: schema: $ref: "#/components/schemas/ShareholderRelation" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" patch: tags: - Shareholders operationId: UpdateShareholderRelation summary: Update a shareholder relation description: | Updates manually editable details for a shareholder relation, such as the number of shares. parameters: - $ref: "#/components/parameters/shareholderId" - $ref: "#/components/parameters/relationId" requestBody: required: true content: application/json: schema: type: object required: - shares properties: shares: type: number format: float description: Updated number of shares represented by the relation minimum: 0.01 example: 1500.50 responses: "200": description: Shareholder Relation updated successfully content: application/ld+json: schema: $ref: "#/components/schemas/ShareholderRelation" "400": $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" delete: tags: - Shareholders operationId: DeleteShareholderRelation summary: Delete a shareholder relation description: | Deletes the relationship between a shareholder and an entity. parameters: - $ref: "#/components/parameters/shareholderId" - $ref: "#/components/parameters/relationId" responses: "204": description: Shareholder Relation deleted successfully "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /shareholders/{shareholderId}/relations/{relationId}/promote: post: tags: - Shareholders operationId: PromoteShareholderRelation summary: Promote a shareholder relation description: | Promotes a shareholder relation by creating an entity for the shareholder. Use this when the shareholder should be managed as its own person or company in your integration. parameters: - $ref: "#/components/parameters/shareholderId" - $ref: "#/components/parameters/relationId" requestBody: required: true content: application/json: schema: type: object required: - name - rfc properties: name: type: string description: Name to use for the new promoted entity example: "JUAN MANUEL PEREZ GONZALEZ" rfc: allOf: - $ref: "#/components/schemas/TaxpayerID" description: RFC to use for the new promoted entity datasources: type: array description: Datasources to connect when creating the promoted entity items: type: object required: - name properties: name: type: string enum: - sat - buro_de_credito - rpc - rug - bil description: Datasource to connect to the promoted entity example: "sat" additionalProperties: true example: - name: "sat" - name: "rpc" responses: "200": description: Shareholder Relation promoted successfully content: application/ld+json: schema: type: object properties: "@type": type: string default: ShareholderPromotedResponse id: type: string format: uuid description: ID of the created entity example: "91ab5678-1234-5678-9abc-def012345678" name: type: string description: Name of the created entity example: "JUAN MANUEL PEREZ GONZALEZ" rfc: allOf: - $ref: "#/components/schemas/TaxpayerID" description: RFC assigned to the created entity onboardingUrl: type: [string, "null"] description: Onboarding URL for the created entity, when onboarding is required example: "https://api.syntage.com/onboarding/91ab5678-1234-5678-9abc-def012345678" "400": $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /shareholders/{shareholderId}/relations/{relationId}/sources: get: tags: - Shareholders operationId: GetShareholderRelationSources summary: List shareholder relation sources description: | Lists the sources that support a shareholder relation, such as manually entered data or information sourced from RPC. parameters: - $ref: "#/components/parameters/shareholderId" - $ref: "#/components/parameters/relationId" - $ref: "#/components/parameters/collectionCursorNextPageParam" - $ref: "#/components/parameters/collectionCursorPreviousPageParam" - $ref: "#/components/parameters/collectionLimit" - $ref: "#/components/parameters/sourceNameFilter" - $ref: "#/components/parameters/orderCreatedAt" - $ref: "#/components/parameters/orderUpdatedAt" responses: "200": description: Shareholder Relation Sources content: application/ld+json: schema: type: object allOf: - $ref: "#/components/schemas/CursorCollection" - type: object properties: "@context": default: /contexts/ShareholderRelationsSource "@id": example: /shareholders/91ab5678-1234-5678-9abc-def012345678/relations/82cd9012-3456-7890-abcd-ef1234567890/sources "hydra:member": type: array items: $ref: "#/components/schemas/ShareholderRelationsSource" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" /shareholders/{shareholderId}/relations/{relationId}/sources/{sourceId}: get: tags: - Shareholders operationId: GetShareholderRelationSource summary: Retrieve a shareholder relation source description: | Retrieves one source for a shareholder relation. parameters: - $ref: "#/components/parameters/shareholderId" - $ref: "#/components/parameters/relationId" - $ref: "#/components/parameters/sourceId" responses: "200": description: Shareholder Relation Source content: application/ld+json: schema: $ref: "#/components/schemas/ShareholderRelationsSource" "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" delete: tags: - Shareholders operationId: DeleteShareholderRelationSource summary: Delete a shareholder relation source description: | Deletes one source from a shareholder relation. parameters: - $ref: "#/components/parameters/shareholderId" - $ref: "#/components/parameters/relationId" - $ref: "#/components/parameters/sourceId" responses: "204": description: Shareholder Relation Source deleted successfully "401": $ref: "#/components/responses/Unauthorized" "404": $ref: "#/components/responses/NotFound" x-readme: explorer-enabled: true proxy-enabled: true samples-enabled: true