# Listar status fiscais

## ▶️ Uso

Com o método Tax Status, você pode:

1. Listar status fiscais 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 fiscais 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, consulte nosso artigo Filtrando respostas.

Endpoint: GET /api/cl/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-34d1044cb908&page=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)
    Identificador único da Belvo para o item atual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

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

  - `results.collected_at` (string)
    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)
    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.entity_details` (object)
    Detalhes sobre a entidade fiscal (datas importantes e informações de identificação).

  - `results.entity_details.incorporation_date` (string, required)
    A data em que a entidade fiscal foi constituída, no formato YYYY-MM-DD.
    Example: "24-09-2010"

  - `results.entity_details.start_date` (string, required)
    A data em que a entidade fiscal começou a operar, no formato YYYY-MM-DD.
    Example: "24-09-2010"

  - `results.entity_details.end_date` (string,null, required)
    A data em que a entidade fiscal encerrou suas operações, no formato YYYY-MM-DD. Se a entidade ainda estiver operando, este campo retornará null.

  - `results.entity_details.document_id_type` (string, required)
    O tipo de ID de documento que a entidade fiscal possui. Para o Chile, será o RUT.
    Example: "RUT"

  - `results.entity_details.document_id_number` (string, required)
    O número de ID do documento da entidade fiscal.
    Example: "197476427-K"

  - `results.entity_details.name` (string, required)
    O nome da entidade fiscal.
    Example: "Empresa de Prueba"

  - `results.addresses` (array)
    Um array de endereços para a entidade fiscal.

  - `results.addresses.type` (string, required)
    O tipo de endereço. Pode ser:

  - PRIMARY (domicilio)
  - SECONDARY (sucursal)
  - MAILING_ADDRESS (DOM. POSTAL)
  - NOTIFICATION_ADDRESS (DOM. URBANO_VALIDO_NOTIFICACIONES)
    Enum: "PRIMARY", "SECONDARY", "MAILING_ADDRESS", "NOTIFICATION_ADDRESS"

  - `results.addresses.date` (string, required)
    A data em que o endereço foi adicionado aos registros da entidade fiscal, no formato YYYY-MM-DD.
    Example: "24-09-2010"

  - `results.addresses.address` (string, required)
    O endereço da entidade fiscal.
    Example: "Calle Falsa 123"

  - `results.emails` (array)
    Um array de endereços de e-mail para a entidade fiscal.

  - `results.emails.type` (string, required)
    O tipo de e-mail. Pode ser:

- CONTACT (Correo electrónico de contacto)
- NOTIFICATION (Correo electrónico para notificaciones)
- OTHER.
    Enum: "CONTACT", "NOTIFICATION", "OTHER"

  - `results.emails.email` (string, required)
    O endereço de e-mail da entidade fiscal.
    Example: "mi-email@empresa.cl"

  - `results.phone_numbers` (array)
    Um array de números de telefone para a entidade fiscal.

  - `results.phone_numbers.type` (string,null, required)
    O tipo de número de telefone. Pode ser:

  - LANDLINE
  - MOBILE
  - OTHER
    Enum: "LANDLINE", "MOBILE", "OTHER", "null"

  - `results.phone_numbers.number` (string, required)
    O número de telefone da entidade fiscal.
    Example: 123456789

  - `results.economic_activities` (array)
    Um array de atividades econômicas para a entidade fiscal.

  - `results.economic_activities.type` (string, required)
    O tipo geral de atividade econômica, de acordo com o Servicio de Impuestos Internos (SII).
    Example: "ASESORIA EN INGENIERIA"

  - `results.economic_activities.activity` (string, required)
    A atividade econômica específica, de acordo com o Servicio de Impuestos Internos (SII).
    Example: "ACTIVIDADES DE CONSULTORIA DE GESTION"

  - `results.economic_activities.code` (string, required)
    O código de atividade econômica, de acordo com o Servicio de Impuestos Internos (SII).
    Example: "702000"

  - `results.economic_activities.tax_category` (integer, required)
    A categoria tributária da atividade econômica, de acordo com o Servicio de Impuestos Internos (SII).
    Example: 1

  - `results.economic_activities.vat_affected` (boolean, required)
    Indica se a atividade econômica é afetada pelo IVA.
    Example: true

  - `results.economic_activities.start_date` (string, required)
    A data em que a entidade fiscal iniciou esta atividade econômica, no formato YYYY-MM-DD.
    Example: "24-09-2010"

  - `results.legal_representative` (array)
    Um array de representantes legais para a entidade fiscal.

  - `results.legal_representative.is_current` (boolean, required)
    Indica se o representante legal é o atual representante legal da entidade fiscal.
    Example: true

  - `results.legal_representative.name` (string, required)
    O nome do representante legal.
    Example: "Juan Perez"

  - `results.legal_representative.document_id_type` (string, required)
    O tipo de ID do documento do representante legal. Para o Chile, isso será sempre definido como RUT.
    Enum: "RUT"

  - `results.legal_representative.document_id_number` (string, required)
    O número de identificação do documento do representante legal. Para o Chile, este será o número RUT.
    Example: "12345678-9"

  - `results.legal_representative.start_date` (string, required)
    A data em que o representante legal começou a representar a entidade fiscal, no formato YYYY-MM-DD.
    Example: "24-09-2010"

  - `results.legal_representative.end_date` (string,null)
    A data em que o representante legal deixou de representar a entidade fiscal, no formato YYYY-MM-DD. Se o representante legal ainda estiver representando a entidade fiscal, este campo retornará null.

  - `results.equity_holders` (array)
    Um array de detentores de ações para a entidade fiscal.

  - `results.equity_holders.is_current` (boolean, required)
    Indica se o detentor de ações está atualmente ativo.
    Example: true

  - `results.equity_holders.name` (string, required)
    O nome do detentor de ações.
    Example: "Juan Perez"

  - `results.equity_holders.document_id_type` (string, required)
    O tipo de ID de documento do detentor de ações. Para o Chile, isso será sempre definido como RUT.
    Enum: "RUT"

  - `results.equity_holders.document_id_number` (string, required)
    O número de identificação do documento do detentor de ações. Para o Chile, este será o número RUT.
    Example: "12345678-9"

  - `results.equity_holders.inactive` (boolean, required)
    Indica se o detentor de ações está atualmente inativo.

  - `results.equity_holders.start_date` (string, required)
    A data em que o detentor de ações começou a possuir ações na entidade fiscal, no formato YYYY-MM-DD.
    Example: "24-09-2010"

  - `results.equity_holders.end_date` (string,null)
    A data em que o detentor de ações deixou de possuir ações na entidade fiscal, no formato YYYY-MM-DD. Se o detentor de ações ainda estiver possuindo ações na entidade fiscal, este campo retornará null.

  - `results.equity_holders.capital_contributed` (number, required)
    O valor do capital contribuído pelo detentor de ações.
    Example: 1000000

  - `results.equity_holders.capital_contribution_outstanding` (number, required)
    O valor da contribuição de capital pendente pelo detentor de ações.
    Example: 3750

  - `results.equity_holders.ownership_share` (number, required)
    A porcentagem de participação acionária do detentor de ações.
    Example: 25.25

  - `results.equity_holders.profit_share` (number, required)
    A porcentagem de participação nos lucros do detentor de ações.
    Example: 31.25

  - `results.company_partnership_stakes` (array)
    Um array de participações societárias da entidade fiscal.

  - `results.company_partnership_stakes.name` (string, required)
    O nome da entidade que esta entidade fiscal.
    Example: "Empresa de Prueba"

  - `results.company_partnership_stakes.document_id_type` (string, required)
    O tipo de ID de documento do negócio. Para o Chile, isso será sempre definido como RUT.
    Enum: "RUT"

  - `results.company_partnership_stakes.document_id_number` (string, required)
    O número de ID do documento da empresa. Para o Chile, este será o número RUT.
    Example: "12345678-9"

  - `results.company_partnership_stakes.inactive` (boolean, required)
    Indica se o negócio está atualmente ativo.

  - `results.company_partnership_stakes.start_date` (string, required)
    A data em que a empresa começou a deter participação acionária na entidade fiscal, no formato YYYY-MM-DD.
    Example: "24-09-2010"

  - `results.company_partnership_stakes.end_date` (string,null)
    A data em que o titular da empresa deixou de possuir participação acionária na entidade fiscal, no formato YYYY-MM-DD. Se o titular ainda estiver mantendo participação acionária na entidade fiscal, este campo retornará null.

  - `results.company_partnership_stakes.capital_contributed` (number, required)
    O montante de capital contribuído pela empresa.
    Example: 1000000.02

  - `results.company_partnership_stakes.capital_contribution_outstanding` (number, required)
    O valor da contribuição de capital pendente pela empresa.
    Example: 3750.02

  - `results.company_partnership_stakes.ownership_share` (number, required)
    A porcentagem de participação acionária da empresa.
    Example: 25.25

  - `results.company_partnership_stakes.profit_share` (number, required)
    A porcentagem de participação nos lucros da empresa.
    Example: 31.25

  - `results.regimes` (array,null)
    Uma lista de regimes tributários para a entidade fiscal.

  - `results.regimes.type` (string, required)
    O tipo de regime tributário, conforme definido pelo Servicio de Impuestos Internos (SII).
    Example: "MICRO EMPRESA"

  - `results.regimes.start_date` (string, required)
    A data em que a entidade fiscal iniciou este regime tributário, no formato YYYY-MM-DD.
    Example: "2023-01-01"

  - `results.authorized_tax_documents` (array,null)
    Uma lista de documentos fiscais autorizados para a entidade fiscal.

  - `results.authorized_tax_documents.type` (string, required)
    O tipo de documento fiscal autorizado, conforme definido pelo Servicio de Impuestos Internos (SII).
    Example: "CONTABILIDAD EN HOJAS SUELTAS CON NRO.UN"

  - `results.authorized_tax_documents.document_limit` (integer, required)
    O número máximo de documentos que podem ser emitidos sob esta autorização.
    Example: 2000

  - `results.authorized_tax_documents.authorization_date` (string, required)
    A data em que o documento fiscal e o limite foram estabelecidos, no formato YYYY-MM-DD.
    Example: "2010-18-11"

  - `results.property_tax_liabilities` (array,null)
    Uma lista de obrigações fiscais de uma propriedade com a qual a entidade está associada.

  - `results.property_tax_liabilities.property_id` (string, required)
    O identificador único da propriedade, de acordo com o Servicio de Impuestos Internos (SII).
    Example: "12345"

  - `results.property_tax_liabilities.district` (string, required)
    O distrito onde a propriedade está localizada.
    Example: "NUNAO"

  - `results.property_tax_liabilities.address` (string, required)
    O endereço da propriedade.
    Example: "123 Example Street"

  - `results.property_tax_liabilities.type` (string, required)
    O tipo de propriedade associado à responsabilidade fiscal.
    Example: "HABITACIONAL"

  - `results.property_tax_liabilities.overdue_tax_payments` (array, required)
    Uma lista de pagamentos de impostos atrasados para a propriedade.

  - `results.property_tax_liabilities.overdue_tax_payments.year` (integer, required)
    O ano para o qual o pagamento do imposto está atrasado.
    Example: 2023

  - `results.property_tax_liabilities.overdue_tax_payments.installment` (integer, required)
    O número da parcela do pagamento de imposto em atraso.
    Example: 1

  - `results.property_tax_liabilities.overdue_tax_payments.due_date` (string, required)
    A data de vencimento do pagamento de imposto em atraso, no formato YYYY-MM-DD.
    Example: "2023-04-30"

  - `results.property_tax_liabilities.overdue_tax_payments.amount_due` (number, required)
    O valor devido para o pagamento de imposto em atraso.
    Example: 19.864

  - `results.property_tax_liabilities.scheduled_tax_payments` (array, required)
    Uma lista de pagamentos de impostos agendados para a propriedade.

  - `results.property_tax_liabilities.scheduled_tax_payments.year` (integer, required)
    O ano para o qual o pagamento do imposto está agendado.
    Example: 2023

  - `results.property_tax_liabilities.scheduled_tax_payments.installment` (integer, required)
    O número da parcela do pagamento de imposto programado.
    Example: 1

  - `results.property_tax_liabilities.scheduled_tax_payments.due_date` (string, required)
    A data de vencimento do pagamento de imposto agendado, no formato YYYY-MM-DD.
    Example: "2023-04-30"

  - `results.property_tax_liabilities.scheduled_tax_payments.amount_due` (number, required)
    O valor devido para o pagamento de imposto agendado.
    Example: 19.864

  - `results.fiscal_office` (object)
    Detalhes sobre o escritório fiscal onde a entidade fiscal está registrada.

  - `results.fiscal_office.name` (string, required)
    O nome do escritório fiscal onde a entidade fiscal está registrada.
    Example: "VIÑA DEL MAR"

  - `results.fiscal_office.address` (string, required)
    O endereço do escritório fiscal onde a entidade fiscal está registrada.
    Example: "ARLEGUI 525, VIÑA DEL MAR"

## 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 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"