# Listar faturas

## ▶️ Uso

Com o método Listar Faturas, você pode:

1. Listar faturas relacionadas a um link.id específico (usando o parâmetro de consulta link).
2. Obter os detalhes de um invoice.id específico (usando o parâmetro de consulta id).
3. [Não Recomendado] Listar todas as faturas relacionadas à 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/invoices/
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 invoice.

  - `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.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.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.total_amount` (number)
    O valor total da fatura, incluindo IVA e outros impostos ou encargos.
    Example: 3272500.02

  - `results.net_amount` (number)
    O valor total da fatura após o IVA e outros impostos.
    Example: 2750000.02

  - `results.vat_amount` (number)
    O valor total do IVA da fatura.
    Example: 522500.02

  - `results.currency` (string)
    O código de moeda de três letras (ISO-4217) da fatura.
    Example: "CLP"

  - `results.issue_date` (string)
    A data em que a fatura foi emitida, no formato YYYY-MM-DD.
    Example: "2024-09-23"

  - `results.received_at` (string)
    O carimbo de data/hora ISO-8601 de quando a fatura foi recebida.
    Example: "2024-09-02T15:23:47-03:00"

  - `results.acknowledged_at` (string)
    O carimbo de data e hora ISO-8601 de quando a fatura foi reconhecida como recebida.
    Example: "2024-09-02T15:23:47-03:00"

  - `results.claim_date` (string,null)
    A data em que uma reclamação ou disputa foi levantada sobre a fatura, no formato YYYY-MM-DD.

  - `results.status` (string)
    O status da fatura. Pode ser:

  - REGISTERED
  - PENDING
  - REJECTED
  - CANCELLED
    Example: "REGISTERED"

  - `results.document_code` (integer)
    Um código que indica se o documento é uma fatura, uma nota de crédito ou débito, e assim por diante.
    Example: 33

  - `results.category` (string)
    A categoria da fatura, de acordo com a instituição.
    Example: "Del Giro"

  - `results.folio` (string)
    O código único da instituição para a fatura.
    Example: "23559723"

  - `results.sender_id` (string)
    O número de identificação do remetente. Para o SII Chile, este é o RUT.
    Example: "59324768-2"

  - `results.sender_name` (string)
    O nome registrado do remetente.
    Example: "Cafe del Sur"

  - `results.receiver_id` (string)
    O número de identificação do receptor. Para o SII Chile, este é o RUT.
    Example: "82136549-6"

  - `results.receiver_name` (string)
    O nome registrado do receptor.
    Example: "Alejandra Gonzalez"

  - `results.type` (string)
    Indica se a fatura é um INFLOW ou OUTFLOW.
    Enum: "INFLOW", "OUTFLOW"

  - `results.purchase_invoice_details` (object,null)
    Detalhes sobre a nota fiscal de compra. Se a nota fiscal for uma nota de venda (type = OUTFLOW), este campo retornará null.

  - `results.purchase_invoice_details.vat_refundable_amount` (number,null)
    O valor do IVA pago que é elegível para ser reivindicado como crédito fiscal.
    Example: 300.02

  - `results.purchase_invoice_details.vat_non_refundable_amount` (number,null)
    O valor do IVA pago que não pode ser recuperado como crédito fiscal.
    Example: 20.02

  - `results.purchase_invoice_details.vat_non_refundable_code` (integer,null)
    Um código que identifica o motivo pelo qual o VAT não é recuperável.
    Example: 90

  - `results.purchase_invoice_details.net_amount_fixed_assets` (number,null)
    O valor líquido dos ativos fixos adquiridos.
    Example: 8000.02

  - `results.purchase_invoice_details.vat_fixed_assets` (number,null)
    O valor do IVA na compra de ativos fixos.
    Example: 80.02

  - `results.purchase_invoice_details.vat_common_use` (number,null)
    O IVA que se aplica a compras usadas para fins tanto tributáveis quanto não tributáveis.
    Example: 129.02

  - `results.purchase_invoice_details.tax_non_credit_amount` (number,null)
    O valor do imposto que não pode ser reivindicado como crédito.
    Example: 5.02

  - `results.purchase_invoice_details.vat_non_withheld` (number,null)
    O valor do IVA que não foi retido pelo comprador.
    Example: 8.02

  - `results.purchase_invoice_details.tax_exempt_amount` (number,null)
    A parte da compra que é isenta de IVA.
    Example: 33.02

  - `results.purchase_invoice_details.credit_or_debit_note_on_purchase` (boolean,null)
    Indica se a fatura está vinculada a uma nota de crédito ou débito.

  - `results.purchase_invoice_details.tax_cigarettes_amount` (number,null)
    O valor total do imposto aplicado sobre cigarros.
    Example: 50.02

  - `results.purchase_invoice_details.tax_cigar_amount` (number,null)
    O valor total do imposto aplicado sobre charutos.
    Example: 51.02

  - `results.purchase_invoice_details.tax_processed_tobacco_amount` (number,null)
    O valor total do imposto aplicado sobre o tabaco processado.
    Example: 49.02

  - `results.purchase_invoice_details.additional_tax_amount` (number,null)
    O valor total do imposto do imposto adicional.
    Example: 1005.02

  - `results.purchase_invoice_details.additional_tax_rate` (string,null)
    A alíquota do imposto adicional.
    Example: "2.1"

  - `results.purchase_invoice_details.additional_tax_code` (integer,null)
    O código tributário para o imposto adicional.
    Example: 50993

  - `results.sales_invoice_details` (object,null)
    Detalhes sobre a nota fiscal de vendas. Se a nota fiscal for uma nota de compra (type = INFLOW), este campo retornará null.

  - `results.sales_invoice_details.construction_sector_tax_credit` (number,null)
    O valor do crédito fiscal aplicável para empresas de construção.
    Example: 50000.02

  - `results.sales_invoice_details.tax_free_trade_zone_amount` (number,null)
    Imposto aplicável para transações em zonas de livre comércio.
    Example: 38490.02

  - `results.sales_invoice_details.container_deposit_guarantee` (number,null)
    Refere-se a depósitos ou garantias em recipientes, se aplicável.
    Example: 0.02

  - `results.sales_invoice_details.is_free_of_charge` (boolean,null)
    Indique se esta venda foi feita sem custo (por exemplo, a fatura é para material promocional, reabastecimentos periódicos gratuitos e similares).

  - `results.sales_invoice_details.periodic_billing_type` (boolean,null)
    Marca se a fatura é para serviços periódicos.

  - `results.sales_invoice_details.non_billable_amount` (number,null)
    A parte da transação que não é faturável.
    Example: 40.02

  - `results.sales_invoice_details.total_amount_for_period` (number,null)
    O valor total para um período específico, frequentemente usado para faturamento periódico.

  - `results.sales_invoice_details.domestic_transportation_amount` (number,null)
    O valor total gasto em transporte doméstico.
    Example: 67.02

  - `results.sales_invoice_details.international_transportation_amount` (number,null)
    O valor total gasto em transporte internacional.
    Example: 56.02

  - `results.sales_invoice_details.branch_code` (integer,null)
    O código da filial fiscal onde a nota fiscal de vendas foi emitida.
    Example: 76129014

  - `results.sales_invoice_details.tax_exempt_amount` (number,null)
    A parte da venda que é isenta de IVA.
    Example: 4000.02

  - `results.sales_invoice_details.credit_or_debit_note_on_purchase` (boolean,null)
    Indica se a fatura está vinculada a uma nota de crédito ou débito.

  - `results.sales_invoice_details.additional_tax_code` (integer,null)
    O código tributário para o imposto adicional.
    Example: 50993

  - `results.sales_invoice_details.additional_tax_rate` (string,null)
    A alíquota do imposto adicional.
    Example: "2.1"

  - `results.sales_invoice_details.additional_tax_amount` (number,null)
    O valor total do imposto do imposto adicional.
    Example: 1005.02

  - `results.sales_invoice_details.vat_total_withheld` (number,null)
    O total do IVA retido.
    Example: 33.02

  - `results.sales_invoice_details.vat_partially_withheld` (number,null)
    O valor do IVA parcialmente retido.
    Example: 30.02

  - `results.sales_invoice_details.vat_non_withheld` (number,null)
    O valor do IVA que não foi retido.
    Example: 40.02

  - `results.sales_invoice_details.vat_sales` (number,null)
    O valor do IVA correspondente às próprias vendas do vendedor.
    Example: 100.02

  - `results.sales_invoice_details.vat_third_party` (number,null)
    Valor do IVA relacionado a vendas de terceiros ao atuar como intermediário.
    Example: 1000.02

  - `results.sales_invoice_details.vat_past_due` (number,null)
    IVA que é contabilizado ou pago após a data de vencimento.
    Example: 31.02

  - `results.sales_invoice_details.invoice_settlement_sender_id` (string,null)
    O RUT da entidade que emitiu a liquidação para a fatura.
    Example: "55524768-7"

  - `results.sales_invoice_details.invoice_settlement_net_commission` (number,null)
    O valor líquido da comissão na liquidação da fatura.
    Example: 54.02

  - `results.sales_invoice_details.invoice_settlement_exempt_commission` (number,null)
    A parte da comissão na liquidação da fatura que está isenta de impostos.
    Example: 16.02

  - `results.sales_invoice_details.invoice_settlement_vat_commission` (number,null)
    IVA cobrado sobre o valor da comissão na liquidação da fatura.
    Example: 78.02

  - `results.sales_invoice_details.reference_document_type` (string,null)
    Indica o tipo de documento ao qual esta fatura se refere ou está vinculada.

  - `results.sales_invoice_details.reference_document_folio` (string,null)
    O número do fólio do documento referido.

  - `results.sales_invoice_details.foreign_recipient_id` (string,null)
    O número de identificação de um indivíduo estrangeiro.
    Example: "JANM-7820234"

  - `results.sales_invoice_details.foreign_recipient_nationality` (string,null)
    A nacionalidade do indivíduo estrangeiro.
    Example: "Peru"

  - `results.summary_invoice_details` (object)
    Detalhes sobre o resumo das faturas BOLETA_ELECTRONICA ou COMPROBANTE_PAGO.

  - `results.summary_invoice_details.month` (string)
    O ano e o mês das faturas, no formato YYYY-MM.
    Example: "2024-08"

  - `results.summary_invoice_details.updated_at` (string)
    O carimbo de data e hora ISO-8601 de quando a lista de faturas foi atualizada pela última vez.
    Example: "2024-09-02T15:23:47-03:00"

  - `results.summary_invoice_details.total_documents` (integer)
    O número total de faturas no resumo.
    Example: 23

  - `results.summary_invoice_details.tax_exempt_amount` (number)
    O valor total da fatura (de todas as faturas no resumo) que está isento de IVA.
    Example: 4000.02

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