Skip to main content
POST
/
api
/
v1
/
transactions
Create transaction
curl --request POST \
  --url https://app.sure.am/api/v1/transactions \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "transaction": {
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "date": "2023-12-25",
    "amount": 123,
    "name": "<string>",
    "description": "<string>",
    "notes": "<string>",
    "currency": "<string>",
    "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tag_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "2023-12-25",
  "amount": "<string>",
  "amount_cents": 1,
  "signed_amount_cents": 123,
  "currency": "<string>",
  "name": "<string>",
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "account_type": "<string>"
  },
  "tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "color": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "category": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "classification": "<string>",
    "color": "<string>",
    "icon": "<string>"
  },
  "merchant": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "transfer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": "<string>",
    "currency": "<string>",
    "other_account": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "account_type": "<string>"
    }
  }
}

Authorizations

​
X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Body

application/json
​
transaction
object
required

Response

transaction created

​
id
string<uuid>
required
​
date
string<date>
required
​
amount
string
required

Localized, formatted amount string (e.g. "$50.00")

​
amount_cents
integer
required

Absolute amount in minor currency units (e.g. 5000 for $50.00 USD). Uses the currency's minor-unit conversion factor.

Required range: x >= 0
​
signed_amount_cents
integer
required

Signed amount in minor currency units. Positive for income, negative for expenses.

​
currency
string
required
​
name
string
required
​
classification
enum<string>
required
Available options:
income,
expense
​
account
object
required
​
tags
object[]
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
notes
string | null
​
category
object | null
​
merchant
object | null
​
transfer
object | null