# Recuperar retenções de impostos para um link

Recupere informações de retenção de impostos de um link específico. O número máximo de retenções de impostos que pode ser retornado para um período é 500.

Endpoint: POST /api/tax-retentions/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `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.

## Request fields (application/json):

  - `link` (string, required)
    O  para o qual você deseja recuperar informações.
    Example: "c81a1dea-6dd6-4999-8b9f-541ee8197058"

  - `date_from` (string, required)
    A data a partir da qual você deseja começar a obter dados, no formato .

⚠️ O valor de  não pode ser maior que .
    Example: "2020-08-05"

  - `date_to` (string, required)
    A data em que você deseja parar de receber dados, no formato .

⚠️ O valor de  não pode ser maior que a data de hoje (ou seja, não são permitidas datas futuras).
    Example: "2020-10-05"

  - `type` (string, required)
    O tipo de retenção de imposto em relação à fatura (do ponto de vista do proprietário do Link).

-  refere-se a uma retenção de imposto para uma fatura enviada.
-  refere-se a uma retenção de imposto para uma fatura recebida.
    Enum: "OUTFLOW", "INFLOW"

  - `attach_xml` (boolean)
    Quando definido como , você receberá a fatura XML na resposta.

  - `save_data` (boolean)
    Indica se os dados devem ou não ser persistidos no Belvo. Por padrão, isso é definido como  e retornamos uma resposta 201 Created.

Quando definido como , os dados não serão persistidos e retornamos uma resposta 200 OK.
    Example: true

## Response 200 fields (application/json):

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

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

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

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

  - `invoice_identification` (string,null, required)
    O ID único da instituição fiscal para a fatura à qual a retenção de imposto se refere.
    Example: "def404af-5eef-4112-aa99-d1ec8493b89a"

  - `version` (string,null, required)
    A versão CFDI das retenções de impostos.
    Example: "1.0"

  - `code` (integer,null, required)
    O código de retenção de impostos. Para mais informações, consulte nosso artigo SAT Catalogs no DevPortal.
    Example: 25

  - `issued_at` (string,null, required)
    O carimbo de data/hora ISO-8601 de quando a retenção de imposto foi emitida.
    Example: "2019-01-03T21:10:40.000Z"

  - `certified_at` (string,null, required)
    O carimbo de data/hora ISO-8601 de quando a retenção de imposto foi certificada.
    Example: "2019-01-03T21:10:41.000Z"

  - `cancelled_at` (string,null, required)
    O carimbo de data/hora ISO-8601 de quando a retenção de imposto foi cancelada (se aplicável).

  - `sender_id` (string,null, required)
    O ID fiscal do remetente da fatura.
    Example: "JKUF980404P0"

  - `sender_name` (string,null, required)
    O nome do remetente da fatura.
    Example: "Roberto Nunez Batman"

  - `receiver_nationality` (string,null, required)
    Se o destinatário da fatura é um nacional mexicano ou não. Se o destinatário não for considerado um nacional mexicano, os impostos retidos podem ser calculados de forma diferente. Valores possíveis:
  - 
  -
    Enum: "NATIONAL", "FOREIGN"

  - `receiver_id` (string,null, required)
    O ID fiscal do destinatário da fatura.
    Example: "GYGK3207809L1"

  - `receiver_name` (string,null, required)
    O nome do destinatário da fatura.
    Example: "ACME LTD"

  - `total_invoice_amount` (number,null, required)
    O valor total da fatura ao qual a retenção de imposto se refere.
    Example: 53249.8

  - `total_exempt_amount` (number,null, required)
    Valor total isento de tributação.
    Example: 1000.8

  - `total_retained_amount` (number,null, required)
    Total de impostos retidos.
    Example: 1550.7

  - `total_taxable_amount` (number,null, required)
    O valor total que pode ser tributado. Calculado como  - .
    Example: 43249

  - `retention_breakdown` (array,null, required)
    Uma análise detalhada dos impostos retidos.

  - `retention_breakdown.base_amount` (number,null, required)
    O valor base que foi utilizado para calcular a retenção de imposto.
    Example: 0.03

  - `retention_breakdown.tax_type` (string,null, required)
    Atributo opcional para indicar o tipo de imposto retido para o período ou ano de acordo com o catálogo SAT.
    Example: "01"

  - `retention_breakdown.retained_amount` (number,null, required)
    O valor retido.

  - `retention_breakdown.payment_status` (string,null, required)
    Indica se o imposto foi pago ou não. Pode ser:
  - 
  -
    Enum: "PAID", "PROVISIONED"

  - `xml` (string,null, required)
    O documento de retenção de impostos em formato XML.
    Example: "=XML-STRING="

## Response 201 fields (application/json):

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

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

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

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

  - `invoice_identification` (string,null, required)
    O ID único da instituição fiscal para a fatura à qual a retenção de imposto se refere.
    Example: "def404af-5eef-4112-aa99-d1ec8493b89a"

  - `version` (string,null, required)
    A versão CFDI das retenções de impostos.
    Example: "1.0"

  - `code` (integer,null, required)
    O código de retenção de impostos. Para mais informações, consulte nosso artigo SAT Catalogs no DevPortal.
    Example: 25

  - `issued_at` (string,null, required)
    O carimbo de data/hora ISO-8601 de quando a retenção de imposto foi emitida.
    Example: "2019-01-03T21:10:40.000Z"

  - `certified_at` (string,null, required)
    O carimbo de data/hora ISO-8601 de quando a retenção de imposto foi certificada.
    Example: "2019-01-03T21:10:41.000Z"

  - `cancelled_at` (string,null, required)
    O carimbo de data/hora ISO-8601 de quando a retenção de imposto foi cancelada (se aplicável).

  - `sender_id` (string,null, required)
    O ID fiscal do remetente da fatura.
    Example: "JKUF980404P0"

  - `sender_name` (string,null, required)
    O nome do remetente da fatura.
    Example: "Roberto Nunez Batman"

  - `receiver_nationality` (string,null, required)
    Se o destinatário da fatura é um nacional mexicano ou não. Se o destinatário não for considerado um nacional mexicano, os impostos retidos podem ser calculados de forma diferente. Valores possíveis:
  - 
  -
    Enum: "NATIONAL", "FOREIGN"

  - `receiver_id` (string,null, required)
    O ID fiscal do destinatário da fatura.
    Example: "GYGK3207809L1"

  - `receiver_name` (string,null, required)
    O nome do destinatário da fatura.
    Example: "ACME LTD"

  - `total_invoice_amount` (number,null, required)
    O valor total da fatura ao qual a retenção de imposto se refere.
    Example: 53249.8

  - `total_exempt_amount` (number,null, required)
    Valor total isento de tributação.
    Example: 1000.8

  - `total_retained_amount` (number,null, required)
    Total de impostos retidos.
    Example: 1550.7

  - `total_taxable_amount` (number,null, required)
    O valor total que pode ser tributado. Calculado como  - .
    Example: 43249

  - `retention_breakdown` (array,null, required)
    Uma análise detalhada dos impostos retidos.

  - `retention_breakdown.base_amount` (number,null, required)
    O valor base que foi utilizado para calcular a retenção de imposto.
    Example: 0.03

  - `retention_breakdown.tax_type` (string,null, required)
    Atributo opcional para indicar o tipo de imposto retido para o período ou ano de acordo com o catálogo SAT.
    Example: "01"

  - `retention_breakdown.retained_amount` (number,null, required)
    O valor retido.

  - `retention_breakdown.payment_status` (string,null, required)
    Indica se o imposto foi pago ou não. Pode ser:
  - 
  -
    Enum: "PAID", "PROVISIONED"

  - `xml` (string,null, required)
    O documento de retenção de impostos em formato XML.
    Example: "=XML-STRING="

## Response 403 fields (application/json):

  - `code` (string)
    Um código de erro único () 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 , a descrição é:

  - .
    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: ). 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 () que permite classificar e lidar com o erro programaticamente.
    Example: "not_found"

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

Para erros , a descrição é:

  -
    Example: "Not found"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: ). 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 () 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 , a descrição é:

  - .
    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: ). 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 () 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 , a descrição é:

- .
    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: ). 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: ).
    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 , 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 () 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 , a descriçã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: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"