Transactions

Get Transactions

Returns all transactions associated with the currently authenticated user.

Args:

  • offset (int, optional): The starting index of transactions to return.
  • limit (int, optional): Max number of transactions to return.
  • pending (bool, optional): If True, only transactions with a null envelope_id will be returned.

Returns:

  • A list of transactions associated with the currently authenticated user.
get/transactions/

Request

  • Base URL: https://api.envelopebudget.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.envelopebudget.com/transactions/
  • Auth: one of:
    • API key in header X-API-Key
    • OAuth 2 (password, token URL token)

Query parameters

offsetinteger
limitinteger

Max number of transactions to return. Max limit is 100.

pendingboolean
clearedboolean

Response

Successful Response

totalinteger required
pagesinteger required

Example response

{
  "transactions": [
    {
      "id": 1,
      "created_at": "2023-01-01T00:00:00Z",
      "updated_at": "2023-01-01T00:00:00Z",
      "account": 1,
      "account_name": "Account 1",
      "date": "2023-01-01",
      "amount": 100,
      "payee": "John",
      "number": "123",
      "memo": "Sample",
      "cleared": true,
      "uid": "abc",
      "envelope": 1
    }
  ],
  "total": 100,
  "pages": 4
}

Changes

No recorded changes to this operation across all 1 revision of this API.