# Obter os detalhes de uma fatura

Obtenha os detalhes de uma fatura específica.

{% admonition type="info" %}
  Este recurso pode retornar campos obsoletos. Por favor, verifique a documentação da resposta para mais informações.
{% /admonition %}

Endpoint: GET /api/invoices/{id}/
Version: 1.223.0
Security: basicAuth

## Path parameters:

  - `id` (string, required)
    O  sobre o qual você deseja obter informações detalhadas.

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

## 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.
    Example: "A1A1A1A1-2B2B-3C33-D44D-555555E55EE"

  - `invoice_date` (string,null, required)
    A data da fatura, no formato .
    Example: "2019-12-01"

  - `status` (string,null, required)
    O status da fatura. Pode ser  (válido) ou  (cancelado).
    Example: "Vigente"

  - `invoice_type` (string,null, required)
    A classificação da fatura pela instituição fiscal.

Para o SAT do México, retornamos um dos seguintes valores:

  - 
  - 
  - 
  - 
  -
    Enum: "Egreso", "Ingreso", "Nómina", "Pago", "Traslado"

  - `type` (string,null, required)
    A direção da fatura (do ponto de vista do proprietário do Link).
-  indica uma fatura enviada.
-  indica uma fatura recebida.
    Enum: "OUTFLOW", "INFLOW", null

  - `tax_details` (object)
    Informações gerais sobre os impostos da fatura.

  - `tax_details.total_tax_retained` (number)
    Valor total dos impostos retidos.
    Example: 194.27

  - `tax_details.total_tax_transferred` (number)
    Valor total dos impostos transferidos.
    Example: 150.4

  - `tax_details.retained_taxes` (array)
    Lista de impostos retidos.

  - `tax_details.retained_taxes.tax` (string)
    O tipo de imposto retido (por exemplo, ISR, IVA ou IEPS).
    Example: "ISR"

  - `tax_details.retained_taxes.tax_percentage` (number,null)
    A porcentagem de imposto retido.

  - `tax_details.retained_taxes.pre_tax_amount` (number,null)
    O valor antes dos impostos.

  - `tax_details.retained_taxes.tax_amount` (number)
    O valor do imposto retido.
    Example: 94

  - `tax_details.transferred_taxes` (array)
    Lista de impostos transferidos.

  - `tax_details.transferred_taxes.tax` (string)
    O tipo de imposto transferido (por exemplo, ISR, IVA ou IEPS).
    Example: "IVA"

  - `tax_details.transferred_taxes.tax_percentage` (number)
    A porcentagem de imposto transferido.
    Example: 16

  - `tax_details.transferred_taxes.tax_amount` (number)
    O valor do imposto transferido.
    Example: 150.4

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

  - `sender_fiscal_regime` (string,null)
    O regime tributário do remetente, conforme definido pela pessoa jurídica no país.
    Example: "601"

  - `sender_name` (string,null, required)
    O nome do remetente da fatura.
    Example: "ACME CORP"

  - `sender_tax_fraud_status` (string,null)
    Indica se o remetente está ou não na lista de fraude fiscal do SAT por ter enviado dados incorretos, ter pagamentos pendentes ou ter realizado negócios que violam os regulamentos da instituição fiscal.

O SAT atualiza a lista de fraude fiscal a cada três meses. 

Para mais informações sobre os motivos pelos quais um contribuinte pode ser incluído na lista de fraude fiscal, consulte o Artigo 69 e o Artigo 69-B do Código Fiscal da Federação do México.


Os status possíveis são:

-  
A instituição fiscal identificou irregularidades e abriu uma investigação sobre o contribuinte.

-  
A instituição fiscal investigou o contribuinte e o declarou inocente.

-  
A instituição fiscal confirmou que o contribuinte é culpado.

-  
A instituição fiscal reavaliou um contribuinte previamente confirmado e, com base em novas evidências, retirou o contribuinte da lista de fraude fiscal.

-  
O receptor ou remetente não é encontrado na lista (ou seja, está em conformidade com os regulamentos da instituição fiscal).
    Example: "NO_TAX_FRAUD_STATUS"

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

  - `receiver_postal_code` (string)
    O código postal do destinatário.
    Example: "11560"

  - `receiver_fiscal_regime` (string,null)
    O regime tributário do recebedor, conforme definido pela pessoa jurídica no país.
    Example: "601"

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

  - `receiver_tax_fraud_status` (string,null)
    Indica se o destinatário está ou não na lista de fraude fiscal do SAT por ter enviado dados incorretos, ter pagamentos pendentes ou ter realizado negócios que violam os regulamentos da instituição fiscal.

