# Listar vendas de um fechamento de caixa

Lista todas as vendas de um fechamento de caixa.

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

## Path parameters:

  - `drawerListId` (integer, required)
    ID do fechamento de caixa.

Para encontrar o ID do fechamento de caixa, você pode usar o endpoint GET /pos/drawer-list.
    Example: 1

## Query parameters:

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

  - `data.total` (object)

  - `data.total.values_canceled` (object)
    Valor total das vendas canceladas.

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

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

  - `data.total.values_sales` (object)
    Valor total das vendas. Incluindo as vendas canceladas.

  - `data.sales_info` (object)

  - `data.sales_info.sales_info_contents` (array)
    Representa a lista das vendas do fechamento de caixa de acordo com o filtro.

  - `data.sales_info.sales_info_contents.sale_id` (integer)
    Identificador único da venda.
    Example: 1

  - `data.sales_info.sales_info_contents.customer` (object)
    Dados do cliente.

  - `data.sales_info.sales_info_contents.customer.id` (integer)
    Identificador único do cliente.
    Example: 1

  - `data.sales_info.sales_info_contents.customer.name` (string)
    Nome do cliente ou nome fantasia da pessoa jurídica.
    Example: "Cliente 1"

  - `data.sales_info.sales_info_contents.start_datetime` (string)
    Data de início da venda.
    Example: "2025-08-06T17:04:55.000000Z"

  - `data.sales_info.sales_info_contents.end_datetime` (string)
    Data de fim da venda.
    Example: "2025-08-06T17:04:55.000000Z"

  - `data.sales_info.sales_info_contents.total_value` (object)
    Valor total da venda.
    Example: 100

  - `data.sales_info.sales_info_contents.payment_methods` (array)
    Lista de métodos de pagamento.

  - `data.sales_info.sales_info_contents.payment_methods.id` (integer)
    Identificador único do método de pagamento.
    Example: 1

  - `data.sales_info.sales_info_contents.payment_methods.name` (string)
    Nome do método de pagamento.
    Example: "Dinheiro"

  - `data.sales_info.sales_info_contents.is_canceled` (boolean)
    Indica se a venda foi cancelada.

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

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

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

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

  - `data.sales_info.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