# Listar status fiscais

## ▶️ Uso

Com o método Listar Status de Impostos, você pode:

1. Listar status de impostos relacionados a um link.id específico (usando o parâmetro de consulta link).
2. Obter os detalhes de um tax-status.id específico (usando o parâmetro de consulta id).
3. [Não Recomendado] Listar todos os status de impostos relacionados à sua conta Belvo (sem usar nenhum parâmetro de consulta).

## 📖 Paginação

Este método retorna uma resposta paginada (padrão: 100 itens por página). Você pode usar o parâmetro de consulta page_size para aumentar o número de itens retornados até um máximo de 1000 itens. Você pode usar o parâmetro de consulta page para navegar pelos resultados. Para mais detalhes sobre como navegar pelas respostas paginadas da Belvo, consulte nosso artigo Dicas de Paginação.

## 🔦 Filtrando Respostas

Consulte a lista de consultas abaixo para ver uma lista de campos pelos quais você pode filtrar suas respostas. Para mais informações sobre como usar filtros, veja nosso artigo Filtrando respostas.

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

## Query parameters:

  - `link` (string)
    O link.id pelo qual você deseja filtrar.

ℹ️ Recomendamos fortemente adicionar o filtro link.id para melhorar seu desempenho.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `page_size` (integer)
    Indica quantos resultados retornar por página. Por padrão, retornamos 100 resultados por página.

ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é 1000. Se você inserir um valor maior que 1000, nossa API usará o valor máximo por padrão (1000).
    Example: 100

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

  - `omit` (string)
    Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.

  - `fields` (string)
    Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.

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

  - `id` (string)
    Retorne informações apenas para este recurso id.
    Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"

  - `id__in` (array)
    Retorne informações para esses ids de recurso.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

  - `created_at` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após esta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após ou nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes desta data (no formato YYYY-MM-DD).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes ou na data especificada (no formato YYYY-MM-DD).
    Example: "2022-03-30"

  - `created_at__range` (array)
    Retorne contas que foram atualizadas pela última vez no banco de dados do Belvo entre duas datas (no formato YYYY-MM-DD). O primeiro valor indica o início do intervalo e o segundo valor indica o final do intervalo.
    Example: ["2022-01-01","2022-12-31"]

## Response 200 fields (application/json):

  - `count` (integer)
    O número total de resultados na sua conta Belvo.
    Example: 130

  - `next` (string,null)
    A URL para a próxima página de resultados. Cada página consiste em até 100 itens. Se não houver resultados suficientes para uma página adicional, o valor será null.