O SAT atualiza a lista de fraude fiscal a cada três meses. 

Para mais informações sobre os motivos pelos quais um contribuinte pode ser incluído na lista de fraude fiscal, consulte o Artigo 69 e o Artigo 69-B do Código Fiscal da Federação do México.


Os status possíveis são:

-  
A instituição fiscal identificou irregularidades e abriu uma investigação sobre o contribuinte.

-  
A instituição fiscal investigou o contribuinte e o declarou inocente.

-  
A instituição fiscal confirmou que o contribuinte é culpado.

-  
A instituição fiscal reavaliou um contribuinte previamente confirmado e, com base em novas evidências, retirou o contribuinte da lista de fraude fiscal.

-  
O destinatário ou remetente não é encontrado na lista (ou seja, está em conformidade com os regulamentos da instituição fiscal).
    Example: "NO_TAX_FRAUD_STATUS"

  - `cancelation_status` (string,null, required)
    Se a fatura for cancelada, este campo indica o status do cancelamento.

  - `cancelation_update_date` (string,null, required)
    A data do cancelamento da fatura, no formato .
    Example: "2019-12-02"

  - `certification_date` (string,null, required)
    A data da certificação fiscal, no formato .
    Example: "2019-12-01"

  - `certification_authority` (string,null, required)
    O ID fiscal do provedor de certificação.
    Example: "CCC333333CC33"

  - `payment_type` (string,null, required)
    O código do tipo de pagamento usado para esta fatura, conforme definido pela entidade legal do país.

- 🇲🇽 México Artigo de referência do catálogo SAT
    Example: "99"

  - `payment_method` (string,null)
    O código do método de pagamento usado para esta fatura, conforme definido pela entidade legal do país.

- 🇲🇽 México artigo de referência do catálogo SAT. Para o México, retornamos ,  ou .
    Enum: "PUE", "PPD", null

  - `usage` (string,null)
    O código de uso da fatura, conforme definido pela entidade legal do país.

- 🇲🇽 México artigo de referência do catálogo SAT
    Example: "P01"

  - `version` (string,null)
    A versão CFDI da fatura.
    Example: "3.3"

  - `place_of_issue` (string,null)
    O código postal de onde a fatura foi emitida.
    Example: "01165"

  - `invoice_details` (array, required)
    Uma lista de descrições para cada item (produto comprado ou serviço prestado) na fatura.

  - `invoice_details.description` (string,null, required)
    A descrição do item da fatura (uma fatura pode ter um ou mais itens).
    Example: "December 2019 accounting fees"

  - `invoice_details.product_identification` (string,null, required)
    O código de identificação do produto ou serviço, conforme definido pela entidade legal no país.\n- \U0001F1F2\U0001F1FD México.
    Example: "84101600"

  - `invoice_details.quantity` (number,null, required)
    A quantidade deste item da fatura.
    Example: 10

  - `invoice_details.unit_code` (string,null, required)
    A unidade de medida, conforme definida pela entidade legal no país. \n- \U0001F1F2\U0001F1FD México referência do catálogo SAT.
    Example: "E48"

  - `invoice_details.unit_description` (string,null, required)
    A descrição do item, conforme definido pela entidade legal no país.\n- \U0001F1F2\U0001F1FD México referência do catálogo SAT.
    Example: "Unidad de servicio"

  - `invoice_details.unit_amount` (number,null, required)
    O preço de um único item.
    Example: 200

  - `invoice_details.tax_type` (string,null)
    O tipo de imposto do item.

  - `invoice_details.pre_tax_amount` (number,null, required)
    O preço total deste item antes da aplicação de impostos é ( x ).
    Example: 400

  - `invoice_details.tax_percentage` (number,null, required)
    A porcentagem de imposto a ser aplicada.
    Example: 16

  - `invoice_details.tax_amount` (number,null, required)
    O valor do imposto para este item da fatura ( x ).
    Example: 64

  - `invoice_details.total_amount` (number,null, required)
    O preço total para este item da fatura ( + ).
    Example: 464

  - `invoice_details.retained_taxes` (array)
    O imposto retido no item da fatura.

  - `invoice_details.retained_taxes.retained_tax_amount` (number,null, required)
    O valor do imposto retido.
    Example: 209.79

  - `invoice_details.transferred_taxes` (array)
    Os impostos transferidos relacionados à fatura.

  - `invoice_details.transferred_taxes.transferred_tax_amount` (number,null, required)
    O valor do imposto transferido.
    Example: 209.79

  - `currency` (string,null, required)
    A moeda da fatura. Por exemplo:

