# Listar fechamentos de caixa

Lista todos os fechamentos de caixa do PDV.

Endpoint: GET /api/v3/pos/drawer-list
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:

  - `pos_id` (integer, required)
    ID do PDV.
    Example: 1

  - `seller_id` (integer)
    ID do vendedor.
    Example: 1

  - `user_id` (integer)
    ID do usuário operador.
    Example: 1

  - `start_date` (string)
    Data de início do abertura de caixa.
    Example: "2025-01-01"

  - `end_date` (string)
    Data de fim do abertura de caixa.
    Example: "2025-01-31"

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

## Response 200 fields (application/json):

  - `data` (object)

  - `data.drawers` (array)
    Representa a lista dos fechamentos de caixa.

  - `data.drawers.id` (integer)
    Identificador único do status do pdv.
    Example: 1

  - `data.drawers.pos` (object)
    Dados do PDV.

  - `data.drawers.pos.id` (integer)
    Identificador único do pdv.
    Example: 1

  - `data.drawers.pos.name` (string)
    Nome do PDV.
    Example: "PDV 1"

  - `data.drawers.seller` (object)
    Dados do vendedor.

  - `data.drawers.seller.id` (integer)
    Identificador único do vendedor.
    Example: 1

  - `data.drawers.seller.name` (string)
    Nome do vendedor.
    Example: "Vendedor 1"

  - `data.drawers.user` (object)
    Dados do usuário operador.

  - `data.drawers.user.id` (integer)
    Identificador único do usuário operador.
    Example: 1

  - `data.drawers.user.name` (string)
    Nome do usuário operador.
    Example: "Usuário Operador 1"

  - `data.drawers.open_info` (object)
    Dados da abertura de caixa.

  - `data.drawers.open_info.open_value` (object)
    Valor de abertura.

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

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

  - `data.drawers.open_info.open_datetime` (string)
    Data de abertura do caixa
    Example: "2025-01-01 00:00:00"

  - `data.drawers.close_info` (object)
    Dados do fechamento de caixa.

  - `data.drawers.close_info.close_value` (object)
    Valor de fechamento.

  - `data.drawers.close_info.close_datetime` (string)
    Data de fechamento do caixa
    Example: "2025-01-01 00:00:00"

  - `data.drawers.close_info.close_value_declared` (object)
    Valor total de fechamento declarado.

  - `data.drawers.close_info.close_value_declared_cred_card` (object)
    Valor de fechamento declarado com cartão de crédito.

  - `data.drawers.close_info.close_value_declared_debit_card` (object)
    Valor de fechamento declarado com cartão de débito.

  - `data.drawers.close_info.close_value_declared_voucher` (object)
    Valor de fechamento declarado com cupons.

  - `data.drawers.close_info.close_value_declared_others` (object)
    Valor de fechamento declarado com outras formas de pagamento.

  - `data.drawers.qty_sales` (integer)
    Quantidade de vendas.
    Example: 1

  - `data.drawers.created_at` (string)
    Data de criação do fechamento de caixa.
    Example: "2025-01-01 00:00:00"

  - `data.drawers.updated_at` (string)
    Data de atualização do fechamento de caixa.
    Example: "2025-01-01 00:00: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