GET /v1/accounts/entries/{accountId}

Este endpoint permite que os desenvolvedores acessem a movimentação de uma conta registrada no Agavos. Ao fazer uma chamada para este endpoint, serão retornadas as transações realizadas na conta, incluindo depósitos, transferências, pagamentos e outras transações financeiras.

Para acessar este endpoint, é necessário fazer uma chamada para a API, especificando o ID da conta desejada e as datas de início e término do período de transações que deseja consultar.

Query parameters

  • startDate string(date)

    Data inicial - Padrão dd/mm/yyyy

  • endDate string(date)

    Data final - Padrão dd/mm/yyyy

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • code integer
    • data array[object]
      Hide data attributes Show data attributes array[object]
      • date number
      • type string
      • value number
      • tax boolean
      • balance number
      • quantity integer
      • out boolean
GET /v1/accounts/entries/{accountId}
curl \
 -X GET https://sandbox.agavos.com.br/v1/accounts/entries/{accountId} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "code": 0,
  "data": [
    {
      "date": 1682564400000,
      "type": "INITIAL_BALANCE",
      "value": 178.06,
      "tax": false,
      "balance": 178.06,
      "quantity": 1,
      "out": false
    },
    {
      "document": "6939908",
      "date": 1681311837000,
      "type": "PIX",
      "value": -10.11,
      "tax": false,
      "balance": 178.06,
      "quantity": 1,
      "out": true
    },
    {
      "document": "6939846",
      "date": 1681311193000,
      "type": "PIX",
      "value": -10.1,
      "tax": false,
      "balance": 188.17,
      "quantity": 1,
      "out": true
    }
  ]
}
Response examples (200)
{
  "code": 0,
  "data": [
    {
      "out": false,
      "tax": false,
      "date": 1682564400000,
      "type": "INITIAL_BALANCE",
      "value": 178.06,
      "balance": 178.06,
      "quantity": 1
    }
  ]
}