- 🇧🇷 BRL (Real Brasileiro)
- 🇨🇴 COP (Peso Colombiano)
- 🇲🇽 MXN (Peso Mexicano)
- 🇺🇸 USD (Dólar dos Estados Unidos)
    Example: "MXN"

  - `subtotal_amount` (number,null, required)
    O valor antes dos impostos desta fatura (soma do  de cada item).
    Example: 400

  - `exchange_rate` (number,null, required)
    A taxa de câmbio utilizada nesta fatura para a moeda.
    Example: 0.052

  - `tax_amount` (number,null, required)
    O valor do imposto para esta fatura (soma do  de cada item).
    Example: 64

  - `discount_amount` (number,null, required)
    O valor total descontado nesta fatura.
    Example: 10

  - `total_amount` (number,null, required)
    O valor total da fatura ( +  - )
    Example: 454

  - `related_invoices` (array)
    Uma lista de faturas relacionadas.

  - `related_invoices.relationship_type` (string,null)
    O tipo de relação entre esta fatura e a fatura relacionada, conforme definido pela entidade legal no país. Para mais informações, consulte nosso artigo de referência do catálogo SAT.
    Example: "01"

  - `related_invoices.related_invoice_identification` (string,null)
    O ID SAT da nota fiscal relacionada.
    Example: "INV-123456"

  - `payments` (array, required)
    Uma lista detalhando todos os pagamentos de faturas.

  - `payments.date` (string,null, required)
    Carimbo de data/hora ISO-8601 quando o pagamento foi realizado.
    Example: "2020-03-17T12:00:00.000Z"

  - `payments.payment_type` (string,null, required)
    Código do tipo de pagamento usado para esta fatura, conforme definido pela entidade legal do país.

- 🇲🇽 México artigo de referência do catálogo SAT
    Example: "03"

  - `payments.currency` (string,null, required)
    A moeda do pagamento. Por exemplo:

- 🇧🇷 BRL (Real Brasileiro)
- 🇨🇴 COP (Peso Colombiano)
- 🇲🇽 MXN (Peso Mexicano)

Por favor, note que outras moedas além das listadas acima podem ser retornadas.
    Example: "BRL"

  - `payments.exchange_rate` (string,null, required)
    A taxa de câmbio de  para MXN no momento em que o pagamento foi realizado.
    Example: "3.75"

  - `payments.amount` (number,null, required)
    O valor da fatura, na moeda da fatura original.
    Example: 8000.5

  - `payments.operation_number` (string,null, required)
    O identificador interno da instituição fiscal para a operação.
    Example: "831840"

  - `payments.beneficiary_rfc` (string,null)
    O ID fiscal do beneficiário do pagamento.
    Example: "BNM840515VB1"

  - `payments.beneficiary_account_number` (string,null, required)
    O número da conta bancária do beneficiário do pagamento.
    Example: "12343453245633"

  - `payments.payer_rfc` (string,null, required)
    O ID fiscal do emissor do pagamento.
    Example: "BKJM840515VB1"

  - `payments.payer_account_number` (string,null, required)
    O número da conta bancária do emissor do pagamento.
    Example: "13343663245699"

  - `payments.payer_bank_name` (string,null, required)
    A instituição bancária que foi utilizada pelo emissor do pagamento.
    Example: "CITI BANAMEX"

  - `payments.related_documents` (array, required)
    Uma lista de todas as faturas diferidas relacionadas afetadas pelo pagamento.

  - `payments.related_documents.invoice_identification` (string,null, required)
    O ID exclusivo da instituição fiscal para a fatura diferida relacionada.
    Example: "7EE015F3-6311-11EA-B02A-00155D014007"

  - `payments.related_documents.currency` (string,null, required)
    A moeda da fatura relacionada. Por exemplo:

- 🇧🇷 BRL (Real Brasileiro)
- 🇨🇴 COP (Peso Colombiano)
- 🇲🇽 MXN (Peso Mexicano)

Por favor, note que outras moedas além das listadas acima podem ser retornadas.
    Example: "MXN"

  - `payments.related_documents.payment_method` (string,null, required)
    O método de pagamento da fatura relacionada.
    Example: "PPD"

  - `payments.related_documents.partiality_number` (integer)
    O número da parcela de pagamento.
    Example: 1

  - `payments.related_documents.previous_balance` (number,null, required)
    O valor da fatura antes do pagamento.
    Example: 18877.84

  - `payments.related_documents.amount_paid` (number,null, required)
    O valor pago nesta parcela.
    Example: 8000

  - `payments.related_documents.outstanding_balance` (number,null, required)
    O valor restante a ser pago.
    Example: 10877.84

  - `payroll` (object,null, required)
    Detalhes sobre o pagamento da folha de pagamento. Aplicável apenas para faturas de folha de pagamento.

  - `payroll.days` (integer,null, required)
    O número de dias cobertos pelo pagamento.
    Example: 30

  - `payroll.type` (string,null, required)
    O tipo de folha de pagamento, conforme definido pela entidade legal do país.

