> 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-farmer/convios/enviar-convenios.md).

# Enviar convênios

> ## Método POST
>
> <http://api.milksrota.com.br/farmer/retaguarda/writeConvenio>

## Requisição

### Dados da requisição

```javascript
{
    "conta_id": "DDDDD",
    "token": "XXXX-XXXX-XXXX-XXXX",
    "doc": "99.999.999/9999-99",
    "data": [
        // lista de registros de convenios
    ]
}
```

{% hint style="info" %}
**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.

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

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

**data**: Lista que deve conter um ou mais registros de categorias de produtos. Cada registro de categoria pode ser informando com a relação de propriedades detalhadas abaixo. Apenas os campos obrigatórios não podem ser ignorados.
{% endhint %}

### Propriedades do convênio

| **Campo**       | **Descrição**                                                                                                                                                   | **Tipo** | **Obrigatório** |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------- |
| **codigo \***   | Código do convênio                                                                                                                                              | Texto    | SIM             |
| **convenio \*** | Nome de identificação do convênio                                                                                                                               | Texto    | SIM             |
| **tipo \***     | Tipo de pessoa (F) - Física; (J) - Jurídica.                                                                                                                    | Texto    | SIM             |
| **doc \***      | Documento de identificação do produtor (CPF ou CNPJ)                                                                                                            | Texto    | SIM             |
| numero          | Número do endereço do conveniado                                                                                                                                | Texto    | Não             |
| logradouro      | Logradouro do endereço do conveniado                                                                                                                            | Texto    | Não             |
| bairro          | Bairro do endereço do conveniado                                                                                                                                | Texto    | Não             |
| cidade          | Cidade do endereço do conveniado                                                                                                                                | Texto    | Não             |
| uf              | Unidade federativa do endereço do conveniado                                                                                                                    | Texto    | Não             |
| cep             | CEP do endereço do conveniado                                                                                                                                   | Texto    | Não             |
| email           | Endereço de e-mail do produtor                                                                                                                                  | Texto    | Não             |
| telefone        | Número do telefone celular do produtor                                                                                                                          | Texto    | Não             |
| **deleted**     | Se o registro deve ser excluído. Se enviar o valor **1** ele será excluído caso já exista na plataforma. Se for enviado **0** ele será reativado na plataforma. | Número   | SIM             |

### Exemplo de requisição

```javascript
{
    "conta_id": "DDDDD",
    "token": "xxxx-xxxx-xxxx-xxxx",
    "doc": "99.99.999/9999-99",
    "data": [
         {
            "codigo": "001",
            "nome": "João das Couves",
            "tipo": "F",
            "deleted": 0, // ativa o registro
            "doc": "090.123.231-20",
            "numero": "123",
            "logradouro": "Rua das Canárias",
            "bairro": "Laranjeiras",
            "cidade": "Alagoana",
            "uf": "Minas Gerais",
            "cep": "31400-000",
            "email": "joao.couves@gmail.com",
            "telefone": "(37) 99912-4949"
            
        },
        {
            "codigo": "002",
            "nome": "Posto de combustível Juá",
            "tipo": "J",
            "deleted": 1, // desativa o registro         
            "doc": "10.290.123.0001/10",
            "numero": "98",
            "logradouro": "Rua D",
            "bairro": "Martins Godoy",
            "cidade": "Santa Bárbara",
            "uf": "Minas Gerais",
            "cep": "31560-000",
            "email": null,
            "telefone": "(37) 99912-4949"
        }        
    ]
}
```

## Resposta

### 200: Importação realizada

```javascript
{
  "succes": true,
    "message": "OK",
    "data": [],
    "monitor.time": 2.14737200737 // Tempo de execução
}  
```

{% hint style="success" %}
Os registros foram enviados para a Plataforma Milk's e importados sem erro.
{% endhint %}

### 200: Importação com falhas

```javascript
{
    "succes": true,
    "message": "OK",
    "data": [ // Falhas de importação
        {
            "codigo": "001", // Código do convenio não importado
            "mensagem": "Código já cadastrado em outro registro ", // mensagem de erro
        }
    ],
    "monitor.time": 2.14737200737 // Tempo de execução
}
```

{% hint style="info" %}
Os registros foram enviados para a Plataforma Milk's e importados, entretanto, alguns registros não puderam ser importados.
{% endhint %}

### 404: 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 %}