Finmei Public API

The Finmei API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

To get your authorization token please go to https://app.finmei.com, login and select Settings -> Integrations. In this page you can generate your API tokens. The token will be shown only once.

Each API token is assigned to a specific business and can't be used to retrieve information about other businesses in the same account.

AUTHORIZATIONBearer Token

Token

•••••••

Expenses

AUTHORIZATIONBearer Token

This folder is using Bearer Token from collectionFinmei Public API

GETList Expenses

https://app.finmei.com/api/expenses

AUTHORIZATIONBearer Token

This request is using Bearer Token from collectionFinmei Public API

Example Request

curl

curl --location 'https://app.finmei.com/api/expenses'

200 OK

Example Response

json

{
  "data": [
    {
      "id": "9b5fca2c-7d57-473d-b304-8da4b17da938",
      "date": "2024-02-19",
      "total": 9.99,
      "currency": "USD",
      "seller": "Google Cloud EMEA Limited",
      "created_at": 1708357161,
      "updated_at": 1708357161
    },
    {
      "id": "9b5fca23-9149-4f65-bbac-5eea6b50daa4",
      "date": "2024-01-19",
      "total": 9.99,
      "currency": "USD",
      "seller": "Google Cloud EMEA Limited",
      "created_at": 1708357155,
      "updated_at": 1708357155
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://app.finmei.com/api/expenses",
    "per_page": 50,
    "to": 2,
    "total": 2
  }
}

Server

nginx/1.18.0 (Ubuntu)

Content-Type

application/json

Transfer-Encoding

chunked

Connection

keep-alive

Cache-Control

no-cache, private

Date

Mon, 19 Feb 2024 15:39:56 GMT

X-RateLimit-Limit

X-RateLimit-Remaining

Access-Control-Allow-Origin

POSTCreate Expense

https://app.finmei.com/api/expenses

For this request please use multipart/form-data content type. Note that this endpoint is different than most of other our endpoints which doesn't include file fields.

Field		Description
file	Required	Usually PDF or image file of the bill
date	Required	Date of the expense
total	Required	Total amount
currency	Required	Uppercase three letter currency code. Example: USD
seller	Required	Name of the seller from invoice

AUTHORIZATIONBearer Token

This request is using Bearer Token from collectionFinmei Public API

Bodyformdata

file

Expense file in pdf or image formats

seller

Google Cloud EMEA Limited

Either a company or individual seller name, for example: Google Inc.

total

9.99

Total invoice amount

currency

USD

Uppercase three letter currency code. Example: USD

date

2024-02-19

Document date

Example Request

curl

curl --location 'https://app.finmei.com/api/expenses' \
--form 'file=@"postman-cloud:///1eecf3cf-4272-4ea0-8a87-35738c934534"' \
--form 'seller="Google Cloud EMEA Limited"' \
--form 'total="9.99"' \
--form 'currency="USD"' \
--form 'date="2024-02-19"'

201 Created

Example Response

json

{
  "data": {
    "id": "9b5fca2c-7d57-473d-b304-8da4b17da938",
    "date": "2024-02-19",
    "total": 9.99,
    "currency": "USD",
    "seller": "Google Cloud EMEA Limited",
    "created_at": 1708357161,
    "updated_at": 1708357161
  }
}

Server

nginx/1.18.0 (Ubuntu)

Content-Type

application/json

Transfer-Encoding

chunked

Connection

keep-alive

Cache-Control

no-cache, private

Date

Mon, 19 Feb 2024 15:39:21 GMT

X-RateLimit-Limit

X-RateLimit-Remaining

Access-Control-Allow-Origin

PUTUpdate Expense

https://app.finmei.com/api/expenses/:id

Using this endpoint you can update expense fields. To update the invoice/bill file please use the Update Expense File endpoint.

Field		Description
date	Required	Date of the expense
total	Required	Total amount
currency	Required	Uppercase three letter currency code. Example: USD
seller	Required	Name of the seller from invoice

AUTHORIZATIONBearer Token

This request is using Bearer Token from collectionFinmei Public API

PATH VARIABLES

Expense ID

Bodyraw (json)

json

{
    "seller": "Google Cloud EMEA Limited",
    "total": 8.99,
    "currency": "USD",
    "date": "2024-02-29"
}

Example Request

curl

curl --location --request PUT 'https://app.finmei.com/api/expenses/:id' \
--data '{
    "seller": "Google Cloud EMEA Limited",
    "total": 8.99,
    "currency": "USD",
    "date": "2024-02-29"
}'

200 OK

Example Response

json

{
  "data": {
    "id": "9b5fca2c-7d57-473d-b304-8da4b17da938",
    "date": "2024-02-29",
    "total": 8.99,
    "currency": "USD",
    "seller": "Google Cloud EMEA Limited",
    "created_at": 1708357161,
    "updated_at": 1708357267
  }
}

Server

nginx/1.18.0 (Ubuntu)

Content-Type

application/json

Transfer-Encoding

chunked

Connection

keep-alive

Cache-Control

no-cache, private

Date

Mon, 19 Feb 2024 15:41:07 GMT

X-RateLimit-Limit

X-RateLimit-Remaining

Access-Control-Allow-Origin