Transactions

Each transaction it's and income or expenses in a user bank account.

Endpoints

List and filter your transactions

GET https://monse.app/v1/transactions

Query Parameters

Name	Type	Description
page	integer	Page number.
include	string	You can add one or multiple of category, bankAccount and bankAccount.bank. Separated by comma.
filter[text]	string	Filter transaction by concept or notes.
base-fiat	string	In which currency do you want the transactions.
per-page	integer	Number of items per page. Max value, it's 30.

Headers

Name	Type	Description
authorization	string	Bearer token of the user. Example: Bearer eyJ0eXAiOiJK…abJfpQc07c_eig-Eok

200 List of transactions

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "bank_account_id": 1,
      "category_id": 20,
      "status": "booked",
      "type": "expense",
      "from": [],
      "to": [],
      "concept": "Any random concept for a transaction",
      "notes": null,
      "amount": -73640,
      "currency": "USD",
      "booked_at": "2022-08-14T00:00:00.000000Z",
      "created_at": "2022-08-14T22:13:58.000000Z",
      "updated_at": "2022-08-14T22:13:58.000000Z",
      "deleted_at": null,
      "category": {
        "id": 20,
        "parent_id": 17,
        "type": "expense",
        "level": 1,
        "accountable": 1,
        "slug": "transportation-expenses-expense",
        "icon": "emoji_transportation",
        "name": "Transportation expenses",
        "description": "All transactions that are recognized as payments for public transportation, taxi, toll roads, department of motor vehicles and car inspections",
        "created_at": "2022-08-14T22:13:56.000000Z",
        "updated_at": "2022-08-14T22:13:56.000000Z"
      },
      
      // ...
    }
  ],
  "first_page_url": "http://monse.test/v1/transactions?include=category%2CbankAccount%2CbankAccount.bank&per-page=1&page=1",
  "from": 1,
  "last_page": 32,
  "last_page_url": "http://monse.test/v1/transactions?include=category%2CbankAccount%2CbankAccount.bank&per-page=1&page=32",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "http://monse.test/v1/transactions?include=category%2CbankAccount%2CbankAccount.bank&per-page=1&page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "http://monse.test/v1/transactions?include=category%2CbankAccount%2CbankAccount.bank&per-page=1&page=2",
      "label": "2",
      "active": false
    },
    
    // ...
    
    {
      "url": "http://monse.test/v1/transactions?include=category%2CbankAccount%2CbankAccount.bank&per-page=1&page=2",
      "label": "Next »",
      "active": false
    }
  ],
  "next_page_url": "http://monse.test/v1/transactions?include=category%2CbankAccount%2CbankAccount.bank&per-page=1&page=2",
  "path": "http://monse.test/v1/transactions",
  "per_page": 30,
  "prev_page_url": null,
  "to": 1,
  "total": 32
}

401 Permission denied

Create a new transaction

POST https://monse.app/v1/transactions

You can only create transactions for manual accounts.

Request Body

Name	Type	Description
amount*	Integer	In cents
bank_account_id*	Integer	The ID of the bank account.
booked_at*	String	Booked at date in Y-m-d format.
concept*	String	A description of the transaction.
notes	String
category_id	Integer
currency	String	Currency code. Inherited from bank account if no value.

201: Created Transaction created

{
    'id': 9
}

401: Unauthorized Permission denied

{
    // Response
}

400: Bad Request Missing or invalid fields

{
    "amount": [
        "The amount field is required."
    ],
    "bank_account_id": [
        "The bank account id field is required."
    ],
    "booked_at": [
        "The booked at field is required."
    ],
    "concept": [
        "The concept field is required."
    ]
}

Update a transaction

PUT https://monse.app/v1/transactions/{id}

Path Parameters

Name	Type	Description
	Integer	Transaction ID

Request Body

Name	Type	Description
category_id	Integer	New transaction category
notes	String	New transaction notes

204: No Content Transaction updated successfully

{
    // Response
}

401: Unauthorized Permission denied

{
    // Response
}

Delete a transaction

DELETE https://monse.app/v1/transactions/{id}

The transaction will be marked as deleted and this action can't be undone.

Query Parameters

Name	Type	Description
	Integer	Transaction ID

204: No Content Transaction deleted

{
    // Response
}

401: Unauthorized Permission denied

{
    // Response
}