Em nosso exemplo de documentação, usamos {endpoint} como um valor de espaço reservado. Em produção, esse valor será substituído pelo endpoint real que você está usando atualmente (por exemplo, accounts ou owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    A URL para a página anterior de resultados. Se não houver uma página anterior, o valor será null.

  - `results` (array)
    Array de objetos de status de imposto.

  - `results.id` (string, required)
    Identificador único da Belvo para o item atual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `results.link` (string,null, required)
    O link.id ao qual os dados pertencem.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `results.collected_at` (string, required)
    O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.created_at` (string, required)
    O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.place_and_date_of_issuance` (string,null, required)
    O local e a data em que o status fiscal foi emitido.
    Example: "TLALPAN , CIUDAD DE MEXICO A 19 DE MARZO DE 2020"

  - `results.official_name` (string,null, required)
    O nome da pessoa ou empresa.
    Example: "John Doe"

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

  - `results.tax_payer_information` (object,null, required)
    Detalhes sobre o contribuinte.

  - `results.tax_payer_information.rfc` (string,null, required)
    O número de identificação do contribuinte (para o México, este é o RFC).
    Example: "BEMP12345G58"

  - `results.tax_payer_information.curp` (string,null)
    O número Clave Única de Registro de Población (CURP) do contribuinte.

  - `results.tax_payer_information.name` (string,null)
    O primeiro nome do contribuinte.
    Example: "JOHN"

  - `results.tax_payer_information.first_last_name` (string,null)
    O primeiro sobrenome do contribuinte.
    Example: "DOE"

  - `results.tax_payer_information.second_last_name` (string,null)
    O segundo sobrenome do contribuinte.
    Example: "SCHMOE"

  - `results.tax_payer_information.start_operations_date` (string,null, required)
    Data em que o contribuinte iniciou atividades comerciais tributáveis, no formato YYYY-MM-DD.

  - `results.tax_payer_information.status_padron` (string,null, required)
    Status do contribuinte no Registro Federal de Contribuintes (RFC). Pode ser ACTIVO ou INACTIVO.

  - `results.tax_payer_information.last_status_change_date` (string,null, required)
    Data em que status_padron foi atualizado mais recentemente, no formato YYYY-MM-DD.

  - `results.tax_payer_information.commercial_name` (string,null)
    O nome da empresa designado para consumidores e o público em geral.

Nota: Aplicável apenas para empresas.
    Example: "Jar Jar Transport"

  - `results.tax_payer_information.social_name` (string,null)
    O nome único e exclusivo dentro do território nacional que as empresas recebem para fins legais ou administrativos.

Nota: Aplicável apenas para empresas.
    Example: "John Doe SA DE CV"

  - `results.tax_payer_information.email` (string,null)
    Endereço de e-mail de contato do contribuinte.
    Example: "john_doe@gmail.com"

  - `results.tax_payer_information.phone` (string,null)
    Número de telefone de contato do contribuinte.
    Example: "1234567890"

  - `results.address` (object,null, required)
    Os detalhes do endereço do contribuinte.

  - `results.address.postal_code` (string,null, required)
    O código postal do endereço.
    Example: "21255"

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

  - `results.address.street` (string,null)
    A rua dos contribuintes.
    Example: "LA MALINCHE"

  - `results.address.exterior_number` (string,null)
    O número da rua.
    Example: "432"

  - `results.address.interior_number` (string,null)
    Informações adicionais do endereço.
    Example: "PLANTA BAJA"

  - `results.address.suburb` (string,null)
    O subúrbio do contribuinte.
    Example: "BUENAVENTURA"

  - `results.address.locality` (string,null)
    A localidade do endereço.
    Example: "none"

  - `results.address.municipality` (string,null)
    O município do endereço.
    Example: "CDMX DC"

  - `results.address.state` (string,null)
    O estado em que o endereço está.
    Example: "Federal"

  - `results.address.between_street` (array,null)
    Informações adicionais sobre onde a street está localizada.

  - `results.address.between_street.street_one` (string,null)
    A primeira rua entre a qual street está localizada.
    Example: "CALLE PRINCIPE"

  - `results.address.between_street.street_two` (string,null)
    A segunda rua entre a qual street está localizada.
    Example: "CALLE NUEVA ROMA"

  - `results.economic_activity` (array,null, required)
    Uma lista de objetos de atividade econômica.

  - `results.economic_activity.economic_activity` (string,null)
    A descrição da atividade econômica.
    Example: "Asalariado"

  - `results.economic_activity.initial_date` (string,null)
    A data de início da atividade econômica, no formato YYYY-MM-DD.
    Example: "2020-12-06"

  - `results.economic_activity.end_date` (string,null)
    A data de término da atividade econômica, no formato YYYY-MM-DD.

  - `results.economic_activity.order` (string,null)
    A ordem da atividade econômica.
    Example: "2"

  - `results.economic_activity.percentage` (string,null)
    A porcentagem da atividade econômica.
    Example: "1"

  - `results.regimes` (array,null, required)
    Uma lista de objetos de regime.

  - `results.regimes.end_date` (string,null, required)
    A data de término do regime, no formato YYYY-MM-DD.

  - `results.regimes.initial_date` (string,null, required)
    A data de início do regime, no formato YYYY-MM-DD.
    Example: "2020-12-06"

  - `results.regimes.regimen` (string,null, required)
    A descrição do regime.
    Example: "Régimen de Ingresos por Dividendos (socios y accionistas)"

  - `results.obligations` (array,null, required)
    Detalhes sobre as obrigações de uma empresa.

ℹ️ Para contas não comerciais, este campo retornará vazio.

  - `results.obligations.obligation` (string,null)
    A descrição da obrigação.
    Example: "Declaración informativa de IVA con la anual de ISR"

  - `results.obligations.expiration` (string,null)
    O prazo para cumprir a obrigação, conforme imposto pela autoridade fiscal.
    Example: "Conjuntamente con la declaración anual del ejercicio."

  - `results.obligations.initial_date` (string,null)
    A data em que a obrigação começou, no formato YYYY-MM-DD.
    Example: "2020-12-06"

  - `results.obligations.end_date` (string,null)
    A data em que a obrigação terminou, no formato YYYY-MM-DD.

  - `results.digital_stamp` (string,null, required)
    O certificado de validação do documento.
    Example: "||2020/04/26|GHTF980303F7|CONSTANCIA DE SITUACIÓN\nFISCAL|2044441088666600000034||\n"

  - `results.digital_stamp_chain` (string,null, required)
    Uma cadeia de dados contendo a estrutura básica de um cheque fiscal digital. Para o México, este é o Comprobante Fiscal Digital por Internet (CFDI).
    Example: "EtenSA9t1adG7bn+Jj23kj43JK+XbMPxdOppwabhXD+pXseSqYowWWDna0mpUk3264lkj2345j23faNZB852dCDt9KAjow=\n"

  - `results.pdf` (string,null, required)
    PDF de status fiscal como uma string binária.
    Example: "=PDF-STRING="

## Response 403 fields (application/json):

  - `code` (string)
    Um código de erro único (access_to_resource_denied) que permite classificar e tratar o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Uma breve descrição do erro.

Para erros access_to_resource_denied, a descrição é:

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

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Um código de erro único (not_found) que permite classificar e lidar com o erro programaticamente.
    Example: "not_found"

  - `message` (string)
    Uma breve descrição do erro.

Para erros not_found, a descrição é:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Um código de erro único (request_timeout) que permite classificar e lidar com o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Uma breve descrição do erro.

Para erros de request_timeout, a descrição é:

  - 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)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 428 fields (application/json):

  - `code` (string)
    Um código de erro único (token_required) que permite classificar e lidar com o erro programaticamente.
ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 428 token_required.
    Example: "token_required"

  - `message` (string)
    Uma breve descrição do erro. Para erros token_required, a descrição é:

