# Lista os documentos fiscais eletrônicos recebidos

Retorna uma lista paginada de documentos fiscais eletrônicos recebidos, com filtros opcionais por data, busca, ordenação e paginação.

Endpoint: GET /api/v3/nfes/received-documents
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Query parameters:

  - `date_start` (string)
    Data inicial para filtrar os documentos (data de emissão).
    Example: "2000-01-01"

  - `date_end` (string)
    Data final para filtrar os documentos (data de emissão).
    Example: "2025-12-31"

  - `search` (string)
    Termo de busca para filtrar documentos (número, razão social, CNPJ do remetente).
    Example: "9001"

  - `was_imported` (integer)
    Filtra pelo status de importação.

- 1: Lista apenas os documentos importados
- 0: Lista apenas os documentos não importados

Se não enviar, lista todos os documentos.
    Example: 1

  - `min_value` (number)
    Filtro pelo valor mínimo do documento.
    Example: 100

  - `max_value` (number)
    Filtro pelo valor máximo do documento.
    Example: 1000

  - `order_by_field` (string)
    Campo para ordenação dos documentos.
Exemplo:
  - number Número do documento
  - emitted_at Data de emissão
    Enum: "emitted_at", "number", "serie", "model", "value", "emitter", "status", "imported", "created_at"

  - `order_by_type` (string)
    Tipo de ordenação.
Exemplo:
  - asc Ascendente
  - desc Descendente
    Enum: "asc", "desc"

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.documents` (array)
    Lista de documentos fiscais eletrônicos recebidos

  - `data.documents.id` (integer, required)
    ID único do documento
    Example: 933

  - `data.documents.key` (string, required)
    Chave de acesso do documento fiscal
    Example: "12345678901234567890123456789012345678901234"

  - `data.documents.emitted_at` (string, required)
    Data de emissão do documento
    Example: "2024-08-11"

  - `data.documents.number` (string, required)
    Número do documento fiscal
    Example: "12345"

  - `data.documents.serie` (string, required)
    Série do documento fiscal
    Example: "144"

  - `data.documents.model` (integer, required)
    Modelo do documento fiscal
    Example: 55

  - `data.documents.value` (object, required)
    Preço do produto

  - `data.documents.value.amount` (number, required)
    Valor expresso como um número decimal das principais unidades monetárias
    Example: 99.95

  - `data.documents.value.currency` (string, required)
    Código de moeda de 3 letras conforme definido pela ISO-4217
    Example: "BRL"

  - `data.documents.sender` (object, required)
    Dados do remetente/emitente

  - `data.documents.sender.name` (string, required)
    Razão social do remetente
    Example: "Fornecedor Teste Ltda"

  - `data.documents.sender.cnpj` (string, required)
    CNPJ do remetente
    Example: "12345678000190"

  - `data.documents.status` (string, required)
    Status do documento
    Enum: "Pending", "Transmitted", "Canceled"

  - `data.documents.origem` (string)
    Origem do documento
    Enum: "Auto", "Manual"

  - `data.documents.is_import` (boolean, required)
    Indica se o documento foi importado

  - `data.documents.is_auto` (boolean, required)
    Indica se é processamento automático
    Example: true

  - `data.documents.download` (string, required)
    URL para download do documento
    Example: "http://erp.connectplug.com.br/file/eyJpdiI6ImlWVWQ2MlI4K29WdHFabzBlNHNRYXc9PSIsInZhbHVlIjoiVk1LMWdzZGlpL1ZkT25BcTdBTEIwZz09IiwibWFjIjoiYTI4MDFmNDI3ZGY1NjNjNzM2NjA1YjNhMWQxYmJkYjRiNTVjYTkyYjZjYzliZTA1N2Q2YjU1NjRiZThiN2Y4ZiIsInRhZyI6IiJ9/download"

  - `data.documents.download_xml_canceled` (string)
    URL para download do XML de cancelamento
    Example: "http://erp.connectplug.com.br/file/eyJpdiI6IlJ2Tkh0YnM5N1JTYXBGOVhRNmRoNUE9PSIsInZhbHVlIjoiVG9oYVdwVzBZemJoY3cyQWpNU2ZPUT09IiwibWFjIjoiY2U1YzgzYTk3MmFhZDNiOWM3NmI5NDY5NWUwNTY0NThjMzFhZGVlOGJjMTY2NjQyOGZlOTRlYzg4NTg0OTczZCIsInRhZyI6IiJ9/download"

  - `data.documents.print` (string, required)
    URL para impressão do documento
    Example: "http://erp.connectplug.com.br/sistema/facilita-nfe/print/933"

  - `meta` (object, required)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields