FINMAP public API

webhooks

Response

200 All available webhooks.

get /v2.2/webhooks

Response (200)

[
  {
    "id": "string",
    "name": "string",
    "url": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "name": "string",
    "url": "string"
  }
]

401 Error

(no example)

Success (200) schema

(array)

Error (401) schema

—

Request

Body

Name	Type	Description
name *	string	—
url *	string	—

Response

201 Created.

Name	Type	Description
id *	string	—
name *	string	—
url *	string	—

post /v2.2/webhooks

Request body

{
  "name": "string",
  "url": "string"
}

Response (201)

{
  "id": "string",
  "name": "string",
  "url": "string"
}

201 Success

{
  "id": "string",
  "name": "string",
  "url": "string"
}

401 Error

(no example)

Success (201) schema

id string

name string

url string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—

Body

Name	Type	Description
name *	string	—
url *	string	—

Response

200 Updated.

Name	Type	Description
id *	string	—
name *	string	—
url *	string	—

patch /v2.2/webhooks/{id}

Request body

{
  "name": "string",
  "url": "string"
}

Response (200)

{
  "id": "string",
  "name": "string",
  "url": "string"
}

200 Success

{
  "id": "string",
  "name": "string",
  "url": "string"
}

401 Error

(no example)

Success (200) schema

id string

name string

url string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

delete /v2.2/webhooks/{id}

No example available

200 Success

(no example)

401 Error

(no example)

Success (200) schema

—

Error (401) schema

—

default

Response

200 The Health Check is successful

Name	Type	Description
status	string	—
info	object	—
error	object	—
details	object	—

get /v2.2/health

Response (200)

{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}

200 Success

{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}

503 Error

{
  "status": "error",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {
    "redis": {
      "status": "down",
      "message": "Could not connect"
    }
  },
  "details": {
    "database": {
      "status": "up"
    },
    "redis": {
      "status": "down",
      "message": "Could not connect"
    }
  }
}

Success (200) schema

status string

info object

(object)

error object

(object)

details object

(object)

Error (503) schema

status string

info object

(object)

error object

(object)

details object

(object)

currencies

Response

200 All supported currencies.

get /v2.2/currencies

Response (200)

[
  {
    "symbol": "string",
    "id": "string"
  }
]

200 Success

[
  {
    "symbol": "string",
    "id": "string"
  }
]

401 Error

(no example)

Success (200) schema

(array)

Error (401) schema

—

currencyExchangeRates

Get custom currency exchange rate

Response

200 All custom currency exchange rates

get /v2.2/currencyExchangeRates/custom/all

Response (200)

[
  {
    "from": "USD",
    "to": "EUR",
    "rate": 1.2
  }
]

200 Success

[
  {
    "from": "USD",
    "to": "EUR",
    "rate": 1.2
  }
]

401 Error

(no example)

Success (200) schema

(array)

Error (401) schema

—

Create or update custom currency exchange rate

Request

Body

Name	Type	Description
from *	string	from currency
to *	string	to currency
rate *	number	currency exchange rate

Response

201 Created or updated custom currency exchange rate

Name	Type	Description
from *	string	from currency
to *	string	to currency
rate *	number	currency exchange rate

post /v2.2/currencyExchangeRates/custom

Request body

{
  "from": "USD",
  "to": "EUR",
  "rate": 1.2
}

Response (201)

{
  "from": "USD",
  "to": "EUR",
  "rate": 1.2
}

201 Success

{
  "from": "USD",
  "to": "EUR",
  "rate": 1.2
}

401 Error

(no example)

Success (201) schema

from string from currency

to string to currency

rate number currency exchange rate

Error (401) schema

—

Delete custom currency exchange rate

Request

Path

Name	Type	Description
from *	string	from currency
to *	string	to currency

Response

200

Name	Type	Description
deleted *	boolean	deleted status

delete /v2.2/currencyExchangeRates/custom/{from}/{to}

URL

/v2.2/currencyExchangeRates/custom/USD/EUR

Response (200)

{
  "deleted": true
}

200 Success

{
  "deleted": true
}

401 Error

(no example)

Success (200) schema

deleted boolean deleted status

Error (401) schema

—

accounts

Request

Query

Name	Type	Description
withBalances	string	—

Response

200 All availables to write accounts.

get /v2.2/accounts

URL

/v2.2/accounts?withBalances=true

Response (200)

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string",
    "currencyId": "string",
    "balance": 0,
    "companyCurrencyBalance": 0
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string",
    "currencyId": "string",
    "balance": 0,
    "companyCurrencyBalance": 0
  }
]

401 Error

(no example)

Success (200) schema

(array)

Error (401) schema

—

projects

Response

200 All availables projects.

get /v2.2/projects

Response (200)

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

401 Error

(no example)

Success (200) schema

(array)

Error (401) schema

—

Request

Body

Name	Type	Description
label *	string	—

Response

201 Created.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

post /v2.2/projects

Request body

{
  "label": "string"
}

Response (201)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

201 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

401 Error

(no example)

Success (201) schema

id string

label string

parentId string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—

Body

Name	Type	Description
label *	string	—

Response

200 Updated.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

patch /v2.2/projects/{id}

Request body

{
  "label": "string"
}

Response (200)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

200 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

401 Error

(no example)

Success (200) schema

id string

label string

parentId string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

delete /v2.2/projects/{id}

No example available

200 Success

(no example)

401 Error

(no example)

Success (200) schema

—

Error (401) schema

—

categories/income

Response

200 All availables category.

get /v2.2/categories/income

Response (200)

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string",
    "isSystem": true,
    "vendorEditLockUrl": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string",
    "isSystem": true,
    "vendorEditLockUrl": "string"
  }
]

401 Error

(no example)

Success (200) schema

(array)

Error (401) schema

—

Request

Body

Name	Type	Description
label *	string	—
vendorEditLockUrl *	string	—
parentId *	string	—

Response

201 Created.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—
isSystem *	boolean	—
vendorEditLockUrl *	string	—

post /v2.2/categories/income

Request body

{
  "label": "string",
  "vendorEditLockUrl": "string",
  "parentId": "string"
}

Response (201)

{
  "id": "string",
  "label": "string",
  "parentId": "string",
  "isSystem": true,
  "vendorEditLockUrl": "string"
}

201 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string",
  "isSystem": true,
  "vendorEditLockUrl": "string"
}

401 Error

(no example)

Success (201) schema

id string

label string

parentId string

isSystem boolean

vendorEditLockUrl string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—
dashboardId *	string	—

Response

200 One filter item.

Name	Type	Description
id *	string	—
itemId *	string	—
type *	string	—

get /v2.2/categories/income/{id}/excludeFilterByDashboard/{dashboardId}

Response (200)

{
  "id": "string",
  "itemId": "string",
  "type": "string"
}

200 Success

{
  "id": "string",
  "itemId": "string",
  "type": "string"
}

401 Error

(no example)

Success (200) schema

id string

itemId string

type string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—
dashboardId *	string	—

Response

201 Created.

Name	Type	Description
id *	string	—
itemId *	string	—
type *	string	—

post /v2.2/categories/income/{id}/excludeFilterByDashboard/{dashboardId}

Response (201)

{
  "id": "string",
  "itemId": "string",
  "type": "string"
}

201 Success

{
  "id": "string",
  "itemId": "string",
  "type": "string"
}

401 Error

(no example)

Success (201) schema

id string

itemId string

type string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—
dashboardId *	string	—

Response

200 Deleted.

Name	Type	Description
id *	string	—
itemId *	string	—
type *	string	—

delete /v2.2/categories/income/{id}/excludeFilterByDashboard/{dashboardId}

Response (200)

{
  "id": "string",
  "itemId": "string",
  "type": "string"
}

200 Success

{
  "id": "string",
  "itemId": "string",
  "type": "string"
}

401 Error

(no example)

Success (200) schema

id string

itemId string

type string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—

Body

Name	Type	Description
label *	string	—
vendorEditLockUrl *	string	—
parentId *	string	—

Response

200 Updated.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—
isSystem *	boolean	—
vendorEditLockUrl *	string	—

patch /v2.2/categories/income/{id}

Request body

{
  "label": "string",
  "vendorEditLockUrl": "string",
  "parentId": "string"
}

Response (200)

{
  "id": "string",
  "label": "string",
  "parentId": "string",
  "isSystem": true,
  "vendorEditLockUrl": "string"
}

200 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string",
  "isSystem": true,
  "vendorEditLockUrl": "string"
}

401 Error

(no example)

Success (200) schema

id string

label string

parentId string

isSystem boolean

vendorEditLockUrl string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

delete /v2.2/categories/income/{id}

No example available

200 Success

(no example)

401 Error

(no example)

Success (200) schema

—

Error (401) schema

—

categories/expense

Response

200 All availables category.

get /v2.2/categories/expense

Response (200)

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string",
    "isSystem": true,
    "vendorEditLockUrl": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string",
    "isSystem": true,
    "vendorEditLockUrl": "string"
  }
]

401 Error

(no example)

Success (200) schema

(array)

Error (401) schema

—

Request

Body

Name	Type	Description
label *	string	—
vendorEditLockUrl *	string	—
parentId *	string	—

Response

201 Created.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—
isSystem *	boolean	—
vendorEditLockUrl *	string	—

post /v2.2/categories/expense

Request body

{
  "label": "string",
  "vendorEditLockUrl": "string",
  "parentId": "string"
}

Response (201)

{
  "id": "string",
  "label": "string",
  "parentId": "string",
  "isSystem": true,
  "vendorEditLockUrl": "string"
}

201 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string",
  "isSystem": true,
  "vendorEditLockUrl": "string"
}

401 Error

(no example)

Success (201) schema

id string

label string

parentId string

isSystem boolean

vendorEditLockUrl string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—
dashboardId *	string	—

Response

200 One filter item.

Name	Type	Description
id *	string	—
itemId *	string	—
type *	string	—

get /v2.2/categories/expense/{id}/excludeFilterByDashboard/{dashboardId}

Response (200)

{
  "id": "string",
  "itemId": "string",
  "type": "string"
}

200 Success

{
  "id": "string",
  "itemId": "string",
  "type": "string"
}

401 Error

(no example)

Success (200) schema

id string

itemId string

type string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—
dashboardId *	string	—

Response

201 Created.

Name	Type	Description
id *	string	—
itemId *	string	—
type *	string	—

post /v2.2/categories/expense/{id}/excludeFilterByDashboard/{dashboardId}

Response (201)

{
  "id": "string",
  "itemId": "string",
  "type": "string"
}

201 Success

{
  "id": "string",
  "itemId": "string",
  "type": "string"
}

401 Error

(no example)

Success (201) schema

id string

itemId string

type string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—
dashboardId *	string	—

Response

200 Deleted.

Name	Type	Description
id *	string	—
itemId *	string	—
type *	string	—

delete /v2.2/categories/expense/{id}/excludeFilterByDashboard/{dashboardId}

Response (200)

{
  "id": "string",
  "itemId": "string",
  "type": "string"
}

200 Success

{
  "id": "string",
  "itemId": "string",
  "type": "string"
}

401 Error

(no example)

Success (200) schema

id string

itemId string

type string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—

Body

Name	Type	Description
label *	string	—
vendorEditLockUrl *	string	—
parentId *	string	—

Response

200 Updated.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—
isSystem *	boolean	—
vendorEditLockUrl *	string	—

patch /v2.2/categories/expense/{id}

Request body

{
  "label": "string",
  "vendorEditLockUrl": "string",
  "parentId": "string"
}

Response (200)

{
  "id": "string",
  "label": "string",
  "parentId": "string",
  "isSystem": true,
  "vendorEditLockUrl": "string"
}

200 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string",
  "isSystem": true,
  "vendorEditLockUrl": "string"
}

401 Error

(no example)

Success (200) schema

id string

label string

parentId string

isSystem boolean

vendorEditLockUrl string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

delete /v2.2/categories/expense/{id}

No example available

200 Success

(no example)

401 Error

(no example)

Success (200) schema

—

Error (401) schema

—

investors

Response

200 All availables investors.

get /v2.2/investors

Response (200)

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

400 Error

(no example)

Success (200) schema

(array)

Error (400) schema

—

Request

Body

Name	Type	Description
label *	string	—

Response

201 Created.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

post /v2.2/investors

Request body

{
  "label": "string"
}

Response (201)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

201 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

400 Error

(no example)

Success (201) schema

id string

label string

parentId string

Error (400) schema

—

Request

Path

Name	Type	Description
id *	string	—

Body

Name	Type	Description
label *	string	—

Response

200 Updated.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

patch /v2.2/investors/{id}

Request body

{
  "label": "string"
}

Response (200)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

200 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

400 Error

(no example)

Success (200) schema

id string

label string

parentId string

Error (400) schema

—

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

delete /v2.2/investors/{id}

No example available

200 Success

(no example)

400 Error

(no example)

Success (200) schema

—

Error (400) schema

—

creditors

Response

200 All availables creditors.

get /v2.2/creditors

Response (200)

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

400 Error

(no example)

Success (200) schema

(array)

Error (400) schema

—

Request

Body

Name	Type	Description
label *	string	—

Response

201 Created.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

post /v2.2/creditors

Request body

{
  "label": "string"
}

Response (201)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

201 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

400 Error

(no example)

Success (201) schema

id string

label string

parentId string

Error (400) schema

—

Request

Path

Name	Type	Description
id *	string	—

Body

Name	Type	Description
label *	string	—

Response

200 Updated.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

patch /v2.2/creditors/{id}

Request body

{
  "label": "string"
}

Response (200)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

200 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

400 Error

(no example)

Success (200) schema

id string

label string

parentId string

Error (400) schema

—

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

delete /v2.2/creditors/{id}

No example available

200 Success

(no example)

400 Error

(no example)

Success (200) schema

—

Error (400) schema

—

debitors

Response

200 All availables customers.

get /v2.2/debitors

Response (200)

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

400 Error

(no example)

Success (200) schema

(array)

Error (400) schema

—

Request

Body

Name	Type	Description
label *	string	—

Response

201 Created.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

post /v2.2/debitors

Request body

{
  "label": "string"
}

Response (201)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

201 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

400 Error

(no example)

Success (201) schema

id string

label string

parentId string

Error (400) schema

—

Request

Path

Name	Type	Description
id *	string	—

Body

Name	Type	Description
label *	string	—

Response

200 Updated.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

patch /v2.2/debitors/{id}

Request body

{
  "label": "string"
}

Response (200)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

200 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

400 Error

(no example)

Success (200) schema

id string

label string

parentId string

Error (400) schema

—

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

delete /v2.2/debitors/{id}

No example available

200 Success

(no example)

400 Error

(no example)

Success (200) schema

—

Error (400) schema

—

suppliers

Response

200 All availables suppliers.

get /v2.2/suppliers

Response (200)

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

401 Error

(no example)

Success (200) schema

(array)

Error (401) schema

—

Request

Body

Name	Type	Description
label *	string	—

Response

201 Created.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

post /v2.2/suppliers

Request body

{
  "label": "string"
}

Response (201)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

201 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

401 Error

(no example)

Success (201) schema

id string

label string

parentId string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—

Body

Name	Type	Description
label *	string	—

Response

200 Updated.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

patch /v2.2/suppliers/{id}

Request body

{
  "label": "string"
}

Response (200)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

200 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

401 Error

(no example)

Success (200) schema

id string

label string

parentId string

Error (401) schema

—

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

delete /v2.2/suppliers/{id}

No example available

200 Success

(no example)

401 Error

(no example)

Success (200) schema

—

Error (401) schema

—

employees

Response

200 All availables employees.

get /v2.2/employees

Response (200)

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

400 Error

(no example)

Success (200) schema

(array)

Error (400) schema

—

Request

Body

Name	Type	Description
label *	string	—

Response

201 Created.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

post /v2.2/employees

Request body

{
  "label": "string"
}

Response (201)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

201 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

400 Error

(no example)

Success (201) schema

id string

label string

parentId string

Error (400) schema

—

Request

Path

Name	Type	Description
id *	string	—

Body

Name	Type	Description
label *	string	—

Response

200 Updated.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

patch /v2.2/employees/{id}

Request body

{
  "label": "string"
}

Response (200)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

200 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

400 Error

(no example)

Success (200) schema

id string

label string

parentId string

Error (400) schema

—

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

delete /v2.2/employees/{id}

No example available

200 Success

(no example)

400 Error

(no example)

Success (200) schema

—

Error (400) schema

—

owners

Response

200 All availables employees.

get /v2.2/owners

Response (200)

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

400 Error

(no example)

Success (200) schema

(array)

Error (400) schema

—

Request

Body

Name	Type	Description
label *	string	—

Response

201 Created.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

post /v2.2/owners

Request body

{
  "label": "string"
}

Response (201)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

201 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

400 Error

(no example)

Success (201) schema

id string

label string

parentId string

Error (400) schema

—

Request

Path

Name	Type	Description
id *	string	—

Body

Name	Type	Description
label *	string	—

Response

200 Updated.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

patch /v2.2/owners/{id}

Request body

{
  "label": "string"
}

Response (200)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

200 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

400 Error

(no example)

Success (200) schema

id string

label string

parentId string

Error (400) schema

—

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

delete /v2.2/owners/{id}

No example available

200 Success

(no example)

400 Error

(no example)

Success (200) schema

—

Error (400) schema

—

tax-organisations

Response

200 All availables employees.

get /v2.2/tax-organisations

Response (200)

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string",
    "parentId": "string"
  }
]

400 Error

(no example)

Success (200) schema

(array)

Error (400) schema

—

Request

Body

Name	Type	Description
label *	string	—

Response

201 Created.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

post /v2.2/tax-organisations

Request body

{
  "label": "string"
}

Response (201)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

201 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

400 Error

(no example)

Success (201) schema

id string

label string

parentId string

Error (400) schema

—

Request

Path

Name	Type	Description
id *	string	—

Body

Name	Type	Description
label *	string	—

Response

201 Updated.

Name	Type	Description
id *	string	—
label *	string	—
parentId *	string	—

patch /v2.2/tax-organisations/{id}

Request body

{
  "label": "string"
}

Response (201)

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

201 Success

{
  "id": "string",
  "label": "string",
  "parentId": "string"
}

400 Error

(no example)

Success (201) schema

id string

label string

parentId string

Error (400) schema

—

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

delete /v2.2/tax-organisations/{id}

No example available

200 Success

(no example)

400 Error

(no example)

Success (200) schema

—

Error (400) schema

—

operations/income

Create income operation

Request

Query

Name	Type	Description
offset	number	User timezone offset (in milliseconds), influence only "approved" field (defines whether operation is future).

Body

Name	Type	Description
date	number	Date of operation Default: `current date in utc`
amount	number	Sum of operation Default: `0`
comment	string	—
amountInCompanyCurrency	number	—
exchangeRate	number	—
transactionSum	number	—
transactionCurrency	number	—
transactionCurrencyRate	number	—
dateOfPayment	number	—
startDate	number	—
endDate	number	—
accountToId	string	—
categoryId	string	—
counterpartyId	string	One field for all counterparty types. You can pass here borrowerId, creditorId, customerId, investorId
borrowerId	string	—
creditorId	string	—
customerId	string	—
investorId	string	—
projectId	string	Id of project
projects	array	—
categories	array	—
tagIds	array	Ids of tags
externalId	string	unique operation identifier Default: `new uuid v4`

Response

201 Created.

Name	Type	Description
status *	string	—
statusCode *	string	—

post /v2.2/operations/income

URL

/v2.2/operations/income?offset=7200000

Request body

{
  "date": 1775746044038,
  "amount": 100,
  "comment": "Test API",
  "amountInCompanyCurrency": 100,
  "exchangeRate": 0.3,
  "transactionSum": 100,
  "transactionCurrency": "USD",
  "transactionCurrencyRate": 0.3,
  "dateOfPayment": 1775918844038,
  "startDate": 1775001600000,
  "endDate": 1777593599999,
  "accountToId": "69d7bbfc5f10c3ed05c6bb27",
  "categoryId": "69d7bbfc5f10c3ed05c6bb28",
  "counterpartyId": "69d7bbfc5f10c3ed05c6bb29",
  "borrowerId": "69d7bbfc5f10c3ed05c6bb2a",
  "creditorId": "69d7bbfc5f10c3ed05c6bb2b",
  "customerId": "69d7bbfc5f10c3ed05c6bb2c",
  "investorId": "69d7bbfc5f10c3ed05c6bb2d",
  "projectId": "69d7bbfc5f10c3ed05c6bb30",
  "projects": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "categories": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "tagIds": [
    "69d7bbfc5f10c3ed05c6bb31"
  ],
  "externalId": "5faa9f57-1229-4d31-9d73-7b704b129f46"
}

Response (201)

{
  "status": "Processed now",
  "statusCode": "1"
}

201 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (201) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Update operation by id

Request

Path

Name	Type	Description
id *	string	—

Query

Name	Type	Description
offset	number	User timezone offset (in milliseconds), influence only "approved" field (defines whether operation is future).

Body

Name	Type	Description
comment	string	—
amountInCompanyCurrency	number	—
exchangeRate	number	—
transactionSum	number	—
transactionCurrency	number	—
transactionCurrencyRate	number	—
dateOfPayment	number	—
startDate	number	—
endDate	number	—
accountToId	string	—
categoryId	string	—
counterpartyId	string	One field for all counterparty types. You can pass here borrowerId, creditorId, customerId, investorId
borrowerId	string	—
creditorId	string	—
customerId	string	—
investorId	string	—
projectId	string	Id of project
projects	array	—
categories	array	—
tagIds	array	Ids of tags
date	number	Date of operation Default: `current date in utc`
amount	number	Sum of operation
externalDevComment	string	Field to be filled by integration developers (not visible to users)

Response

200 Updated.

Name	Type	Description
status *	string	—
statusCode *	string	—

patch /v2.2/operations/income/{id}

URL

/v2.2/operations/income/69d7bbfc5f10c3ed05c6bb32?offset=7200000

Request body

{
  "comment": "Test API",
  "amountInCompanyCurrency": 100,
  "exchangeRate": 0.3,
  "transactionSum": 100,
  "transactionCurrency": "USD",
  "transactionCurrencyRate": 0.3,
  "dateOfPayment": 1775918844038,
  "startDate": 1775001600000,
  "endDate": 1777593599999,
  "accountToId": "69d7bbfc5f10c3ed05c6bb27",
  "categoryId": "69d7bbfc5f10c3ed05c6bb28",
  "counterpartyId": "69d7bbfc5f10c3ed05c6bb29",
  "borrowerId": "69d7bbfc5f10c3ed05c6bb2a",
  "creditorId": "69d7bbfc5f10c3ed05c6bb2b",
  "customerId": "69d7bbfc5f10c3ed05c6bb2c",
  "investorId": "69d7bbfc5f10c3ed05c6bb2d",
  "projectId": "69d7bbfc5f10c3ed05c6bb30",
  "projects": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "categories": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "tagIds": [
    "69d7bbfc5f10c3ed05c6bb31"
  ],
  "date": 1775746044043,
  "amount": 100,
  "externalDevComment": "string"
}

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Delete operation by id

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

Name	Type	Description
status *	string	—
statusCode *	string	—

delete /v2.2/operations/income/{id}

URL

/v2.2/operations/income/69d7bbfc5f10c3ed05c6bb32

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Update operation by externalId

Request

Path

Name	Type	Description
id *	string	—

Query

Name	Type	Description
offset	number	User timezone offset (in milliseconds), influence only "approved" field (defines whether operation is future).

Body

Name	Type	Description
comment	string	—
amountInCompanyCurrency	number	—
exchangeRate	number	—
transactionSum	number	—
transactionCurrency	number	—
transactionCurrencyRate	number	—
dateOfPayment	number	—
startDate	number	—
endDate	number	—
accountToId	string	—
categoryId	string	—
counterpartyId	string	One field for all counterparty types. You can pass here borrowerId, creditorId, customerId, investorId
borrowerId	string	—
creditorId	string	—
customerId	string	—
investorId	string	—
projectId	string	Id of project
projects	array	—
categories	array	—
tagIds	array	Ids of tags
date	number	Date of operation Default: `current date in utc`
amount	number	Sum of operation
externalDevComment	string	Field to be filled by integration developers (not visible to users)

Response

200 Updated.

Name	Type	Description
status *	string	—
statusCode *	string	—

patch /v2.2/operations/income/byExternalId/{id}

URL

/v2.2/operations/income/byExternalId/2fe94d75-7a77-4cfc-a5ed-8e1cbf49bb8e?offset=7200000

Request body

{
  "comment": "Test API",
  "amountInCompanyCurrency": 100,
  "exchangeRate": 0.3,
  "transactionSum": 100,
  "transactionCurrency": "USD",
  "transactionCurrencyRate": 0.3,
  "dateOfPayment": 1775918844038,
  "startDate": 1775001600000,
  "endDate": 1777593599999,
  "accountToId": "69d7bbfc5f10c3ed05c6bb27",
  "categoryId": "69d7bbfc5f10c3ed05c6bb28",
  "counterpartyId": "69d7bbfc5f10c3ed05c6bb29",
  "borrowerId": "69d7bbfc5f10c3ed05c6bb2a",
  "creditorId": "69d7bbfc5f10c3ed05c6bb2b",
  "customerId": "69d7bbfc5f10c3ed05c6bb2c",
  "investorId": "69d7bbfc5f10c3ed05c6bb2d",
  "projectId": "69d7bbfc5f10c3ed05c6bb30",
  "projects": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "categories": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "tagIds": [
    "69d7bbfc5f10c3ed05c6bb31"
  ],
  "date": 1775746044043,
  "amount": 100,
  "externalDevComment": "string"
}

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Delete operation by externalId

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

Name	Type	Description
status *	string	—
statusCode *	string	—

delete /v2.2/operations/income/byExternalId/{id}

URL

/v2.2/operations/income/byExternalId/2fe94d75-7a77-4cfc-a5ed-8e1cbf49bb8e

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

operations/expense

Create expense operation

Request

Query

Name	Type	Description
offset	number	User timezone offset (in milliseconds), influence only "approved" field (defines whether operation is future).

Body

Name	Type	Description
date	number	Date of operation Default: `current date in utc`
amount	number	Sum of operation Default: `0`
comment	string	—
amountInCompanyCurrency	number	—
exchangeRate	number	—
transactionSum	number	—
transactionCurrency	number	—
transactionCurrencyRate	number	—
dateOfPayment	number	—
startDate	number	—
endDate	number	—
accountFromId	string	—
categoryId	string	—
counterpartyId	string	One field for all counterparty types. You can pass here borrowerId, creditorId, employeeId, supplierId, ownerId, taxOrganisationId
borrowerId	string	—
creditorId	string	—
employeeId	string	—
supplierId	string	—
ownerId	string	—
taxOrganisationId	string	—
projectId	string	Id of project
projects	array	—
categories	array	—
tagIds	array	Ids of tags
externalId	string	unique operation identifier Default: `new uuid v4`

Response

201 Created.

Name	Type	Description
status *	string	—
statusCode *	string	—

post /v2.2/operations/expense

URL

/v2.2/operations/expense?offset=7200000

Request body

{
  "date": 1775746044038,
  "amount": 100,
  "comment": "Test API",
  "amountInCompanyCurrency": 100,
  "exchangeRate": 0.3,
  "transactionSum": 100,
  "transactionCurrency": "USD",
  "transactionCurrencyRate": 0.3,
  "dateOfPayment": 1775918844038,
  "startDate": 1775001600000,
  "endDate": 1777593599999,
  "accountFromId": "69d7bbfc5f10c3ed05c6bb1e",
  "categoryId": "69d7bbfc5f10c3ed05c6bb1f",
  "counterpartyId": "69d7bbfc5f10c3ed05c6bb20",
  "borrowerId": "69d7bbfc5f10c3ed05c6bb21",
  "creditorId": "69d7bbfc5f10c3ed05c6bb22",
  "employeeId": "69d7bbfc5f10c3ed05c6bb23",
  "supplierId": "69d7bbfc5f10c3ed05c6bb24",
  "ownerId": "69d7bbfc5f10c3ed05c6bb25",
  "taxOrganisationId": "69d7bbfc5f10c3ed05c6bb26",
  "projectId": "69d7bbfc5f10c3ed05c6bb30",
  "projects": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "categories": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "tagIds": [
    "69d7bbfc5f10c3ed05c6bb31"
  ],
  "externalId": "5faa9f57-1229-4d31-9d73-7b704b129f46"
}

Response (201)

{
  "status": "Processed now",
  "statusCode": "1"
}

201 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (201) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Update operation by id

Request

Path

Name	Type	Description
id *	string	—

Query

Name	Type	Description
offset	number	User timezone offset (in milliseconds), influence only "approved" field (defines whether operation is future).

Body

Name	Type	Description
comment	string	—
amountInCompanyCurrency	number	—
exchangeRate	number	—
transactionSum	number	—
transactionCurrency	number	—
transactionCurrencyRate	number	—
dateOfPayment	number	—
startDate	number	—
endDate	number	—
accountFromId	string	—
categoryId	string	—
counterpartyId	string	One field for all counterparty types. You can pass here borrowerId, creditorId, employeeId, supplierId, ownerId, taxOrganisationId
borrowerId	string	—
creditorId	string	—
employeeId	string	—
supplierId	string	—
ownerId	string	—
taxOrganisationId	string	—
projectId	string	Id of project
projects	array	—
categories	array	—
tagIds	array	Ids of tags
date	number	Date of operation Default: `current date in utc`
amount	number	Sum of operation
externalDevComment	string	Field to be filled by integration developers (not visible to users)

Response

200 Updated.

Name	Type	Description
status *	string	—
statusCode *	string	—

patch /v2.2/operations/expense/{id}

URL

/v2.2/operations/expense/69d7bbfc5f10c3ed05c6bb32?offset=7200000

Request body

{
  "comment": "Test API",
  "amountInCompanyCurrency": 100,
  "exchangeRate": 0.3,
  "transactionSum": 100,
  "transactionCurrency": "USD",
  "transactionCurrencyRate": 0.3,
  "dateOfPayment": 1775918844038,
  "startDate": 1775001600000,
  "endDate": 1777593599999,
  "accountFromId": "69d7bbfc5f10c3ed05c6bb1e",
  "categoryId": "69d7bbfc5f10c3ed05c6bb1f",
  "counterpartyId": "69d7bbfc5f10c3ed05c6bb20",
  "borrowerId": "69d7bbfc5f10c3ed05c6bb21",
  "creditorId": "69d7bbfc5f10c3ed05c6bb22",
  "employeeId": "69d7bbfc5f10c3ed05c6bb23",
  "supplierId": "69d7bbfc5f10c3ed05c6bb24",
  "ownerId": "69d7bbfc5f10c3ed05c6bb25",
  "taxOrganisationId": "69d7bbfc5f10c3ed05c6bb26",
  "projectId": "69d7bbfc5f10c3ed05c6bb30",
  "projects": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "categories": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "tagIds": [
    "69d7bbfc5f10c3ed05c6bb31"
  ],
  "date": 1775746044043,
  "amount": 100,
  "externalDevComment": "string"
}

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Delete operation by id

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

Name	Type	Description
status *	string	—
statusCode *	string	—

delete /v2.2/operations/expense/{id}

URL

/v2.2/operations/expense/69d7bbfc5f10c3ed05c6bb32

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Update operation by externalId

Request

Path

Name	Type	Description
id *	string	—

Query

Name	Type	Description
offset	number	User timezone offset (in milliseconds), influence only "approved" field (defines whether operation is future).

Body

Name	Type	Description
comment	string	—
amountInCompanyCurrency	number	—
exchangeRate	number	—
transactionSum	number	—
transactionCurrency	number	—
transactionCurrencyRate	number	—
dateOfPayment	number	—
startDate	number	—
endDate	number	—
accountFromId	string	—
categoryId	string	—
counterpartyId	string	One field for all counterparty types. You can pass here borrowerId, creditorId, employeeId, supplierId, ownerId, taxOrganisationId
borrowerId	string	—
creditorId	string	—
employeeId	string	—
supplierId	string	—
ownerId	string	—
taxOrganisationId	string	—
projectId	string	Id of project
projects	array	—
categories	array	—
tagIds	array	Ids of tags
date	number	Date of operation Default: `current date in utc`
amount	number	Sum of operation
externalDevComment	string	Field to be filled by integration developers (not visible to users)

Response

200 Updated.

Name	Type	Description
status *	string	—
statusCode *	string	—

patch /v2.2/operations/expense/byExternalId/{id}

URL

/v2.2/operations/expense/byExternalId/2fe94d75-7a77-4cfc-a5ed-8e1cbf49bb8e?offset=7200000

Request body

{
  "comment": "Test API",
  "amountInCompanyCurrency": 100,
  "exchangeRate": 0.3,
  "transactionSum": 100,
  "transactionCurrency": "USD",
  "transactionCurrencyRate": 0.3,
  "dateOfPayment": 1775918844038,
  "startDate": 1775001600000,
  "endDate": 1777593599999,
  "accountFromId": "69d7bbfc5f10c3ed05c6bb1e",
  "categoryId": "69d7bbfc5f10c3ed05c6bb1f",
  "counterpartyId": "69d7bbfc5f10c3ed05c6bb20",
  "borrowerId": "69d7bbfc5f10c3ed05c6bb21",
  "creditorId": "69d7bbfc5f10c3ed05c6bb22",
  "employeeId": "69d7bbfc5f10c3ed05c6bb23",
  "supplierId": "69d7bbfc5f10c3ed05c6bb24",
  "ownerId": "69d7bbfc5f10c3ed05c6bb25",
  "taxOrganisationId": "69d7bbfc5f10c3ed05c6bb26",
  "projectId": "69d7bbfc5f10c3ed05c6bb30",
  "projects": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "categories": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "tagIds": [
    "69d7bbfc5f10c3ed05c6bb31"
  ],
  "date": 1775746044043,
  "amount": 100,
  "externalDevComment": "string"
}

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Delete operation by externalId

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

Name	Type	Description
status *	string	—
statusCode *	string	—

delete /v2.2/operations/expense/byExternalId/{id}

URL

/v2.2/operations/expense/byExternalId/2fe94d75-7a77-4cfc-a5ed-8e1cbf49bb8e

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

operations/transfer

Create transfer operation

Request

Query

Name	Type	Description
offset	number	User timezone offset (in milliseconds), influence only "approved" field (defines whether operation is future).

Body

Name	Type	Description
date	number	Date of operation Default: `current date in utc`
amount	number	Sum of operation Default: `0`
comment	string	—
accountToId *	string	—
accountFromId *	string	—
amountTo	number	If accountTo and accountFrom has different currencies
projectId	string	Id of project
projects	array	—
categories	array	—
tagIds	array	Ids of tags
externalId	string	unique operation identifier Default: `new uuid v4`

Response

201 Created.

Name	Type	Description
status *	string	—
statusCode *	string	—

post /v2.2/operations/transfer

URL

/v2.2/operations/transfer?offset=7200000

Request body

{
  "date": 1775746044038,
  "amount": 100,
  "comment": "Test API",
  "accountToId": "69d7bbfc5f10c3ed05c6bb2e",
  "accountFromId": "69d7bbfc5f10c3ed05c6bb2f",
  "amountTo": 100,
  "projectId": "69d7bbfc5f10c3ed05c6bb30",
  "projects": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "categories": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "tagIds": [
    "69d7bbfc5f10c3ed05c6bb31"
  ],
  "externalId": "5faa9f57-1229-4d31-9d73-7b704b129f46"
}

Response (201)

{
  "status": "Processed now",
  "statusCode": "1"
}

201 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (201) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Update operation by id

Request

Path

Name	Type	Description
id *	string	—

Query

Name	Type	Description
offset	number	User timezone offset (in milliseconds), influence only "approved" field (defines whether operation is future).

Body

Name	Type	Description
comment	string	—
amountTo	number	If accountTo and accountFrom has different currencies
projectId	string	Id of project
projects	array	—
categories	array	—
tagIds	array	Ids of tags
date	number	Date of operation
amount	number	Sum of operation
accountToId *	string	—
accountFromId *	string	—
externalDevComment	string	Field to be filled by integration developers (not visible to users)

Response

200 Updated.

Name	Type	Description
status *	string	—
statusCode *	string	—

patch /v2.2/operations/transfer/{id}

URL

/v2.2/operations/transfer/69d7bbfc5f10c3ed05c6bb32?offset=7200000

Request body

{
  "comment": "Test API",
  "amountTo": 100,
  "projectId": "69d7bbfc5f10c3ed05c6bb30",
  "projects": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "categories": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "tagIds": [
    "69d7bbfc5f10c3ed05c6bb31"
  ],
  "date": 1775746044043,
  "amount": 100,
  "accountToId": "69d7bbfc5f10c3ed05c6bb3b",
  "accountFromId": "69d7bbfc5f10c3ed05c6bb3c",
  "externalDevComment": "string"
}

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Delete operation by id

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

Name	Type	Description
status *	string	—
statusCode *	string	—

delete /v2.2/operations/transfer/{id}

URL

/v2.2/operations/transfer/69d7bbfc5f10c3ed05c6bb32

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Update operation by externalId

Request

Path

Name	Type	Description
id *	string	—

Query

Name	Type	Description
offset	number	User timezone offset (in milliseconds), influence only "approved" field (defines whether operation is future).

Body

Name	Type	Description
comment	string	—
amountTo	number	If accountTo and accountFrom has different currencies
projectId	string	Id of project
projects	array	—
categories	array	—
tagIds	array	Ids of tags
date	number	Date of operation
amount	number	Sum of operation
accountToId *	string	—
accountFromId *	string	—
externalDevComment	string	Field to be filled by integration developers (not visible to users)

Response

200 Updated.

Name	Type	Description
status *	string	—
statusCode *	string	—

patch /v2.2/operations/transfer/byExternalId/{id}

URL

/v2.2/operations/transfer/byExternalId/2fe94d75-7a77-4cfc-a5ed-8e1cbf49bb8e?offset=7200000

Request body

{
  "comment": "Test API",
  "amountTo": 100,
  "projectId": "69d7bbfc5f10c3ed05c6bb30",
  "projects": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "categories": [
    {
      "id": "69009f27afd43b202cd54aa0",
      "stake": 100,
      "companyCurrencySum": 100,
      "sum": 100,
      "transactionSum": 100
    }
  ],
  "tagIds": [
    "69d7bbfc5f10c3ed05c6bb31"
  ],
  "date": 1775746044043,
  "amount": 100,
  "accountToId": "69d7bbfc5f10c3ed05c6bb3b",
  "accountFromId": "69d7bbfc5f10c3ed05c6bb3c",
  "externalDevComment": "string"
}

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Delete operation by externalId

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

Name	Type	Description
status *	string	—
statusCode *	string	—

delete /v2.2/operations/transfer/byExternalId/{id}

URL

/v2.2/operations/transfer/byExternalId/2fe94d75-7a77-4cfc-a5ed-8e1cbf49bb8e

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

invoices

Request

Path

Name	Type	Description
id *	string	—

Query

Name	Type	Description
language	string	Invoice language (one of "ru" ,"en" ,"uk" ,"pl" ,"es" ,"cz" ,"tr" ,"uz" ,"pt-BR")

Response

200 PDF file successfully generated.

get /v2.2/invoices/pdf/{id}

URL

/v2.2/invoices/pdf/69d7bbfc5f10c3ed05c6bb3d?language=uk

200 Success

(no example)

401 Error

(no example)

Success (200) schema

—

Error (401) schema

—

Create invoice

Request

Query

Name	Type	Description
offset	number	User timezone offset (in milliseconds), influence only "approved" field (defines whether operation is future).

Body

Name	Type	Description
externalId	string	unique operation identifier Default: `new uuid v4`
dateOfPayment	number	—
date	number	Date of operation Default: `current date in utc`
comment	string	—
invoiceNumber *	string	invoice number
invoiceCompanyId *	string	id of invoice company
supplierId *	string	id of supplier (or client)
invoiceCompanyDetails *	string	information about my props
supplierDetails *	string	information about counterparty
goods *	array	array with information about goods
invoiceCurrency *	string	Currency
confirmedInvoice	boolean	confirmed invoice status
shipping	number	—
discountPercentage	number	Discount percentage (can used only discountPercentage or discountAmount)
discountAmount	number	Discount amount (can used only discountPercentage or discountAmount)
attachmentId	string	Attachment id of null

Response

201 Created.

Name	Type	Description
status *	string	—
statusCode *	string	—

post /v2.2/invoices

URL

/v2.2/invoices?offset=7200000

Request body

{
  "externalId": "5faa9f57-1229-4d31-9d73-7b704b129f46",
  "dateOfPayment": 1775918844048,
  "date": 1775746044048,
  "comment": "Test API",
  "invoiceNumber": "ExampleInvoice123456",
  "invoiceCompanyId": "63a0acd05fd26f3fa73fef4f",
  "supplierId": "63a0acd05fd26f7d203fef3f",
  "invoiceCompanyDetails": "company details (IBAN)",
  "supplierDetails": "counterparty details (IBAN)",
  "goods": [
    {
      "id": "63a01aa80e714d7a683b3ea4",
      "count": 10,
      "price": 10.1,
      "vat": 3
    }
  ],
  "invoiceCurrency": "UAH",
  "confirmedInvoice": false,
  "shipping": 100,
  "discountPercentage": 25,
  "discountAmount": 100,
  "attachmentId": null
}

Response (201)

{
  "status": "Processed now",
  "statusCode": "1"
}

201 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (201) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Update operation by id

Request

Path

Name	Type	Description
id *	string	—

Query

Name	Type	Description
offset	number	User timezone offset (in milliseconds), influence only "approved" field (defines whether operation is future).

Body

Name	Type	Description
externalId	string	unique operation identifier Default: `new uuid v4`
dateOfPayment	number	—
date	number	Date of operation Default: `current date in utc`
comment	string	—
invoiceNumber *	string	invoice number
invoiceCompanyId *	string	id of invoice company
supplierId *	string	id of supplier (or client)
invoiceCompanyDetails *	string	information about my props
supplierDetails *	string	information about counterparty
goods *	array	array with information about goods
invoiceCurrency *	string	Currency
confirmedInvoice	boolean	confirmed invoice status
shipping	number	—
discountPercentage	number	Discount percentage (can used only discountPercentage or discountAmount)
discountAmount	number	Discount amount (can used only discountPercentage or discountAmount)
attachmentId	string	Attachment id of null

Response

200 Updated.

Name	Type	Description
status *	string	—
statusCode *	string	—

patch /v2.2/invoices/{id}

URL

/v2.2/invoices/69d7bbfc5f10c3ed05c6bb3d?offset=7200000

Request body

{
  "externalId": "5faa9f57-1229-4d31-9d73-7b704b129f46",
  "dateOfPayment": 1775918844048,
  "date": 1775746044048,
  "comment": "Test API",
  "invoiceNumber": "ExampleInvoice123456",
  "invoiceCompanyId": "63a0acd05fd26f3fa73fef4f",
  "supplierId": "63a0acd05fd26f7d203fef3f",
  "invoiceCompanyDetails": "company details (IBAN)",
  "supplierDetails": "counterparty details (IBAN)",
  "goods": [
    {
      "id": "63a01aa80e714d7a683b3ea4",
      "count": 10,
      "price": 10.1,
      "vat": 3
    }
  ],
  "invoiceCurrency": "UAH",
  "confirmedInvoice": false,
  "shipping": 100,
  "discountPercentage": 25,
  "discountAmount": 100,
  "attachmentId": null
}

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Delete operation by id

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

Name	Type	Description
status *	string	—
statusCode *	string	—

delete /v2.2/invoices/{id}

URL

/v2.2/invoices/69d7bbfc5f10c3ed05c6bb3d

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Update operation by externalId

Request

Path

Name	Type	Description
id *	string	—

Query

Name	Type	Description
offset	number	User timezone offset (in milliseconds), influence only "approved" field (defines whether operation is future).

Body

Name	Type	Description
externalId	string	unique operation identifier Default: `new uuid v4`
dateOfPayment	number	—
date	number	Date of operation Default: `current date in utc`
comment	string	—
invoiceNumber *	string	invoice number
invoiceCompanyId *	string	id of invoice company
supplierId *	string	id of supplier (or client)
invoiceCompanyDetails *	string	information about my props
supplierDetails *	string	information about counterparty
goods *	array	array with information about goods
invoiceCurrency *	string	Currency
confirmedInvoice	boolean	confirmed invoice status
shipping	number	—
discountPercentage	number	Discount percentage (can used only discountPercentage or discountAmount)
discountAmount	number	Discount amount (can used only discountPercentage or discountAmount)
attachmentId	string	Attachment id of null

Response

200 Updated.

Name	Type	Description
status *	string	—
statusCode *	string	—

patch /v2.2/invoices/byExternalId/{id}

URL

/v2.2/invoices/byExternalId/08bdf649-f448-4b88-9d2b-54050445de26?offset=7200000

Request body

{
  "externalId": "5faa9f57-1229-4d31-9d73-7b704b129f46",
  "dateOfPayment": 1775918844048,
  "date": 1775746044048,
  "comment": "Test API",
  "invoiceNumber": "ExampleInvoice123456",
  "invoiceCompanyId": "63a0acd05fd26f3fa73fef4f",
  "supplierId": "63a0acd05fd26f7d203fef3f",
  "invoiceCompanyDetails": "company details (IBAN)",
  "supplierDetails": "counterparty details (IBAN)",
  "goods": [
    {
      "id": "63a01aa80e714d7a683b3ea4",
      "count": 10,
      "price": 10.1,
      "vat": 3
    }
  ],
  "invoiceCurrency": "UAH",
  "confirmedInvoice": false,
  "shipping": 100,
  "discountPercentage": 25,
  "discountAmount": 100,
  "attachmentId": null
}

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

Delete operation by externalId

Request

Path

Name	Type	Description
id *	string	—

Response

200 Deleted.

Name	Type	Description
status *	string	—
statusCode *	string	—

delete /v2.2/invoices/byExternalId/{id}

URL

/v2.2/invoices/byExternalId/08bdf649-f448-4b88-9d2b-54050445de26

Response (200)

{
  "status": "Processed now",
  "statusCode": "1"
}

200 Success

{
  "status": "Processed now",
  "statusCode": "1"
}

400 Error

(no example)

Success (200) schema

status string

Processed nowStoredErrorIn the queue for processing

statusCode string

1230

Error (400) schema

—

invoices/goods

Get all invoice goods

Response

200 List of invoice goods

get /v2.2/invoices/goods

Response (200)

[
  {
    "id": "string",
    "label": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string"
  }
]

401 Error

(no example)

Success (200) schema

(array)

Error (401) schema

—

Create new invoice good

Request

Body

Name	Type	Description
label *	string	name of good

Response

201 Created invoice good

Name	Type	Description
id *	string	—
label *	string	—

post /v2.2/invoices/goods

Request body

{
  "label": "good1"
}

Response (201)

{
  "id": "string",
  "label": "string"
}

201 Success

{
  "id": "string",
  "label": "string"
}

401 Error

(no example)

Success (201) schema

id string

label string

Error (401) schema

—

Patch one invoice good

Request

Path

Name	Type	Description
id *	string	Invoice good id

Body

Name	Type	Description
label *	string	name of good

Response

200 Updated invoice good

Name	Type	Description
id *	string	—
label *	string	—

patch /v2.2/invoices/goods/{id}

URL

/v2.2/invoices/goods/69d7bbfc5f10c3ed05c6bb47

Request body

{
  "label": "good1"
}

Response (200)

{
  "id": "string",
  "label": "string"
}

200 Success

{
  "id": "string",
  "label": "string"
}

401 Error

(no example)

Success (200) schema

id string

label string

Error (401) schema

—

Delete one invoice good

Request

Path

Name	Type	Description
id *	string	Invoice good id

Response

200 Deleted invoice good

Name	Type	Description
id *	string	—
label *	string	—

delete /v2.2/invoices/goods/{id}

URL

/v2.2/invoices/goods/69d7bbfc5f10c3ed05c6bb47

Response (200)

{
  "id": "string",
  "label": "string"
}

200 Success

{
  "id": "string",
  "label": "string"
}

401 Error

(no example)

Success (200) schema

id string

label string

Error (401) schema

—

invoices/companies

Get all invoice companies

Response

200 List of invoice company

get /v2.2/invoices/companies

Response (200)

[
  {
    "id": "string",
    "label": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string"
  }
]

401 Error

(no example)

Success (200) schema

(array)

Error (401) schema

—

Create new invoice companies

Request

Body

Name	Type	Description
label *	string	name of invoice company

Response

201 Created invoice company

Name	Type	Description
id *	string	—
label *	string	—

post /v2.2/invoices/companies

Request body

{
  "label": "myCompany"
}

Response (201)

{
  "id": "string",
  "label": "string"
}

201 Success

{
  "id": "string",
  "label": "string"
}

401 Error

(no example)

Success (201) schema

id string

label string

Error (401) schema

—

Patch one invoice company

Request

Path

Name	Type	Description
id *	string	Invoice company id

Body

Name	Type	Description
label *	string	name of invoice company

Response

200 Updated invoice company

Name	Type	Description
id *	string	—
label *	string	—

patch /v2.2/invoices/companies/{id}

URL

/v2.2/invoices/companies/69d7bbfc5f10c3ed05c6bb48

Request body

{
  "label": "myCompany"
}

Response (200)

{
  "id": "string",
  "label": "string"
}

200 Success

{
  "id": "string",
  "label": "string"
}

401 Error

(no example)

Success (200) schema

id string

label string

Error (401) schema

—

Delete one invoice company

Request

Path

Name	Type	Description
id *	string	Invoice company id

Response

200 Deleted invoice company

Name	Type	Description
id *	string	—
label *	string	—

delete /v2.2/invoices/companies/{id}

URL

/v2.2/invoices/companies/69d7bbfc5f10c3ed05c6bb48

Response (200)

{
  "id": "string",
  "label": "string"
}

200 Success

{
  "id": "string",
  "label": "string"
}

401 Error

(no example)

Success (200) schema

id string

label string

Error (401) schema

—

attachment

Get all attachments

Response

200 List of attachments

get /v2.2/attachment

Response (200)

[
  {
    "id": "string",
    "label": "string"
  }
]

200 Success

[
  {
    "id": "string",
    "label": "string"
  }
]

401 Error

(no example)

Success (200) schema

(array)

Error (401) schema

—

Create new attachment

Response

201 Created attachment

Name	Type	Description
id *	string	—
label *	string	—

post /v2.2/attachment

Response (201)

{
  "id": "string",
  "label": "string"
}

201 Success

{
  "id": "string",
  "label": "string"
}

401 Error

(no example)

Success (201) schema

id string

label string

Error (401) schema

—

Patch one attachment

Request

Path

Name	Type	Description
id *	string	Attachment id

Body

Name	Type	Description
label *	string	name of file

Response

200 Updated attachment

Name	Type	Description
id *	string	—
label *	string	—

patch /v2.2/attachment/{id}

URL

/v2.2/attachment/69d7bbfc5f10c3ed05c6bb49

Request body

{
  "label": "myLogo1.png"
}

Response (200)

{
  "id": "string",
  "label": "string"
}

200 Success

{
  "id": "string",
  "label": "string"
}

401 Error

(no example)

Success (200) schema

id string

label string

Error (401) schema

—

Delete one attachment

Request

Path

Name	Type	Description
id *	string	Attachment id

Response

200 Deleted attachment

Name	Type	Description
id *	string	—
label *	string	—

delete /v2.2/attachment/{id}

URL

/v2.2/attachment/69d7bbfc5f10c3ed05c6bb49

Response (200)

{
  "id": "string",
  "label": "string"
}

200 Success

{
  "id": "string",
  "label": "string"
}

401 Error

(no example)

Success (200) schema

id string

label string

Error (401) schema

—

operations

Request

Query

Name	Type	Description
externalId	string	Id of operation
id	string	Id of operation

Response

200 Finded operation by id or externalId

Name	Type	Description
list *	array	List of operations
total *	number	The number of operations in the company

get /v2.2/operations/details

URL

/v2.2/operations/details?externalId=bd8ac66f-6411-4f61-9178-d80b3343f41e&id=69d7bbfc5f10c3ed05c6bb3e

Response (200)

{
  "list": [
    {
      "id": "66f3e9f007ca6836d3afbd1e",
      "operationId": "66f3e9f007ca6836d3afbd1e",
      "hasPartial": true,
      "hasCategoryPartial": true,
      "isPartial": false,
      "isCategoryPartial": false,
      "date": 1727271757115,
      "sum": 200,
      "type": "expense",
      "subType": "dividend",
      "exchangeRate": 1,
      "accountToName": "",
      "categoryId": "66f305dc845d643553572739",
      "accountFromName": "Bank account",
      "accountFromId": "66f305dc845d643553572735",
      "accountToId": "66f305dc845d643553572721",
      "approved": true,
      "comment": "some comment",
      "counterpartyId": "66f3e9b114953ceae2e5f6bf",
      "counterpartyName": "Owner 1",
      "currencyId": "UAH",
      "currencySymbol": "₴",
      "dateOfPayment": 1727271757722,
      "companyCurrencySum": 200,
      "tagIds": [
        "66f3e9c8845d643553572885",
        "66f3e9c8845d643553572886"
      ],
      "tags": "tag1,tag2",
      "projects": "project 1,project 2",
      "projectIds": [
        "66f3e9eb4d98c781f16a4fe9",
        "66f3e9eb4d98c781f16a4fe8"
      ],
      "accountName": "Bank account",
      "updatedAt": "2024-09-25T10:46:08.730Z",
      "transactionSum": 200,
      "transactionCurrency": "UAH",
      "transactionCurrencyRate": 1,
      "projectObjects": [
        {
          "stake": 51,
          "sum": 102,
          "transactionSum": 102,
          "companyCurrencySum": 102,
          "id": "66f3e9eb4d98c781f16a4fe8",
          "label": "project 1"
        },
        {
          "stake": 49,
          "sum": 98,
          "transactionSum": 98,
          "companyCurrencySum": 98,
          "id": "66f3e9eb4d98c781f16a4fe9",
          "label": "project 2"
        }
      ],
      "hasProjectSumError": false,
      "hasDeletedProject": false,
      "accountBalanceAfterOperation": -1245.56,
      "categoryName": "Dividends",
      "periodStartTimestamp": 1722470400000,
      "periodEndTimestamp": 1725148799999,
      "externalId": "5083b99b-d1f3-4793-b6e2-20168121c3c3"
    }
  ],
  "total": 3845
}

200 Success

{
  "list": [
    {
      "id": "66f3e9f007ca6836d3afbd1e",
      "operationId": "66f3e9f007ca6836d3afbd1e",
      "hasPartial": true,
      "hasCategoryPartial": true,
      "isPartial": false,
      "isCategoryPartial": false,
      "date": 1727271757115,
      "sum": 200,
      "type": "expense",
      "subType": "dividend",
      "exchangeRate": 1,
      "accountToName": "",
      "categoryId": "66f305dc845d643553572739",
      "accountFromName": "Bank account",
      "accountFromId": "66f305dc845d643553572735",
      "accountToId": "66f305dc845d643553572721",
      "approved": true,
      "comment": "some comment",
      "counterpartyId": "66f3e9b114953ceae2e5f6bf",
      "counterpartyName": "Owner 1",
      "currencyId": "UAH",
      "currencySymbol": "₴",
      "dateOfPayment": 1727271757722,
      "companyCurrencySum": 200,
      "tagIds": [
        "66f3e9c8845d643553572885",
        "66f3e9c8845d643553572886"
      ],
      "tags": "tag1,tag2",
      "projects": "project 1,project 2",
      "projectIds": [
        "66f3e9eb4d98c781f16a4fe9",
        "66f3e9eb4d98c781f16a4fe8"
      ],
      "accountName": "Bank account",
      "updatedAt": "2024-09-25T10:46:08.730Z",
      "transactionSum": 200,
      "transactionCurrency": "UAH",
      "transactionCurrencyRate": 1,
      "projectObjects": [
        {
          "stake": 51,
          "sum": 102,
          "transactionSum": 102,
          "companyCurrencySum": 102,
          "id": "66f3e9eb4d98c781f16a4fe8",
          "label": "project 1"
        },
        {
          "stake": 49,
          "sum": 98,
          "transactionSum": 98,
          "companyCurrencySum": 98,
          "id": "66f3e9eb4d98c781f16a4fe9",
          "label": "project 2"
        }
      ],
      "hasProjectSumError": false,
      "hasDeletedProject": false,
      "accountBalanceAfterOperation": -1245.56,
      "categoryName": "Dividends",
      "periodStartTimestamp": 1722470400000,
      "periodEndTimestamp": 1725148799999,
      "externalId": "5083b99b-d1f3-4793-b6e2-20168121c3c3"
    }
  ],
  "total": 3845
}

400 Error

(no example)

Success (200) schema

list string[] List of operations

total number The number of operations in the company

Error (400) schema

—

Request

Body

Name	Type	Description
operationIds	array	—
projectIds	array	—
search	string	—
tagIds	array	—
counterpartyIds	array	—
accountIds	array	—
limit	number	Number of operations in list Default: `100`
offset	number	—
approved	boolean	—
startDate	number	—
endDate	number	—
sumFrom	number	—
sumTo	number	—
desc	boolean	—
field	string	—
desc1	boolean	—
field1	string	—
desc2	boolean	—
field2	string	—
desc3	boolean	—
useDateOfPayment	boolean	—
field3	string	—
calculateAccountState	boolean	—
ids	array	—
select	array	Field names to return, e.g. ["date","sum","type","categoryName"]
types	array	—
categoryIds	array	—

Response

200 A list of operations has been created.

Name	Type	Description
list *	array	List of operations
total *	number	The number of operations in the company

post /v2.2/operations/list

Request body

{
  "operationIds": [
    "69d7bbfc5f10c3ed05c6bb34"
  ],
  "projectIds": [
    "69d7bbfc5f10c3ed05c6bb42"
  ],
  "search": "string",
  "tagIds": [
    "69d7bbfc5f10c3ed05c6bb43"
  ],
  "counterpartyIds": [
    "69d7bbfc5f10c3ed05c6bb44"
  ],
  "accountIds": [
    "69d7bbfc5f10c3ed05c6bb40"
  ],
  "limit": 25,
  "offset": 0,
  "approved": true,
  "startDate": 1775746044042,
  "endDate": 1775746044042,
  "sumFrom": 121,
  "sumTo": 312,
  "desc": true,
  "field": "date",
  "desc1": true,
  "field1": "date",
  "desc2": true,
  "field2": "date",
  "desc3": true,
  "useDateOfPayment": true,
  "field3": "date",
  "calculateAccountState": true,
  "ids": [
    "69d7bbfc5f10c3ed05c6bb3f"
  ],
  "select": [
    "operationId"
  ],
  "types": [
    "income"
  ],
  "categoryIds": [
    "69d7bbfc5f10c3ed05c6bb41"
  ]
}

Response (200)

{
  "list": [
    {
      "id": "66f3e9f007ca6836d3afbd1e",
      "operationId": "66f3e9f007ca6836d3afbd1e",
      "hasPartial": true,
      "hasCategoryPartial": true,
      "isPartial": false,
      "isCategoryPartial": false,
      "date": 1727271757115,
      "sum": 200,
      "type": "expense",
      "subType": "dividend",
      "exchangeRate": 1,
      "accountToName": "",
      "categoryId": "66f305dc845d643553572739",
      "accountFromName": "Bank account",
      "accountFromId": "66f305dc845d643553572735",
      "accountToId": "66f305dc845d643553572721",
      "approved": true,
      "comment": "some comment",
      "counterpartyId": "66f3e9b114953ceae2e5f6bf",
      "counterpartyName": "Owner 1",
      "currencyId": "UAH",
      "currencySymbol": "₴",
      "dateOfPayment": 1727271757722,
      "companyCurrencySum": 200,
      "tagIds": [
        "66f3e9c8845d643553572885",
        "66f3e9c8845d643553572886"
      ],
      "tags": "tag1,tag2",
      "projects": "project 1,project 2",
      "projectIds": [
        "66f3e9eb4d98c781f16a4fe9",
        "66f3e9eb4d98c781f16a4fe8"
      ],
      "accountName": "Bank account",
      "updatedAt": "2024-09-25T10:46:08.730Z",
      "transactionSum": 200,
      "transactionCurrency": "UAH",
      "transactionCurrencyRate": 1,
      "projectObjects": [
        {
          "stake": 51,
          "sum": 102,
          "transactionSum": 102,
          "companyCurrencySum": 102,
          "id": "66f3e9eb4d98c781f16a4fe8",
          "label": "project 1"
        },
        {
          "stake": 49,
          "sum": 98,
          "transactionSum": 98,
          "companyCurrencySum": 98,
          "id": "66f3e9eb4d98c781f16a4fe9",
          "label": "project 2"
        }
      ],
      "hasProjectSumError": false,
      "hasDeletedProject": false,
      "accountBalanceAfterOperation": -1245.56,
      "categoryName": "Dividends",
      "periodStartTimestamp": 1722470400000,
      "periodEndTimestamp": 1725148799999,
      "externalId": "5083b99b-d1f3-4793-b6e2-20168121c3c3"
    }
  ],
  "total": 3845
}

200 Success

{
  "list": [
    {
      "id": "66f3e9f007ca6836d3afbd1e",
      "operationId": "66f3e9f007ca6836d3afbd1e",
      "hasPartial": true,
      "hasCategoryPartial": true,
      "isPartial": false,
      "isCategoryPartial": false,
      "date": 1727271757115,
      "sum": 200,
      "type": "expense",
      "subType": "dividend",
      "exchangeRate": 1,
      "accountToName": "",
      "categoryId": "66f305dc845d643553572739",
      "accountFromName": "Bank account",
      "accountFromId": "66f305dc845d643553572735",
      "accountToId": "66f305dc845d643553572721",
      "approved": true,
      "comment": "some comment",
      "counterpartyId": "66f3e9b114953ceae2e5f6bf",
      "counterpartyName": "Owner 1",
      "currencyId": "UAH",
      "currencySymbol": "₴",
      "dateOfPayment": 1727271757722,
      "companyCurrencySum": 200,
      "tagIds": [
        "66f3e9c8845d643553572885",
        "66f3e9c8845d643553572886"
      ],
      "tags": "tag1,tag2",
      "projects": "project 1,project 2",
      "projectIds": [
        "66f3e9eb4d98c781f16a4fe9",
        "66f3e9eb4d98c781f16a4fe8"
      ],
      "accountName": "Bank account",
      "updatedAt": "2024-09-25T10:46:08.730Z",
      "transactionSum": 200,
      "transactionCurrency": "UAH",
      "transactionCurrencyRate": 1,
      "projectObjects": [
        {
          "stake": 51,
          "sum": 102,
          "transactionSum": 102,
          "companyCurrencySum": 102,
          "id": "66f3e9eb4d98c781f16a4fe8",
          "label": "project 1"
        },
        {
          "stake": 49,
          "sum": 98,
          "transactionSum": 98,
          "companyCurrencySum": 98,
          "id": "66f3e9eb4d98c781f16a4fe9",
          "label": "project 2"
        }
      ],
      "hasProjectSumError": false,
      "hasDeletedProject": false,
      "accountBalanceAfterOperation": -1245.56,
      "categoryName": "Dividends",
      "periodStartTimestamp": 1722470400000,
      "periodEndTimestamp": 1725148799999,
      "externalId": "5083b99b-d1f3-4793-b6e2-20168121c3c3"
    }
  ],
  "total": 3845
}

