# Lista os XMLs de entrada

Retorna uma lista de XMLs de entrada.

Endpoint: GET /api/v3/purchase-invoices
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:

  - `search_term` (string)
    Filtra pelo número da nota ou razão social ou cnpj.
    Example: "CPlug Supplier Chain"

  - `status` (string)
    Filtra pelo status do XML.
Exemplo:
  - all Todos os status;
  - imported Somente os importados;
  - not_imported Somente os não importados.
    Enum: "all", "imported", "not_imported"

  - `source` (string)
    Filtra pela origem do XML.
Exemplo:
 - all Todas as origens;
 - automated Facilita NFe;
 - manual Importação de XML.
    Enum: "all", "automated", "manual"

  - `import_date_start` (string)
    data inicial da importação.
    Example: "2025-01-21"

  - `import_date_end` (string)
    data final da importação.
    Example: "2025-01-31"

  - `issue_date_start` (string)
    data inicial da emissão.
    Example: "2025-01-10"

  - `issue_date_end` (string)
    data final da emissão.
    Example: "2025-01-31"

  - `issuer_company_name` (string)
    Filtra pela razão social.
    Example: "CPlug Supplier Chain LTDA"

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

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

  - `updated_from` (string)
    Filtra por dados que foram atualizadas a partir de uma data. (Formato: YYYY-MM-DDThh:mm:ss+hh:mm).

  - `deleted` (string)
    Filtro para indicar se deve retornar dados apagados ou não.
    Enum: "not_include", "include", "only"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.purchase-invoices` (array)
    Representa a lista de xmls

  - `data.purchase-invoices.id` (integer)
    Identificador único do arquivo xml de entrada.
    Example: 1

  - `data.purchase-invoices.serie` (string)
    Número de séria da nota fiscal de entrada.
    Example: "001"

  - `data.purchase-invoices.number` (string)
    Número da nota fiscal de entrada.
    Example: "2340003"

  - `data.purchase-invoices.company_name` (string)
    Razão social do fornecedor.
    Example: "CPlug Supplier Chain LTDA"

  - `data.purchase-invoices.document` (string)
    CNPJ do fornecedor.
    Example: "22423374000152"

  - `data.purchase-invoices.value` (object)
    Valor total da nota fiscal.

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

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

  - `data.purchase-invoices.issue_date` (string)
    Data de emissão da nota.
    Example: "2025-01-10"

  - `data.purchase-invoices.imported_date` (string)
    Data da importação.
    Example: "2025-01-21"

  - `data.purchase-invoices.source` (string)
    Origem.
    Example: "Importação de XML"

  - `data.purchase-invoices.status` (string)
    Status da importação.

- imported Somente os importados;
- not_imported Somente os não importados.
    Enum: "imported", "not_imported"

  - `data.purchase-invoices.url` (string)
    URL do arquivo xml.
    Example: "https://erp.connectplug.com.br/file/eyJ..."

  - `data.purchase-invoices.is_deleted` (boolean)
    Indica se a nota foi apagado ou não.

  - `data.purchase-invoices.created_at` (string)
    Data da criação do estoque.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.purchase-invoices.updated_at` (string)
    Data da atualização do estoque.
    Example: "2020-01-01T09:00:00-03:00"

  - `meta` (object)
    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