Documentação para Desenvolvedores

Importações de Boletos

Recurso Descrição
POST /api/v1/imports/bank_billets Importar boletos
GET /api/v1/imports/bank_billets/:id Informações da importação
GET /api/v1/imports/bank_billets Listar importações

Modelo de Dados

Parâmetro Obrigatório Tipo Tamanho Descrição
id N/A Integer   ID da importação
source Sim     Arquivo
source_type Não String   Tipo do arquivo (possíveis valores)
processed_rows N/A Integer   Número de boletos processados
created_rows N/A Integer   Número de boletos criados
updated_rows N/A Integer   Número de boletos alterados
enqueued_at N/A Time   Data/hora de enfileiramento
started_at N/A Time   Data/hora do início do processo de importação
finished_at N/A Time   Data/hora do término do processo de importação
import_errors N/A Array   Erros de importação, caso existam
source_file_name N/A String   Nome do arquivo
source_file_size N/A Integer   Tamanho em bytes do arquivo
status N/A String   Situação do arquivo (possíveis valores)
created_via_api N/A Boolean   Enviado pela API

Dicionário de Dados

source_type

csv CSV (default)
rem Remessa

status

enqueued Aguardando processamento
aborted Processamento não realizado devido a erro
done Processamento concluído

Importar boleto

POST /api/v1/imports/bank_billets

Exemplo de requisição inválida

Requisição:
curl -i \
-u $BOLETOSIMPLES_TOKEN:x \
-H 'Content-Type: multipart/form-data' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-X POST 'https://sandbox.boletosimples.com.br/api/v1/imports/bank_billets'
Resposta:
HTTP/1.1 422 Unprocessable Entity
Server: Cowboy
Connection: keep-alive
Strict-Transport-Security: max-age=2592000
Content-Type: application/json; charset=utf-8
...

{"errors":{"bank_billet_import":["não pode ficar em branco"]}}

Exemplo de requisição válida

Requisição:
curl -i \
-u $BOLETOSIMPLES_TOKEN:x \
-H 'Content-Type: multipart/form-data' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-F "bank_billet_import[source]=@boletos.csv" \
-X POST 'https://sandbox.boletosimples.com.br/api/v1/imports/bank_billets'
Resposta:
HTTP/1.1 201 Created
Server: Cowboy
Connection: keep-alive
Strict-Transport-Security: max-age=2592000
Location: https://sandbox.boletosimples.com.br/api/v1/discharges/1
Content-Type: application/json; charset=utf-8
...

{
  "id":1,
  "processed_rows":10,
  "created_rows":10,
  "updated_rows":0,
  "total_rows":10,
  "failed_to_create_rows":0,
  "failed_to_update_rows":0,
  "enqueued_at":"2018-03-19T15:23:10-03:00",
  "started_at":"2018-03-19T15:23:13-03:00",
  "finished_at":"2018-03-19T15:23:16-03:00",
  "import_errors":[],
  "source_content_type":"text/plain",
  "source_file_name":"boletos.csv",
  "source_file_size":10401,
  "created_via_api":true,
  "status":"enqueued"
}

Informações da importação

GET /api/v1/imports/bank_billets/:id

Exemplo

Requisição:
curl -i \
-u $BOLETOSIMPLES_TOKEN:x \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-X GET 'https://sandbox.boletosimples.com.br/api/v1/imports/bank_billets/1'
Resposta:
HTTP/1.1 200 OK
Server: Cowboy
Connection: keep-alive
Strict-Transport-Security: max-age=2592000
Content-Type: application/json; charset=utf-8
...

{
  "id":1,
  "processed_rows":10,
  "created_rows":10,
  "updated_rows":0,
  "total_rows":10,
  "failed_to_create_rows":0,
  "failed_to_update_rows":0,
  "enqueued_at":"2018-03-19T15:23:10-03:00",
  "started_at":"2018-03-19T15:23:13-03:00",
  "finished_at":"2018-03-19T15:23:16-03:00",
  "import_errors":[],
  "source_content_type":"text/plain",
  "source_file_name":"boletos.csv",
  "source_file_size":10401,
  "created_via_api":true,
  "status":"done"
}

Listar importações

GET /api/v1/imports/bank_billets

Parâmetro Obrigatório Tipo Descrição
page Não Number Número da Página
per_page Não Number Quantidade de registros por página (Maximo de 250)

Exemplo

Requisição:
curl -i \
-u $BOLETOSIMPLES_TOKEN:x \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-X GET "https://sandbox.boletosimples.com.br/api/v1/imports/bank_billets?page=1&per_page=50"
Resposta:
HTTP/1.1 200 OK
Server: Cowboy
Connection: keep-alive
Strict-Transport-Security: max-age=2592000
Total: 1
Content-Type: application/json; charset=utf-8
...

[
  {
    "id":1,
    "processed_rows":10,
    "created_rows":10,
    "updated_rows":0,
    "total_rows":10,
    "failed_to_create_rows":0,
    "failed_to_update_rows":0,
    "enqueued_at":"2018-03-19T15:23:10-03:00",
    "started_at":"2018-03-19T15:23:13-03:00",
    "finished_at":"2018-03-19T15:23:16-03:00",
    "import_errors":[],
    "source_content_type":"text/plain",
    "source_file_name":"boletos.csv",
    "source_file_size":10401,
    "created_via_api":true,
    "status":"done"
  }
]