401 Error

(no example)

Success (200) schema

list string[] List of operations

total number The number of operations in the company

Error (401) schema

—

Request

Query

Name	Type	Description
externalId	string	Id of operation
id	string	Id of operation

Response

200 Finded invoice by id or externalId

Name	Type	Description
list *	array	List of operations
total *	number	The number of invoices in the company

get /v2.2/operations/invoices/details

URL

/v2.2/operations/invoices/details?externalId=bd8ac66f-6411-4f61-9178-d80b3343f41e&id=69d7bbfc5f10c3ed05c6bb3e

Response (200)

{
  "list": [
    {
      "id": "66f3e9f007ca6836d3afbd1e",
      "date": 1727271757115,
      "sum": 200,
      "exchangeRate": 1,
      "approved": true,
      "comment": "some comment",
      "counterpartyId": "66f3e9b114953ceae2e5f6bf",
      "counterpartyName": "Owner 1",
      "currencyId": "UAH",
      "currencySymbol": "₴",
      "dateOfPayment": 1727271757722,
      "companyCurrencySum": 200,
      "updatedAt": "2024-09-25T10:46:08.730Z",
      "transactionSum": 200,
      "transactionCurrency": "UAH",
      "transactionCurrencyRate": 1,
      "externalId": "5083b99b-d1f3-4793-b6e2-20168121c3c3",
      "invoiceCompanyId": "669df83d8ab365560ad987bd",
      "invoiceNumber": "ExampleInvoice123456 2",
      "invoiceCompanyDetails": "company details (IBAN)",
      "counterpartyDetails": "counterparty details (IBAN)",
      "withVAT": true,
      "invoiceCurrency": "USD",
      "shipping": 12,
      "attachment": {
        "label": "MTB.png",
        "id": "66fff333888b8956a4ba1cbd"
      },
      "discountPercentage": 30,
      "discountAmount": null,
      "invoiceGoods": [
        {
          "price": 10.1,
          "count": 15,
          "sum": 115.5,
          "vat": 3,
          "id": "66f645aa0adf1c67df90def2",
          "label": "good2"
        },
        {
          "price": 12,
          "count": 12,
          "sum": 144,
          "vat": 3,
          "id": "669df8513299631e02d82476",
          "label": "послуга 1"
        }
      ],
      "confirmedInvoice": false
    }
  ],
  "total": 3845
}

200 Success

{
  "list": [
    {
      "id": "66f3e9f007ca6836d3afbd1e",
      "date": 1727271757115,
      "sum": 200,
      "exchangeRate": 1,
      "approved": true,
      "comment": "some comment",
      "counterpartyId": "66f3e9b114953ceae2e5f6bf",
      "counterpartyName": "Owner 1",
      "currencyId": "UAH",
      "currencySymbol": "₴",
      "dateOfPayment": 1727271757722,
      "companyCurrencySum": 200,
      "updatedAt": "2024-09-25T10:46:08.730Z",
      "transactionSum": 200,
      "transactionCurrency": "UAH",
      "transactionCurrencyRate": 1,
      "externalId": "5083b99b-d1f3-4793-b6e2-20168121c3c3",
      "invoiceCompanyId": "669df83d8ab365560ad987bd",
      "invoiceNumber": "ExampleInvoice123456 2",
      "invoiceCompanyDetails": "company details (IBAN)",
      "counterpartyDetails": "counterparty details (IBAN)",
      "withVAT": true,
      "invoiceCurrency": "USD",
      "shipping": 12,
      "attachment": {
        "label": "MTB.png",
        "id": "66fff333888b8956a4ba1cbd"
      },
      "discountPercentage": 30,
      "discountAmount": null,
      "invoiceGoods": [
        {
          "price": 10.1,
          "count": 15,
          "sum": 115.5,
          "vat": 3,
          "id": "66f645aa0adf1c67df90def2",
          "label": "good2"
        },
        {
          "price": 12,
          "count": 12,
          "sum": 144,
          "vat": 3,
          "id": "669df8513299631e02d82476",
          "label": "послуга 1"
        }
      ],
      "confirmedInvoice": false
    }
  ],
  "total": 3845
}

400 Error

(no example)

Success (200) schema

list string[] List of operations

total number The number of invoices in the company

Error (400) schema

—

Request

Body

Name	Type	Description
ids	array	—
limit	number	Number of operations in list Default: `100`
counterpartyIds	array	—
offset	number	—
approved	boolean	—
startDate	number	—
endDate	number	—
desc	boolean	—
field	string	—
desc1	boolean	—
field1	string	—
desc2	boolean	—
field2	string	—
desc3	boolean	—
field3	string	—
confirmedInvoice	boolean	—
invoiceStatus	string	—

Response

200 A list of invoices has been created.

Name	Type	Description
list *	array	List of operations
total *	number	The number of invoices in the company

post /v2.2/operations/invoices/list

Request body

{
  "ids": [
    "69d7bbfc5f10c3ed05c6bb45"
  ],
  "limit": 25,
  "counterpartyIds": [
    "69d7bbfc5f10c3ed05c6bb46"
  ],
  "offset": 0,
  "approved": true,
  "startDate": 1775746044062,
  "endDate": 1775746044062,
  "desc": true,
  "field": "date",
  "desc1": true,
  "field1": "date",
  "desc2": true,
  "field2": "date",
  "desc3": true,
  "field3": "date",
  "confirmedInvoice": true,
  "invoiceStatus": "overdue"
}

Response (200)

{
  "list": [
    {
      "id": "66f3e9f007ca6836d3afbd1e",
      "date": 1727271757115,
      "sum": 200,
      "exchangeRate": 1,
      "approved": true,
      "comment": "some comment",
      "counterpartyId": "66f3e9b114953ceae2e5f6bf",
      "counterpartyName": "Owner 1",
      "currencyId": "UAH",
      "currencySymbol": "₴",
      "dateOfPayment": 1727271757722,
      "companyCurrencySum": 200,
      "updatedAt": "2024-09-25T10:46:08.730Z",
      "transactionSum": 200,
      "transactionCurrency": "UAH",
      "transactionCurrencyRate": 1,
      "externalId": "5083b99b-d1f3-4793-b6e2-20168121c3c3",
      "invoiceCompanyId": "669df83d8ab365560ad987bd",
      "invoiceNumber": "ExampleInvoice123456 2",
      "invoiceCompanyDetails": "company details (IBAN)",
      "counterpartyDetails": "counterparty details (IBAN)",
      "withVAT": true,
      "invoiceCurrency": "USD",
      "shipping": 12,
      "attachment": {
        "label": "MTB.png",
        "id": "66fff333888b8956a4ba1cbd"
      },
      "discountPercentage": 30,
      "discountAmount": null,
      "invoiceGoods": [
        {
          "price": 10.1,
          "count": 15,
          "sum": 115.5,
          "vat": 3,
          "id": "66f645aa0adf1c67df90def2",
          "label": "good2"
        },
        {
          "price": 12,
          "count": 12,
          "sum": 144,
          "vat": 3,
          "id": "669df8513299631e02d82476",
          "label": "послуга 1"
        }
      ],
      "confirmedInvoice": false
    }
  ],
  "total": 3845
}

200 Success

{
  "list": [
    {
      "id": "66f3e9f007ca6836d3afbd1e",
      "date": 1727271757115,
      "sum": 200,
      "exchangeRate": 1,
      "approved": true,
      "comment": "some comment",
      "counterpartyId": "66f3e9b114953ceae2e5f6bf",
      "counterpartyName": "Owner 1",
      "currencyId": "UAH",
      "currencySymbol": "₴",
      "dateOfPayment": 1727271757722,
      "companyCurrencySum": 200,
      "updatedAt": "2024-09-25T10:46:08.730Z",
      "transactionSum": 200,
      "transactionCurrency": "UAH",
      "transactionCurrencyRate": 1,
      "externalId": "5083b99b-d1f3-4793-b6e2-20168121c3c3",
      "invoiceCompanyId": "669df83d8ab365560ad987bd",
      "invoiceNumber": "ExampleInvoice123456 2",
      "invoiceCompanyDetails": "company details (IBAN)",
      "counterpartyDetails": "counterparty details (IBAN)",
      "withVAT": true,
      "invoiceCurrency": "USD",
      "shipping": 12,
      "attachment": {
        "label": "MTB.png",
        "id": "66fff333888b8956a4ba1cbd"
      },
      "discountPercentage": 30,
      "discountAmount": null,
      "invoiceGoods": [
        {
          "price": 10.1,
          "count": 15,
          "sum": 115.5,
          "vat": 3,
          "id": "66f645aa0adf1c67df90def2",
          "label": "good2"
        },
        {
          "price": 12,
          "count": 12,
          "sum": 144,
          "vat": 3,
          "id": "669df8513299631e02d82476",
          "label": "послуга 1"
        }
      ],
      "confirmedInvoice": false
    }
  ],
  "total": 3845
}

401 Error

(no example)

Success (200) schema

list string[] List of operations

total number The number of invoices in the company

Error (401) schema

—