# Listar folhas

> ## Método POST
>
> [http://api.milksrota.com.br/pay/folha/l](http://api.milksrota.com.br/pay/folha/readFolha)istFolha

## Requisição

### Dados da requisição

```javascript
{
    "token" : "XXXX-XXXX-XXXX-XXXX", 
    "conta_id" : "DDDDDD",
    "dt_inicio" : "2024-09-01",
    "dt_fim" : "2024-10-31",    
    "doc" : "99.999.999/9999-99"
}
```

{% hint style="info" %}
**token**: Deve ser informado o Token da conta, que você encontra na tela ***"Sua conta"*** no menu principal no painel do Milk's Rota.

**conta\_id**: Deve ser informado o ID da conta que você encontra na tela ***"Sua conta"*** no menu principal no painel do Milk's Rota.

**dt\_inicio**: Data inicial utilizada para localizar folhas num determinado período.

**dt\_fim**: Data final utilizada para localizar folhas num determinado período.

**doc:** Deve ser informado o CNPJ da conta cadastra. Pode ser encontrado na tela ***"Sua conta"*** no menu principal do painel Milk's Rota.
{% endhint %}

## Resposta

### 200: Registros localizados

### Exemplo de resposta

```json
{
    "success": true,
    "data": [
        {
            "id": "137", //ID de identificação da folha
            "conta_id": "40001",
            "consolidacao_id": "242",
            "referencia": "Jun/24-3", // Referência do pagamento
            "codigo": null,
            "status": "F", // Status da folha (A = Aberta, F = Fechada)
            "dt_inicio_fornecimento": "2024-06-01", // Início do período de fornecimento de leite
            "dt_fim_fornecimento": "2024-06-30", // Fim do período de fornecimento de leite
            "volume": "29600", // Volume total de leite na folha
            "total_pagamento": "66922.11", // Valor líquido total
            "total_credito": "0.00", // Total de créditos adicionais
            "total_deducao": "0.00", // Total de deduções adicionais
            "total_fornecimento": "67920.54", // Valor bruto da folha
            "dt_criacao": "2024-07-04 15:42:00", // Data e hora de criação do registro
            "dt_exclusao": null,
            "dt_atualizacao": "2024-09-18 12:11:35",
            "total_imposto": "998.43", // Valor total de impostos na folha
            "preco_medio": "2.295", // Valor do preço médio do leite na folha
            "forcar_recalculo": "0",
            "simulacao": "0",
            "tipo_data_corte": "C"
        },
        {
            "id": "136",
            "conta_id": "40001",
            "consolidacao_id": "242",
            "referencia": "Jun/24 - 2",
            "codigo": "Jun/2024-2",
            "status": "F",
            "dt_inicio_fornecimento": "2024-06-01",
            "dt_fim_fornecimento": "2024-06-30",
            "volume": "29600",
            "total_pagamento": "67907.11",
            "total_credito": "1000.00",
            "total_deducao": "0.00",
            "total_fornecimento": "68920.54",
            "dt_criacao": "2024-07-04 12:05:02",
            "dt_exclusao": null,
            "dt_atualizacao": "2024-07-04 15:39:10",
            "total_imposto": "1013.43",
            "preco_medio": "2.328",
            "forcar_recalculo": "0",
            "simulacao": "0",
            "tipo_data_corte": "C"
        },
        {
            "id": "134",
            "conta_id": "40001",
            "consolidacao_id": "242",
            "referencia": "Jun/24",
            "codigo": null,
            "status": "F",
            "dt_inicio_fornecimento": "2024-06-01",
            "dt_fim_fornecimento": "2024-06-30",
            "volume": "29600",
            "total_pagamento": "67673.74",
            "total_credito": "0.00",
            "total_deducao": "450.00",
            "total_fornecimento": "69140.10",
            "dt_criacao": "2024-07-04 11:40:46",
            "dt_exclusao": null,
            "dt_atualizacao": "2024-07-04 12:00:50",
            "total_imposto": "1016.36",
            "preco_medio": "2.336",
            "forcar_recalculo": "0",
            "simulacao": "0",
            "tipo_data_corte": "C"
        },
        {
            "id": "126",
            "conta_id": "40001",
            "consolidacao_id": "232",
            "referencia": "05/2024",
            "codigo": "05/2024",
            "status": "F",
            "dt_inicio_fornecimento": "2024-05-01",
            "dt_fim_fornecimento": "2024-05-31",
            "volume": "8081",
            "total_pagamento": "19427.79",
            "total_credito": "0.00",
            "total_deducao": "0.00",
            "total_fornecimento": "19717.64",
            "dt_criacao": "2024-06-04 16:50:40",
            "dt_exclusao": null,
            "dt_atualizacao": "2024-06-04 16:52:42",
            "total_imposto": "289.85",
            "preco_medio": "2.440",
            "forcar_recalculo": "0",
            "simulacao": "0",
            "tipo_data_corte": "C"
        }
    ],
    "response.time": 0.13026404380798,
    "server.date": "2024-10-25 14:40:10"
}
```

{% hint style="success" %}
Os registros da folha foram recuperados na plataforma Milk's e retornados com sucesso.
{% endhint %}

### 400: Conta não localizada

```javascript
{    
    "success": false,
    "message": "Conta não localizada",
    "data": [],
    "monitor.time": 2.14737200737 // Tempo de execução
}
```

{% hint style="danger" %}
**O que isso significa?** Significa que o ID da conta não foi localizado na Plataforma Milk's.
{% endhint %}

### 403: Token inválido

```javascript
{
    "success": false,
    "message": "Token inválido",
    "data": [],
    "monitor.time": 2.14737200737 // Tempo de execução
}
```

{% hint style="danger" %}
**O que isso significa?** Significa que o token informado na requisição não corresponde ao token cadastrado para a conta.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.milksrota.com.br/milks-pay/folha/enviar-categorias.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.