---
# System prepended metadata

title: Payload JSON da rota /gerar

---

# Payload JSON da rota /gerar

Dados enviandos no verbo POST

| Payload antigo |
| -------------- |
```javascript
let payload = {
  "arq" : "teste", // Nome do arquivo
  "extensao" : "TST", // extensão do arquivo
  "numero_inscricao": "56564165000140", // Número de inscrição, cnpj ou cpf
  "empresa": "Testes inc.", // Nome da empresa
  "empresa_logradouro": "Rua do Limão", // Logradouro da empresa
  "empresa_numero": "412",
  "empresa_complemento": "4º andar",
  "empresa_cidade": "Caruaru", 
  "empresa_cep": "55014410", 
  "empresa_estado": "PE",
  "agencia": "Banco do Brasil", // Agência da conta da empresa
  "dv_agencia": "11", //  dígito da agência
  "conta": "42208922", // Conta corrente
  "dv_conta": "3", // dígito da conta
  "dv_ag_conta": "3", // digito da agência, obter com seu banco
  "numero_banco": "001", // número do banco, 001 Banco do Brasil
  "nome_banco": "Banco do Brasil",
  "cod_convenio_banco": "9999999990014CCVVV", 
  "num_versao_layout_arquivo": "002", // Campo não criticado pelo banco
  "tipo_servico": "20", // tipos válidos 20, 30 e 98
  "forma_lancamento": "41", // formas válidas 01, 03, 05, 41 e 43
  "cod_banco_favorecido": "237",
  "fav_agencia": "13", // fav_* dados do favorecido
  "fav_dv_agencia": "1",
  "fav_conta": "123456789",
  "fav_dv_conta": "2",
  "favorecido": "João",
  "tipo_favorecido": "1", // tipos 1=cpf e 2=cnpj
  "insc_fav": 123456,
  "fav_logradouro": "Rua Márcio Colves",
  "fav_num": "24",
  "fav_complemento": "De frente ao Ramás",
  "fav_bairro": "Assunção",
  "fav_cidade": "Caruaru",
  "fav_cep": "55022220",
  "fav_estado": "PE",
  "numero_documento_empresa": "1", // numero do documento, atribuído pela empresa ou emissor
  "data_vencimento": "01012020", // nesse formato, sem barras: ex 23/02/2012 23022020 (é como tá no controller)
  "valor_lancamento": 5000.75, // Um float, com no máximo 2 casas decimais
  "camara_compensacao": "700" // tipos válidos 700 (DOC) ou 018 (TED)
}
```

| Payload novo com múltiplos destinatários (favorecidos) |
| ------------------------------------------------------ |
```javascript
let payload = {
  "arq" : "teste", // os comentários do payload antigo valem neste
  "extensao" : "TST",
  "numero_inscricao": "56564165000140",
  "empresa": "Testes inc.",
  "empresa_logradouro": "Rua do Limão",
  "empresa_numero": "412",
  "empresa_complemento": "4º andar",
  "empresa_cidade": "Caruaru",
  "empresa_cep": "55014410",
  "empresa_estado": "PE",
  "agencia": "Banco do Brasil",
  "dv_agencia": "11",
  "conta": "42208922",
  "dv_conta": "3",
  "numero_banco": "001",
  "nome_banco": "Banco do Brasil",
  "cod_convenio_banco": "9999999990014CCVVV",
  "num_versao_layout_arquivo": "002",
  "tipo_servico": "20",
  "forma_lancamento": "41",

  "favorecidos": [
    {
      "cod_banco_favorecido": "237",
      "fav_agencia": "13",
      "fav_dv_agencia": "1",
      "fav_conta": "123456789",
      "fav_dv_conta": "2",
      "favorecido": "Jilombo",
      "tipo_favorecido": "1",
      "insc_fav": 123456,
      "fav_logradouro": "Rua Márcio Colves",
      "fav_num": "24",
      "fav_complemento": "De frente ao Ramás",
      "fav_bairro": "Assunção",
      "fav_cidade": "Caruaru",
      "fav_cep": "55022220",
      "fav_estado": "PE",
      "numero_documento_empresa": "1",
      "data_vencimento": "01012020",
      "valor_lancamento": 5000.75,
      "camara_compensacao": "700",
      "dv_ag_conta": "2"
    },
    {
      "cod_banco_favorecido": "01",
      "fav_agencia": "41",
      "fav_dv_agencia": "1",
      "fav_conta": "123456789",
      "fav_dv_conta": "2",
      "favorecido": "Birunda",
      "tipo_favorecido": "2",
      "insc_fav": 123456,
      "fav_logradouro": "Rua Goiás",
      "fav_num": "24",
      "fav_complemento": "Atrás da UPA",
      "fav_bairro": "Salgado",
      "fav_cidade": "Caruaru",
      "fav_cep": "55020800",
      "fav_estado": "PE",
      "numero_documento_empresa": "1",
      "data_vencimento": "01012020",
      "valor_lancamento": 125.13,
      "camara_compensacao": "018",
      "dv_ag_conta": "2"
    }
  ]
};
```

A rota gerar é protegida por usuário e senha. Por enquanto, a senha e usuário são estáticos, definidos no arquivo .env em APIUSER e APIPASS.

O cliente deverá enviar um header de autenticação de http básico no header: ```Authorization: Basic dGVzdGU6dGVzdGU= ```

#### Exemplo de retorno a chamada de /gerar

```json
  {
    "msg": "Arquivo gerado com sucesso!",
    "arquivo": "http://192.168.0.106:8080/remessa/teste-28112019125148.TST",
    "arquivo_nome": "teste-28112019125148.TST"
}

```

## Rota /remessa

Esta rota só aceita um GET.

Toma como parâmetro o nome do arquivo de remessa, por exemplo teste-12345.REM

``` http://cnab.com/api/remessa/teste-12345.REM ```

Retorna o arquivo de remessa.