- 🇲🇽 México artigo de referência do catálogo SAT
    Example: "O"

  - `payroll.amount` (number, required)
    O valor total do pagamento da folha de pagamento.
    Example: 20400.1

  - `payroll.version` (string, required)
    A versão do objeto de folha de pagamento.
    Example: "1.2"

  - `payroll.date_from` (string,null, required)
    A data de início do período de pagamento, no formato .
    Example: "2018-07-01"

  - `payroll.date_to` (string,null, required)
    A data de término do período de pagamento, no formato .
    Example: "2018-07-31"

  - `payroll.payment_date` (string, required)
    A data de pagamento, no formato .
    Example: "2018-07-16"

  - `payroll.periodicity` (string,null)
    Com que frequência o pagamento da folha de pagamento é realizado.

Para o SAT do México, retornamos um dos seguintes valores:

  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  -
    Enum: "DAILY", "WEEKLY", "TENTH_DAY", "FOURTEENTH_DAY", "FIFTEENTH_DAY", "MONTHLY", "BIMONTHLY", "PER_TASK", "COMMISSION", "ONE_OFF", "OTHER_PERIODICITY", "null"

  - `payroll.earnings_breakdown` (array,null)
    Uma análise detalhada dos ganhos para o pagamento da folha de pagamento.

  - `payroll.earnings_breakdown.type` (string,null)
    O tipo de renda. Para uma lista completa de valores possíveis, consulte a tabela de tipos de detalhamento de ganhos da folha de pagamento.
    Example: "CHRISTMAS_BONUS"

  - `payroll.earnings_breakdown.taxable_amount` (number)
    O valor da renda que é tributável.
    Example: 1505

  - `payroll.earnings_breakdown.vat_free_amount` (number)
    O valor da receita que não está sujeito ao IVA.

  - `payroll.tax_deductions` (array,null)
    Uma análise das deduções fiscais no pagamento da folha de pagamento.

  - `payroll.tax_deductions.type` (string,null)
    O tipo de dedução fiscal. Para uma lista completa de valores possíveis, consulte a tabela de tipos de deduções fiscais de folha de pagamento.
    Example: "UNION_FEES"

  - `payroll.tax_deductions.amount` (number)
    O valor da dedução fiscal.
    Example: 1505

  - `payroll.other_payments` (array,null)
    Uma análise detalhada de outros pagamentos para a folha de pagamento.

  - `payroll.other_payments.type` (string,null)
    O tipo de outro pagamento. Para uma lista completa de valores possíveis, consulte a tabela de tipos de outros pagamentos de folha de pagamento.
    Example: "EMPLOYMENT_SUBSIDY"

  - `payroll.other_payments.amount` (number)
    O valor do outro pagamento.
    Example: 1505

  - `folio` (string,null)
    O número de controle interno que o contribuinte atribui à nota fiscal.
    Example: "26"

  - `export_type` (string,null)
    O tipo de exportação da fatura, conforme definido pela entidade legal no país. Para mais informações, consulte nosso artigo de referência do catálogo SAT.
    Example: "01"

  - `xml` (string,null)
    XML do documento da fatura.

  - `warnings` (object,null)
    Objeto contendo informações sobre quaisquer avisos relacionados a esta fatura.

  - `warnings.code` (string,null, required)
    O código de aviso. Pode ser um dos seguintes:

  - 
  - 
  -
    Example: "sat_xml_limit_reached"

  - `warnings.message` (string,null, required)
    A descrição do aviso.

A mensagem dependerá do código de aviso:


O limite diário para downloads de XML definido pelo SAT foi atingido, portanto, esta nota fiscal pode estar com dados faltando. Por favor, verifique https://tinyurl.com/yydzhy5d para mais informações sobre este erro.


O download dos detalhes das notas fiscais não está disponível. O portal do SAT retornou um erro 503.
    Example: "The daily limit for XML downloads set by SAT was reached so this invoice\nmight be missing data. Please check https://tinyurl.com/yydzhy5d for more\ninformation on this error.\n"

  - `payment_type_description` (string,null, required)

  - `payment_method_description` (string,null)
    

  - `sender_blacklist_status` (string,null)
    Por favor, use  em vez disso.

  - `receiver_blacklist_status` (string,null)
    Por favor, use  em vez disso.

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