Create a Transaction

Create a new transaction

Create a Transaction

POST https://api.omnimoney.app/v1/transactions

The date columns must be in YYYY-MM-DD format

currency must be a three letter currency code. E.g. USD, EUR, etc.

Transaction must have one of the following: 'transfer_account_id', 'payee', 'payee_id'

Headers

Name	Type	Description
Authorization*	string	Bearer ACCESS_TOKEN

Request Body

Name	Type	Description
transactions*	array	An array of transaction objects (see below)
update_account_balance	boolean	Flag to update account balances after creating the new transactions. Defaults to true

201: Created Transactions have been successfully created

{
    "transactions": [
        {
            "id": "fe8e935a-3408-4580-84e9-1581c4556526",
            "created_at": "2021-12-01T16:15:51.21841+00:00",
            "updated_at": "2021-12-01T16:15:51.21841+00:00",
            "account_id": "9e6c5e12-b6db-4ad8-8c6f-d7de0af54116",
            "transfer_account_id": null,
            "payee_id": "94995e63-a899-428b-8058-df41c1ee7e37",
            "amount": -10,
            "currency": "USD",
            "authorized_at": "2021-12-01",
            "posted_at": null,
            "is_pending": true,
            "notes": "",
            "category_id": "5a3da72d-7bb7-4aed-84af-8410c965b8b0",
            "source": "manual"
        }, 
        ...
    ],
}

400: Bad Request There was an error with the request

The transaction object for creating new transactions has the following fields:

{
    "account_id": required,
    "transfer_account_id": required if no payee_id or payee,
    "payee_id": required if no transfer_account_id or payee,
    "payee": {
        "name": required if no payee_id or transfer_account_id
    },
    "amount": required,
    "currency": required,
    "authorized_at": required,
    "posted_at": optional,
    "is_pending": optional (defaults to true),
    "notes": optional,
    "category_id": optional,
    "category": {
        "name": optional
    }
}

You can identify the payee for the transaction in only one of three ways:

1. If the transaction is a transfer from one account to another, then enter the id of the account as the transfer_account_id

2. If you know the payee_id of the payee, then enter the id as the payee_id

3. If you know the name of the payee, use a payee object

{
    ...,
    "payee": {
        "name": "Amazon"
    },
    ...
}

The same applies to the category. If you know the id of the associated category, then enter the id as the category_id. If you know the name of the category, then use a category object.

{
    ...,
    "category": {
        "name": "Groceries"
    },
    ...
}