# Enumera los estados fiscales

## ▶️ Uso

Con el método Listar Estados Fiscales, puedes:

1. Listar estados fiscales relacionados con un link.id específico (usando el parámetro de consulta link).
2. Obtener los detalles de un tax-status.id específico (usando el parámetro de consulta id).
3. [No Recomendado] Listar todos los estados fiscales relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta).

## 📖 Paginación

Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta page_size para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta page para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación.

## 🔦 Filtrado de Respuestas

Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas.

Endpoint: GET /api/tax-status/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `link` (string)
    El link.id por el que deseas filtrar.

ℹ️ Recomendamos encarecidamente añadir el filtro link.id para mejorar tu rendimiento.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `page_size` (integer)
    Indica cuántos resultados devolver por página. Por defecto, devolvemos 100 resultados por página.

ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 1000. Si introduces un valor mayor que 1000, nuestra API usará por defecto el valor máximo (1000).
    Example: 100

  - `page` (integer)
    Un número de página dentro del conjunto de resultados paginados.
    Example: 1

  - `omit` (string)
    Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

  - `fields` (string)
    Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

  - `link__in` (array)
    Devuelve resultados solo para estos link.ids.
    Example: ["5722d0ba-69d7-42dc-8ff5-33767b83c5d6"]

  - `id` (string)
    Devuelve información solo para este recurso id.
    Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"

  - `id__in` (array)
    Devuelve información para estos ids de recursos.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

  - `created_at` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo en esta fecha (en formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después de esta fecha (en formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después o en esta fecha (en formato YYYY-MM-DD).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes de esta fecha (en formato YYYY-MM-DD).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes o en esta fecha (en formato YYYY-MM-DD).
    Example: "2022-03-30"

  - `created_at__range` (array)
    Devolver cuentas que fueron actualizadas por última vez en la base de datos de Belvo entre dos fechas (en formato YYYY-MM-DD). El primer valor indica el inicio del rango y el segundo valor indica el final del rango.
    Example: ["2022-01-01","2022-12-31"]

## Response 200 fields (application/json):

  - `count` (integer)
    El número total de resultados en tu cuenta de Belvo.
    Example: 130

  - `next` (string,null)
    La URL a la siguiente página de resultados. Cada página consta de hasta 100 elementos. Si no hay suficientes resultados para una página adicional, el valor es null.

En nuestro ejemplo de documentación, usamos {endpoint} como un valor de marcador de posición. En producción, este valor será reemplazado por el endpoint real que estás utilizando actualmente (por ejemplo, accounts o owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    La URL a la página anterior de resultados. Si no hay una página anterior, el valor es null.

  - `results` (array)
    Matriz de objetos de estado fiscal.

  - `results.id` (string, required)
    Identificador único de Belvo para el elemento actual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `results.link` (string,null, required)
    El link.id al que pertenecen los datos.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `results.collected_at` (string, required)
    La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.created_at` (string, required)
    La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.place_and_date_of_issuance` (string,null, required)
    El lugar y la fecha en que se emitió el estado fiscal.
    Example: "TLALPAN , CIUDAD DE MEXICO A 19 DE MARZO DE 2020"

  - `results.official_name` (string,null, required)
    El nombre de la persona o empresa.
    Example: "John Doe"

  - `results.id_cif` (string,null, required)
    El ID de Cédula de Identificación Fiscal (CIF) del contribuyente.
    Example: "12345678901"

  - `results.tax_payer_information` (object,null, required)
    Detalles sobre el contribuyente.

  - `results.tax_payer_information.rfc` (string,null, required)
    El número de identificación del contribuyente (Para México, este es el RFC).
    Example: "BEMP12345G58"

  - `results.tax_payer_information.curp` (string,null)
    El número de Clave Única de Registro de Población (CURP) del contribuyente.

  - `results.tax_payer_information.name` (string,null)
    El nombre de pila del contribuyente.
    Example: "JOHN"

  - `results.tax_payer_information.first_last_name` (string,null)
    El primer apellido del contribuyente.
    Example: "DOE"

  - `results.tax_payer_information.second_last_name` (string,null)
    El segundo apellido del contribuyente.
    Example: "SCHMOE"

  - `results.tax_payer_information.start_operations_date` (string,null, required)
    Fecha en la que el contribuyente comenzó actividades comerciales gravables, en formato YYYY-MM-DD.

  - `results.tax_payer_information.status_padron` (string,null, required)
    Estado del contribuyente en el Registro Federal de Contribuyentes (RFC). Puede ser ACTIVO o INACTIVO.

  - `results.tax_payer_information.last_status_change_date` (string,null, required)
    Fecha en la que status_padron se actualizó más recientemente, en formato YYYY-MM-DD.

  - `results.tax_payer_information.commercial_name` (string,null)
    El nombre del negocio designado para los consumidores y el público en general.

Nota: Solo aplicable para negocios.
    Example: "Jar Jar Transport"

  - `results.tax_payer_information.social_name` (string,null)
    El nombre único y exclusivo dentro del territorio nacional que las empresas reciben para fines legales o administrativos.

Nota: Solo aplicable para negocios.
    Example: "John Doe SA DE CV"

  - `results.tax_payer_information.email` (string,null)
    Dirección de correo electrónico de contacto para el contribuyente.
    Example: "john_doe@gmail.com"

  - `results.tax_payer_information.phone` (string,null)
    Número de teléfono de contacto del contribuyente.
    Example: "1234567890"

  - `results.address` (object,null, required)
    Los detalles de la dirección del contribuyente.

  - `results.address.postal_code` (string,null, required)
    El código postal de la dirección.
    Example: "21255"

  - `results.address.street_type` (string,null)
    El tipo street.
    Example: "CALLE"

  - `results.address.street` (string,null)
    La calle de los contribuyentes.
    Example: "LA MALINCHE"

  - `results.address.exterior_number` (string,null)
    El número de la calle.
    Example: "432"

  - `results.address.interior_number` (string,null)
    Información adicional de la dirección.
    Example: "PLANTA BAJA"

  - `results.address.suburb` (string,null)
    El suburbio del contribuyente.
    Example: "BUENAVENTURA"

  - `results.address.locality` (string,null)
    La localidad de la dirección.
    Example: "none"

  - `results.address.municipality` (string,null)
    El municipio de la dirección.
    Example: "CDMX DC"

  - `results.address.state` (string,null)
    El estado en el que se encuentra la dirección.
    Example: "Federal"

  - `results.address.between_street` (array,null)
    Información adicional sobre dónde se encuentra la street.

  - `results.address.between_street.street_one` (string,null)
    La primera calle entre la que se encuentra street.
    Example: "CALLE PRINCIPE"

  - `results.address.between_street.street_two` (string,null)
    La segunda calle entre la que se encuentra street.
    Example: "CALLE NUEVA ROMA"

  - `results.economic_activity` (array,null, required)
    Una lista de objetos de actividad económica.

  - `results.economic_activity.economic_activity` (string,null)
    La descripción de la actividad económica.
    Example: "Asalariado"

  - `results.economic_activity.initial_date` (string,null)
    La fecha de inicio de la actividad económica, en formato YYYY-MM-DD.
    Example: "2020-12-06"

  - `results.economic_activity.end_date` (string,null)
    La fecha de finalización de la actividad económica, en formato YYYY-MM-DD.

  - `results.economic_activity.order` (string,null)
    El orden de la actividad económica.
    Example: "2"

  - `results.economic_activity.percentage` (string,null)
    El porcentaje de la actividad económica.
    Example: "1"

  - `results.regimes` (array,null, required)
    Una lista de objetos de régimen.

  - `results.regimes.end_date` (string,null, required)
    La fecha de finalización del régimen, en formato YYYY-MM-DD.

  - `results.regimes.initial_date` (string,null, required)
    La fecha de inicio del régimen, en formato YYYY-MM-DD.
    Example: "2020-12-06"

  - `results.regimes.regimen` (string,null, required)
    La descripción del régimen.
    Example: "Régimen de Ingresos por Dividendos (socios y accionistas)"

  - `results.obligations` (array,null, required)
    Detalles sobre las obligaciones de un negocio.

ℹ️ Para cuentas que no son de negocio, este campo se devolverá vacío.

  - `results.obligations.obligation` (string,null)
    La descripción de la obligación.
    Example: "Declaración informativa de IVA con la anual de ISR"

  - `results.obligations.expiration` (string,null)
    La fecha límite para cumplir con la obligación, según lo impuesto por la autoridad fiscal.
    Example: "Conjuntamente con la declaración anual del ejercicio."

  - `results.obligations.initial_date` (string,null)
    La fecha en que comenzó la obligación, en formato YYYY-MM-DD.
    Example: "2020-12-06"

  - `results.obligations.end_date` (string,null)
    La fecha en que terminó la obligación, en formato YYYY-MM-DD.

  - `results.digital_stamp` (string,null, required)
    El certificado de validación del documento.
    Example: "||2020/04/26|GHTF980303F7|CONSTANCIA DE SITUACIÓN\nFISCAL|2044441088666600000034||\n"

  - `results.digital_stamp_chain` (string,null, required)
    Una cadena de datos que contiene la estructura básica de un cheque fiscal digital. Para México, este es el Comprobante Fiscal Digital por Internet (CFDI).
    Example: "EtenSA9t1adG7bn+Jj23kj43JK+XbMPxdOppwabhXD+pXseSqYowWWDna0mpUk3264lkj2345j23faNZB852dCDt9KAjow=\n"

  - `results.pdf` (string,null, required)
    Estado fiscal PDF como una cadena binaria.
    Example: "=PDF-STRING="

## Response 403 fields (application/json):

  - `code` (string)
    Un código de error único (access_to_resource_denied) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Una breve descripción del error.

Para los errores access_to_resource_denied, la descripción es:

  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Un código de error único (not_found) que te permite clasificar y manejar el error de manera programática.
    Example: "not_found"

  - `message` (string)
    Una breve descripción del error.

Para errores not_found, la descripción es:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Un código de error único (request_timeout) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Una breve descripción del error.

Para los errores de request_timeout, la descripción es:

  - The request timed out, you can retry asking for less data by changing your query parameters.
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 428 fields (application/json):

  - `code` (string)
    Un código de error único (token_required) que te permite clasificar y manejar el error de forma programática. ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 428 token_required.
    Example: "token_required"

  - `message` (string)
    Una breve descripción del error. 
Para los errores token_required, la descripción es:

  - A MFA token is required by the institution to login.
    Example: "A MFA token is required by the institution to login"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

  - `session` (string)
    Un ID único de 32 caracteres de la sesión de inicio de sesión (que coincide con un patrón de regex de: [a-f0-9]{32}).
    Example: "2675b703b9d4451f8d4861a3eee54449"

  - `expiry` (integer)
    Tiempo de duración de la sesión en segundos.
    Example: 9600

  - `link` (string)
    Identificador único creado por Belvo, utilizado para referenciar el Link actual.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `token_generation_data` (object)
    Detalles sobre cómo generar el token.

  - `token_generation_data.instructions` (string)
    Instrucciones para la generación de tokens.
    Example: "Use this code to generate the token"

  - `token_generation_data.type` (string)
    Tipo de datos para generar el token (código QR, desafío numérico).
    Example: "numeric"

  - `token_generation_data.value` (string)
    Valor a utilizar para generar el token.
    Example: "12345"

  - `token_generation_data.expects_user_input` (boolean)
    Indica si el usuario necesita proporcionar información para completar la autenticación. Cuando se establece en false, es posible que su usuario necesite:
- confirmar el inicio de sesión en otro dispositivo
- escanear un código QR
Aún necesitará realizar una llamada PATCH para completar la solicitud.
    Example: true

## Response 500 fields (application/json):

  - `code` (string)
    Un código de error único (unexpected_error) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Una breve descripción del error.

Para los errores unexpected_error, la descripción es:

- Belvo no puede procesar la solicitud debido a un problema interno del sistema o a una respuesta no soportada de una institución.
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"