> For the complete documentation index, see [llms.txt](https://docs.milksrota.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.milksrota.com.br/milks-pay/folha/enviar-categorias-1.md).

# Baixar folha

> ## Método POST
>
> <http://api.milksrota.com.br/pay/folha/readFolha>

## Requisição

### Dados da requisição

```javascript
{
    "token" : "XXXX-XXXX-XXXX-XXXX", 
    "conta_id" : "DDDDDD",
    "folha_id" : "111",
    "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.

**folha\_id**: Deve ser informado o ID de Identificação da folha de pagamento, que pode ser visto em destaque ao **editar um registro da folha de pagamento**.

**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 requisição

```javascript
"success": true,
    "data": {
        "folha": "111", // ID da folha de pagamento
        "volume_total": "3308050", // Volume de leite total na folha
        "total_bruto": "9710408.26", // Total bruto da folha
        "total_liquido": "9203256.03", // Total líquido da folha
        "pagamentos": [
            {
                "codigo_produtor": "22222", // Código do produtor no ERP
                "nome_produtor": "JOSÉ SILVA SANTOS", // Nome do produtor
                "rota": "VIA LAT SEGURO NOVO", // Nome da rota de captação
                "linha": "ROTA 05 - MARIA FONSECA SOARES DE BAIXO", // Nome da linha de captação
                "modelo_pagamento": "95% Assunção", // Modelo de pagamento
                "volume_total_leite": "8067", // Volume total de leite fornecido
                "volume_medio_diario": "260.23", // Volume médio diário de leite fornecido no período da folha
                "total_bruto": "22773.14", // Valor total bruto
                "total_debitos": "108.00", // Total de débitos da folha (adicionais)
                "total_acrescimos": "0.00", // Total de créditos da folha (adicionais)
                "total_impostos": "341.60", // Total de impostos da folha
                "total_liquido": "22323.54", // Valor total líquido
                "preco_medio_leite": "2.823", // Preço médio do litro de leite
                "creditos": [], // Lista de créditos adicionais da folha
                "debitos": [ // Lista de débitos adicionais da folha
                    {
                        "descricao": "Ref.NF 1 WELKYER",
                        "valor": "100.000"
                    },
                    {
                        "descricao": "Ref.NF 7 CLINICA DO LEITE",
                        "valor": "8.000"
                    }
                ],
                "impostos": [ // Lista de impostos incidindo sobre a folha
                    {
                        "codigo": "01",
                        "descricao": "FUNRURAL",
                        "valor": "273.278",
                        "percentual": "1.2000"
                    },
                    {
                        "codigo": "02",
                        "descricao": "SENAR",
                        "valor": "45.546",
                        "percentual": "0.2000"
                    },
                    {
                        "codigo": "03",
                        "descricao": "SAT",
                        "valor": "22.773",
                        "percentual": "0.1000"
                    }
                ],
                "composicao": [ // Composição do pagamento da folha para NFe
                    {
                        "codigo": null,
                        "descricao": "Preço Base",
                        "quantidade": "8067.0000",
                        "valor_unitario": "2.6480",
                        "credito": "21361.416",
                        "debito": 0
                    },
                    {
                        "codigo": null,
                        "descricao": "Adicional Volume",
                        "quantidade": "8067.0000",
                        "valor_unitario": "0.0300",
                        "credito": "242.010",
                        "debito": 0
                    },
                    {
                        "codigo": null,
                        "descricao": "Qualidade CBT",
                        "quantidade": "14.1230",
                        "valor_unitario": "0.0500",
                        "credito": "403.350",
                        "debito": 0
                    },
                    {
                        "codigo": null,
                        "descricao": "Qualidade CCS",
                        "quantidade": "1240.3970",
                        "valor_unitario": "-0.0700",
                        "credito": "-564.690",
                        "debito": 0
                    },
                    {
                        "codigo": null,
                        "descricao": "Qualidade Gordura",
                        "quantidade": "3.9230",
                        "valor_unitario": "0.0850",
                        "credito": "685.695",
                        "debito": 0
                    },
                    {
                        "codigo": null,
                        "descricao": "Qualidade Proteína",
                        "quantidade": "3.1580",
                        "valor_unitario": "0.0100",
                        "credito": "80.670",
                        "debito": 0
                    },
                    {
                        "codigo": null,
                        "descricao": "Certificações: Produção",
                        "quantidade": "0.0000",
                        "valor_unitario": "0.0200",
                        "credito": "161.340",
                        "debito": 0
                    },
                    {
                        "codigo": null,
                        "descricao": "Certificações: Bem Estar Animal",
                        "quantidade": "0.0000",
                        "valor_unitario": "0.0200",
                        "credito": "161.340",
                        "debito": 0
                    },
                    {
                        "codigo": null,
                        "descricao": "Adicional comercial",
                        "quantidade": "0.0000",
                        "valor_unitario": "0.0300",
                        "credito": "242.010",
                        "debito": 0
                    }
                ]
            },
```

{% 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
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
