Extrato Bancário
Consulta o extrato de transações bancárias da empresa com suporte a filtros e paginação por cursor.
Regras:
startDateé obrigatório quandoendDateé informado e vice-versa.- O
limitdeve estar entre 1 e 50 itens por página (padrão: 20). - Use
nextPageStartKeypara navegar entre páginas (paginação por cursor). - Os filtros de valor (
amountEq,amountGt,amountLt) são mutuamente exclusivos.
curl -X GET "https://api-sandbox.contasimples.com/statements/v1/banking?accountId=123&startDate=2025-01-01&endDate=2025-01-31&limit=42&nextPageStartKey=example_string&sorting=transactionDate:DESC&hasAttachments=true&wasConciled=true&categoryIds=["example_string"]&costCenterIds=["example_string"]&responsibleEmail=user@example.com&status=[42]&amountEq=3.14&amountGt=3.14&amountLt=3.14" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api-sandbox.contasimples.com/statements/v1/banking?accountId=123&startDate=2025-01-01&endDate=2025-01-31&limit=42&nextPageStartKey=example_string&sorting=transactionDate:DESC&hasAttachments=true&wasConciled=true&categoryIds=["example_string"]&costCenterIds=["example_string"]&responsibleEmail=user@example.com&status=[42]&amountEq=3.14&amountGt=3.14&amountLt=3.14"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api-sandbox.contasimples.com/statements/v1/banking?accountId=123&startDate=2025-01-01&endDate=2025-01-31&limit=42&nextPageStartKey=example_string&sorting=transactionDate:DESC&hasAttachments=true&wasConciled=true&categoryIds=["example_string"]&costCenterIds=["example_string"]&responsibleEmail=user@example.com&status=[42]&amountEq=3.14&amountGt=3.14&amountLt=3.14", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api-sandbox.contasimples.com/statements/v1/banking?accountId=123&startDate=2025-01-01&endDate=2025-01-31&limit=42&nextPageStartKey=example_string&sorting=transactionDate:DESC&hasAttachments=true&wasConciled=true&categoryIds=["example_string"]&costCenterIds=["example_string"]&responsibleEmail=user@example.com&status=[42]&amountEq=3.14&amountGt=3.14&amountLt=3.14", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api-sandbox.contasimples.com/statements/v1/banking?accountId=123&startDate=2025-01-01&endDate=2025-01-31&limit=42&nextPageStartKey=example_string&sorting=transactionDate:DESC&hasAttachments=true&wasConciled=true&categoryIds=["example_string"]&costCenterIds=["example_string"]&responsibleEmail=user@example.com&status=[42]&amountEq=3.14&amountGt=3.14&amountLt=3.14')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"transactions": [
{
"id": 123,
"transactionType": {
"id": 123,
"description": "example_string",
"icon": "example_string",
"subType": "example_string"
},
"companyId": "example_string",
"status": 42,
"statusDescription": "example_string",
"accountId": 123,
"finalCardNumber": "example_string",
"bearerName": "John Doe",
"transactionDate": "2024-12-25T10:00:00Z",
"brlAmount": 3.14,
"usdAmount": 3.14,
"usdExchangeRate": 3.14,
"usdExchangeRateDate": "2024-12-25T10:00:00Z",
"totalTransactionAmount": 3.14,
"iofAmount": 3.14,
"feeServiceAmount": 3.14,
"mccCode": 42,
"mccGroup": 42,
"idPurchaseEvent": 123,
"mccDescription": "example_string",
"sourceDestinationName": "John Doe",
"placeEstablishment": "example_string",
"attachments": [
{
"id": "example_string",
"name": "comprovante.pdf",
"type": "image/jpeg",
"_links": {
"content": {
"href": "/attachments/v1/content/{id}",
"rel": "GET"
}
}
}
],
"conciliation": {
"description": "example_string",
"conciled": true
},
"showReceipt": true,
"description": "example_string",
"notes": "example_string",
"category": {
"id": "example_string",
"description": "example_string"
},
"costCenter": {
"id": "example_string",
"description": "example_string"
},
"user": {
"id": "example_string",
"email": "user@example.com"
},
"requesterUser": {
"id": "example_string",
"email": "user@example.com"
},
"customCategory": {
"id": 123,
"name": "John Doe"
}
}
],
"nextPageStartKey": "example_string"
}
{
"error": "Bad Request",
"message": "Um ou mais parâmetros da requisição são inválidos.",
"code": 400,
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"details": [
"O campo exemplo deve ter um valor entre 5 e 100.",
"datas devem estar no formato YYYY-MM-DD."
]
}
{
"error": "Unauthorized",
"message": "Token de acesso inválido ou expirado.",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"code": 401
}
{
"error": "Not Found",
"message": "O recurso solicitado não foi encontrado.",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"code": 404
}
{
"error": "Internal Server Error",
"message": "Ocorreu um erro inesperado ao processar a solicitação.",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"code": 500
}
/statements/v1/banking
Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
Bearer {token}ID da conta bancária. Quando não informado, retorna transações de todas as contas.
Data de início do período (formato YYYY-MM-DD). Obrigatório quando endDate é informado.
Data de fim do período (formato YYYY-MM-DD). Obrigatório quando startDate é informado.
Número máximo de transações por página. Mínimo: 1, Máximo: 50. Padrão: 20.
Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.
Campo e ordem de ordenação, ex: transactionDate:DESC.
Filtra transações que possuem ou não anexos.
Filtra transações pela situação de conciliação.
Lista de IDs de categorias para filtrar. Separe múltiplos valores por vírgula.
Lista de IDs de centros de custo para filtrar. Separe múltiplos valores por vírgula.
Filtra transações pelo e-mail do responsável.
Filtra pelo status da transação. Valores: 1 (CANCELADO), 2 (PROCESSADO), 3 (PENDENTE). Separe múltiplos valores por vírgula.
Filtra transações com valor exatamente igual ao informado.
Filtra transações com valor maior que o informado.
Filtra transações com valor menor que o informado.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
Query Parameters
ID da conta bancária. Quando não informado, retorna transações de todas as contas.
Data de início do período (formato YYYY-MM-DD). Obrigatório quando endDate é informado.
Data de fim do período (formato YYYY-MM-DD). Obrigatório quando startDate é informado.
Número máximo de transações por página. Mínimo: 1, Máximo: 50. Padrão: 20.
Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.
Campo e ordem de ordenação, ex: transactionDate:DESC.
Filtra transações que possuem ou não anexos.
Filtra transações pela situação de conciliação.
Lista de IDs de categorias para filtrar. Separe múltiplos valores por vírgula.
Lista de IDs de centros de custo para filtrar. Separe múltiplos valores por vírgula.
Filtra transações pelo e-mail do responsável.
Filtra pelo status da transação. Valores: 1 (CANCELADO), 2 (PROCESSADO), 3 (PENDENTE). Separe múltiplos valores por vírgula.
Filtra transações com valor exatamente igual ao informado.
Filtra transações com valor maior que o informado.
Filtra transações com valor menor que o informado.
Responses
Lista de transações bancárias
ID da transação
ID do tipo de transação
Descrição do tipo de transação
Ícone representativo do tipo
Subtipo da transação
ID da empresa
Status numérico da transação (1: CANCELADO, 2: PROCESSADO, 3: PENDENTE)
Descrição do status da transação
ID da conta bancária
Últimos dígitos do cartão (quando aplicável)
Nome do portador do cartão (quando aplicável)
Data e hora da transação
Valor em reais (BRL)
Valor em dólares (USD)
Taxa de câmbio USD/BRL utilizada
Data da taxa de câmbio
Valor total da transação incluindo encargos
Valor do IOF
Valor da tarifa de serviço
Código MCC do estabelecimento
Grupo MCC do estabelecimento
ID do evento de compra vinculado
Descrição do MCC do estabelecimento
Nome da origem ou destino da transação
Local do estabelecimento
Lista de anexos vinculados à transação
Identificador único do anexo. Use este ID no endpoint GET /attachments/v1/content/{attachmentId} para download.
Nome do arquivo do anexo.
Tipo MIME do arquivo, inferido pela extensão do nome (.jpg/.jpeg, .png ou .pdf). Ausente quando a extensão não for reconhecida.
image/jpegimage/pngapplication/pdfLinks para download do conteúdo do anexo.
Link HATEOAS para recurso relacionado.
URL relativa do recurso vinculado.
Método HTTP para acessar o recurso.
Descrição da conciliação
Indica se a transação foi conciliada
Indica se o comprovante está disponível
Descrição da transação
Notas adicionais da transação
Categoria da transação
Centro de custo da transação
Usuário responsável pela transação
Usuário solicitante da transação
Categoria customizada da transação
Token opaco para obter a próxima página. Ausente quando não há mais páginas.
Breve identificação do tipo de erro (ex.: Bad Request, Not Found).
Descrição breve do erro para o cliente da API.
Código HTTP do erro (corresponde ao status da resposta).
Opcional. Em erros 400, pode ser uma string com um único detalhe ou um array de strings com cada falha de validação.
Breve identificação do tipo de erro (ex.: Bad Request, Not Found).
Descrição breve do erro para o cliente da API.
Código HTTP do erro (corresponde ao status da resposta).
Opcional. Em erros 400, pode ser uma string com um único detalhe ou um array de strings com cada falha de validação.
Breve identificação do tipo de erro (ex.: Bad Request, Not Found).
Descrição breve do erro para o cliente da API.
Código HTTP do erro (corresponde ao status da resposta).
Opcional. Em erros 400, pode ser uma string com um único detalhe ou um array de strings com cada falha de validação.
Breve identificação do tipo de erro (ex.: Bad Request, Not Found).
Descrição breve do erro para o cliente da API.
Código HTTP do erro (corresponde ao status da resposta).
Opcional. Em erros 400, pode ser uma string com um único detalhe ou um array de strings com cada falha de validação.
Last updated today
Built with Documentation.AI