- A instituição requer um token MFA para fazer login.
    Example: "A MFA token is required by the institution to login"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

  - `session` (string)
    Um ID único de 32 caracteres da sessão de login (correspondente a um padrão regex de: [a-f0-9]{32}).
    Example: "2675b703b9d4451f8d4861a3eee54449"

  - `expiry` (integer)
    Tempo de duração da sessão em segundos.
    Example: 9600

  - `link` (string)
    Identificador único criado pela Belvo, usado para referenciar o Link atual.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `token_generation_data` (object)
    Detalhes sobre como gerar o token.

  - `token_generation_data.instructions` (string)
    Instruções para geração de token.
    Example: "Use this code to generate the token"

  - `token_generation_data.type` (string)
    Tipo de dados para gerar o token (QR code, desafio numérico).
    Example: "numeric"

  - `token_generation_data.value` (string)
    Valor a ser usado para gerar o token.
    Example: "12345"

  - `token_generation_data.expects_user_input` (boolean)
    Indica se o usuário precisa fornecer entrada para concluir a autenticação. Quando definido como false, seu usuário pode precisar:
- confirmar o login em outro dispositivo
- escanear um código QR
Você ainda precisará fazer uma chamada PATCH para concluir a solicitação.
    Example: true

## Response 500 fields (application/json):

  - `code` (string)
    Um código de erro único (unexpected_error) que permite classificar e tratar o erro de forma programática.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Uma breve descrição do erro.

Para erros unexpected_error, a descrição é:

  - Belvo não consegue processar a solicitação devido a um problema interno do sistema ou a uma resposta não suportada de uma instituição.
    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)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"