logo
TransaçõesExtrato Bancário

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 quando endDate é informado e vice-versa.
  • O limit deve estar entre 1 e 50 itens por página (padrão: 20).
  • Use nextPageStartKey para 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"
{
  "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": "John Doe",
          "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"
}
GET
/statements/v1/banking
GET
Bearer Token
Bearer Tokenstring
Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
query
accountIdinteger

ID da conta bancária. Quando não informado, retorna transações de todas as contas.

query
startDatestring

Data de início do período (formato YYYY-MM-DD). Obrigatório quando endDate é informado.

Format: date
query
endDatestring

Data de fim do período (formato YYYY-MM-DD). Obrigatório quando startDate é informado.

Format: date
query
limitinteger

Número máximo de transações por página. Mínimo: 1, Máximo: 50. Padrão: 20.

Min: 1 • Max: 50
query
nextPageStartKeystring

Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.

query
sortingstring

Campo e ordem de ordenação, ex: transactionDate:DESC.

query
hasAttachmentsboolean

Filtra transações que possuem ou não anexos.

query
wasConciledboolean

Filtra transações pela situação de conciliação.

query
categoryIdsarray

Lista de IDs de categorias para filtrar. Separe múltiplos valores por vírgula.

query
costCenterIdsarray

Lista de IDs de centros de custo para filtrar. Separe múltiplos valores por vírgula.

query
responsibleEmailstring

Filtra transações pelo e-mail do responsável.

query
statusarray

Filtra pelo status da transação. Valores: 1 (CANCELADO), 2 (PROCESSADO), 3 (PENDENTE). Separe múltiplos valores por vírgula.

query
amountEqnumber

Filtra transações com valor exatamente igual ao informado.

query
amountGtnumber

Filtra transações com valor maior que o informado.

query
amountLtnumber

Filtra transações com valor menor que o informado.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer \{token\}

Query Parameters

accountIdinteger

ID da conta bancária. Quando não informado, retorna transações de todas as contas.

startDatestring

Data de início do período (formato YYYY-MM-DD). Obrigatório quando endDate é informado.

endDatestring

Data de fim do período (formato YYYY-MM-DD). Obrigatório quando startDate é informado.

limitinteger

Número máximo de transações por página. Mínimo: 1, Máximo: 50. Padrão: 20.

nextPageStartKeystring

Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.

sortingstring

Campo e ordem de ordenação, ex: transactionDate:DESC.

hasAttachmentsboolean

Filtra transações que possuem ou não anexos.

wasConciledboolean

Filtra transações pela situação de conciliação.

categoryIdsarray

Lista de IDs de categorias para filtrar. Separe múltiplos valores por vírgula.

costCenterIdsarray

Lista de IDs de centros de custo para filtrar. Separe múltiplos valores por vírgula.

responsibleEmailstring

Filtra transações pelo e-mail do responsável.

statusarray

Filtra pelo status da transação. Valores: 1 (CANCELADO), 2 (PROCESSADO), 3 (PENDENTE). Separe múltiplos valores por vírgula.

amountEqnumber

Filtra transações com valor exatamente igual ao informado.

amountGtnumber

Filtra transações com valor maior que o informado.

amountLtnumber

Filtra transações com valor menor que o informado.

Responses

transactionsarray
Required

Lista de transações bancárias

nextPageStartKeystring

Token opaco para obter a próxima página. Ausente quando não há mais páginas.