Skip to main content

Monitr API (1.2.0)

Download OpenAPI specification:Download

Monitr's API

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Budgets

Get a list of budget types

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "budgetTypes": [
    ]
}

Get a list of budget versions

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
https://monitr.be/budget/type.schema.json (string) or Array of https://monitr.be/budget/type.schema.json (strings)

Responses

Set the list of budget versions

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
Array of objects[ items ]
Array
id
required
string
original_id
required
string
name
required
string
budget_type
required
string (https://monitr.be/budget/type.schema.json)
Enum: "budget" "nwc_unwinding" "nwc_budget" "crm" "personnel_costs" "recurring_revenue" "vat"
initial
required
boolean
active
required
boolean
comment
string
settings
required
object

Responses

Request samples

Content type
application/json
{
  • "budgetVersions": [
    ]
}

Create a new budget version

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
object
name
required
string
initial
boolean
Default: false
budget_type
required
string (https://monitr.be/budget/type.schema.json)
Enum: "budget" "nwc_unwinding" "nwc_budget" "crm" "personnel_costs" "recurring_revenue" "vat"
active
boolean
Default: false
comment
string
referenceBudgetVersion
string
referenceDate
string <date>
integration_id
string <uuid>
settings
object

Responses

Request samples

Content type
application/json
{
  • "budgetVersion": {
    }
}

Create a new NWC Unwinding budget version

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
name
required
string
reference_date
required
string <date>
required
Array of objects non-empty [ items ]
required
Array of objects non-empty [ items ]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reference_date": "2019-08-24",
  • "budgets": [
    ],
  • "outstanding_items": [
    ]
}

Create a new VAT budget version

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
name
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "settings": {
    }
}

Update the config of an existing VAT budget version

Authorizations:
path Parameters
entityId
required
string <uuid>
budgetVersionId
required
string
Request Body schema: application/json
object or object
Array of objects[ items ]
Array of objects non-empty [ items ]

Responses

Request samples

Content type
application/json
{
  • "general": {
    },
  • "rates": [
    ],
  • "periods": [
    ]
}

Get the settings for a VAT budget version

Authorizations:
path Parameters
entityId
required
string <uuid>
budgetVersionId
required
string
query Parameters
any or Array of any

Responses

Response samples

Content type
application/json
{
  • "general": {
    },
  • "rates": [
    ],
  • "periods": [
    ]
}

Get a list of budget accounts

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
extended
required
boolean
Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set the list of budget accounts

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
Array
id
required
string
original_id
required
string or null
name
required
string
mapping_id
required
string
nwc_account_id
string or null
payment_term
number or null
comment
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get all the budgets for a specific business entity, optionally filtered by budget version

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
budget_version
string

Responses

Set all the budgets for a specific business entity

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
Array of objects[ items ]
Array
id
required
string
budget_account_id
required
string
budget_version_id
required
string
amount
required
integer
period
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "budgets": [
    ]
}

Get initial budgets by reporting line

Authorizations:
path Parameters
entityId
required
string <uuid>
lineId
required
string
query Parameters
report
required
string
Enum: "PL" "BS" "CF"
from
required
string <date>
to
required
string <date>
mappingId
string
axis
string or array
aggregation
string
Default: "month"
limit
number [ 1 .. 1000 ]
Default: 1000
offset
number >= 0
Default: 0
orderBy
string^([a-zA-Z-_]+):(ASC|DESC)$
Default: "date_period:ASC"

Responses

Get the budget settings for the NWC module

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Set the budget settings for the NWC module

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
Array of objects [ 1 .. 2 ] items [ items ]
Array ([ 1 .. 2 ] items)
type
required
string
Enum: "AR" "AP"
budget_account_id
required
string or null

Responses

Request samples

Content type
application/json
{
  • "settings": [
    ]
}

Get the products for a specific budget version

Authorizations:
path Parameters
entityId
required
string <uuid>
budgetVersionId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new recurring revenue budget version

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
Array of objects[ items ]
Array
id
required
string <uuid>
vendorId
required
string or null
name
required
string
description
required
string or null
unitCost
required
number or null
price
required
number or null
recurring
required
boolean
archived
required
boolean
entityId
required
string <uuid>
integrationId
required
string or null <uuid>
budgetAccountId
required
string or null
required
object

Responses

Request samples

Content type
application/json
{
  • "subscriptionModelProducts": [
    ]
}

Entity

Get details for a specific business entity

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Update an entity's details

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
YearToDateStart
string <date>
lastDateActuals
string <date>
YearToGoEnd
string <date>
axis
null or string
isDisabled
boolean

Responses

Request samples

Content type
application/json
{
  • "YearToDateStart": "2019-08-24",
  • "lastDateActuals": "2019-08-24",
  • "YearToGoEnd": "2019-08-24",
  • "axis": null,
  • "isDisabled": true
}

Update an entity's settings

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
exactImport
object
object

Responses

Request samples

Content type
application/json
{
  • "exactImport": { },
  • "company_settings": {
    }
}

Get the validation status of an entity

This endpoint will perform a set of validations to make sure your reports will be reliable.

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
from
required
string <date>
to
required
string <date>

Responses

Get a list of entities for a specific organisation that the user has access to

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Accounts

Get all general ledger accounts for a specific business entity

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an object of each entity in an organisation with its accounts

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Analytical Axes

Get all analytical axes for a specific business entity

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
axis
string <uuid>
used
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all axes for a specific business entity

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
used
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all analytical axes for a specific business entity

Authorizations:
path Parameters
orgId
required
string <uuid>
query Parameters
used
boolean

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

General Ledger

Get the general ledger entries for a specific business entity

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Get the unique years for which we have data in the general ledger for a specific business entity

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Get all general ledger transactions by relation id

Authorizations:
path Parameters
entityId
required
string <uuid>
relationId
required
string
query Parameters
report
string
Enum: "PL" "BS"

Responses

Get a list of transactions providing a general ledger account and an optional analytical axis Deprecated

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
account
required
string
analyticalAxis
string

Responses

Request samples

Content type
application/json
{
  • "account": "string",
  • "analyticalAxis": "string"
}

Get a list of general ledger account id and analytical axis id combinations from the general ledger Deprecated

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Get all transactions and budgets by optional reporting line

Authorizations:
path Parameters
entityId
required
string <uuid>
lineId
required
string
query Parameters
report
required
string
Enum: "PL" "BS" "CF"
reportType
required
string
Enum: "actuals" "forecast" "delta"
type
string
Enum: "general_ledger" "adjusting_entry"
from
required
string <date>
lda
required
string <date>
to
required
string <date>
mappingId
string
axis
string or array
selectedBudgetVersions
string or array
aggregation
string
Default: "month"
limit
number [ 1 .. 1000 ]
Default: 1000
offset
number >= 0
Default: 0
orderBy
string^([a-zA-Z-_]+):(ASC|DESC)$
Default: "date_period:ASC"
pivotColumn
string

Responses

Get all transactions and budgets by optional reporting line

Authorizations:
path Parameters
orgId
required
string <uuid>
lineId
required
string
query Parameters
report
required
string
Enum: "PL" "BS" "CF"
reportType
required
string
Enum: "actuals" "forecast" "delta"
from
required
string <date>
lda
required
string <date>
to
required
string <date>
mappingId
string
aggregation
string
Default: "month"
Enum: "year" "quarter" "month" "entity"
aggregationType
string
Enum: "period" "entity"
limit
number [ 1 .. 1000 ]
Default: 1000
offset
number >= 0
Default: 0
orderBy
string^([a-zA-Z-_]+):(ASC|DESC)$
Default: "date_period:ASC"
pivotColumn
string

Responses

Import

Import a CSV file into the general ledger for a specific business entity, updating the currect general ledger

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
object
required
object
delimiter
required
string [ 1 .. 4 ] characters
decimalSeparator
required
string 1 characters

Responses

Request samples

Content type
application/json
{
  • "replace": {
    },
  • "mapping": { },
  • "delimiter": "stri",
  • "decimalSeparator": "s"
}

Import a CSV file into the general ledger for a specific business entity, removing the currect general ledger data and inserting all data

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
object
required
object
delimiter
required
string [ 1 .. 4 ] characters
decimalSeparator
required
string 1 characters

Responses

Request samples

Content type
application/json
{
  • "replace": {
    },
  • "mapping": { },
  • "delimiter": "stri",
  • "decimalSeparator": "s"
}

Sync now with a specific entity

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Sync all data with HubSpot

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
integrationId
required
string <uuid>
Request Body schema: application/json
paymentDueDate
string

Responses

Request samples

Content type
application/json
{
  • "paymentDueDate": "string"
}

Sync all data with Teamleader

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
integrationId
required
string <uuid>
Request Body schema: application/json
paymentDueDate
string

Responses

Request samples

Content type
application/json
{
  • "paymentDueDate": "string"
}

Sync a Yuki integration for a specific organisation

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Sync an Exact Online integration for a specific organisation

Authorizations:
path Parameters
orgId
required
string <uuid>
query Parameters
entity
Array of strings or string

Responses

Sync an Octopus integration for a specific organisation

Authorizations:
path Parameters
orgId
required
string <uuid>
query Parameters
entity
Array of strings or string

Responses

Booking

Get a booking for a specific general ledger transaction

Authorizations:
path Parameters
entityId
required
string <uuid>
generalLedgerId
required
string

Responses

Get a booking's attachments for a specific general ledger transaction

Authorizations:
path Parameters
entityId
required
string <uuid>
generalLedgerId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the attachment for a booking as a binary file

Authorizations:
path Parameters
entityId
required
string <uuid>
generalLedgerId
required
string
attachmentId
required
string
query Parameters
token
required
string

Responses

Reporting Lines

Get a list of reporting lines for the cash flow report

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Set the list of reporting lines for the cash flow report

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
Array of objects[ items ]
Array
id
required
string
name
required
string
rank
required
integer >= 0
top
required
boolean
parent_id
null or string

Responses

Request samples

Content type
application/json
{
  • "cashFlowReportingLines": [
    ]
}

Get a list of reporting lines for the profit & loss and balance sheet reports

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Get a list of reporting lines with calculated top level for the profit & loss and balance sheet reports Deprecated

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Get a list of reporting lines for a specific report

Authorizations:
path Parameters
entityId
required
string <uuid>
report
required
string
Enum: "PL" "BS"
Example: PL

Responses

Set the list of reporting lines for a specific report

Authorizations:
path Parameters
entityId
required
string <uuid>
report
required
string
Enum: "PL" "BS"
Example: PL
Request Body schema: application/json
required
Array of objects[ items ]
Array
id
required
string
name
required
string
rank
required
integer >= 0
top
required
boolean
parent_id
null or string
cash_flow_reporting_line_id
null or string

Responses

Request samples

Content type
application/json
{
  • "reportingLines": [
    ]
}

Specify the reporting template you want to use, replaces all reporting configurations

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
object (https://monitr.be/template/reporting.schema.json)
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "template": {
    }
}

Get a list of reporting lines for the cash flow report

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Set the list of reporting lines for the cash flow report

Authorizations:
path Parameters
orgId
required
string <uuid>
Request Body schema: application/json
required
Array of objects[ items ]
Array
id
required
string
name
required
string
rank
required
integer >= 0
top
required
boolean
parent_id
required
null or string

Responses

Request samples

Content type
application/json
{
  • "cashFlowReportingLines": [
    ]
}

Get a list of reporting lines for the profit & loss and balance sheet reports

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Get a list of reporting lines for a specific report

Authorizations:
path Parameters
orgId
required
string <uuid>
report
required
string
Enum: "PL" "BS"
Example: PL

Responses

Set the list of reporting lines for a specific report

Authorizations:
path Parameters
orgId
required
string <uuid>
report
required
string
Enum: "PL" "BS"
Example: PL
Request Body schema: application/json
required
Array of objects[ items ]
Array
id
required
string
name
required
string
rank
required
integer >= 0
top
required
boolean
parent_id
required
null or string
cash_flow_reporting_line_id
required
null or string

Responses

Request samples

Content type
application/json
{
  • "reportingLines": [
    ]
}

Get a list of reporting lines with calculated top level for the profit & loss and balance sheet reports Deprecated

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Mappings

Get all mappings for a specific business entity

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Set all mappings for a specific business entity

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
Array of objects[ items ]
Array
account_id
required
string
account_number
required
string
analytical_axis_id
string
analytical_axis_account
string
organisation_reporting_line_id
string
reporting_line_id
required
string

Responses

Request samples

Content type
application/json
{
  • "mappings": [
    ]
}

Get all mappings for a specific business entity

Authorizations:
path Parameters
entityId
required
string <uuid>
reportingLineId
required
string

Responses

Consolidation

Set all mappings for a specific business entity

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
Array of objects[ items ]
Array
account_id
required
string
account_number
required
string
analytical_axis_id
string
analytical_axis_account
string
organisation_reporting_line_id
string
reporting_line_id
required
string

Responses

Request samples

Content type
application/json
{
  • "mappings": [
    ]
}

Get all relations from all entities

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Get a list of reporting lines for the cash flow report

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Set the list of reporting lines for the cash flow report

Authorizations:
path Parameters
orgId
required
string <uuid>
Request Body schema: application/json
required
Array of objects[ items ]
Array
id
required
string
name
required
string
rank
required
integer >= 0
top
required
boolean
parent_id
required
null or string

Responses

Request samples

Content type
application/json
{
  • "cashFlowReportingLines": [
    ]
}

Get a list of reporting lines for the profit & loss and balance sheet reports

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Get a list of reporting lines for a specific report

Authorizations:
path Parameters
orgId
required
string <uuid>
report
required
string
Enum: "PL" "BS"
Example: PL

Responses

Set the list of reporting lines for a specific report

Authorizations:
path Parameters
orgId
required
string <uuid>
report
required
string
Enum: "PL" "BS"
Example: PL
Request Body schema: application/json
required
Array of objects[ items ]
Array
id
required
string
name
required
string
rank
required
integer >= 0
top
required
boolean
parent_id
required
null or string
cash_flow_reporting_line_id
required
null or string

Responses

Request samples

Content type
application/json
{
  • "reportingLines": [
    ]
}

Get a list of reporting lines with calculated top level for the profit & loss and balance sheet reports Deprecated

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Set the list of adjusting entries for and organisation

Authorizations:
path Parameters
orgId
required
string <uuid>
Request Body schema: application/json
Array
id
required
string
datePeriod
required
string <date>
description
required
string
amount
required
number
entityIdFrom
required
string <uuid>
entityIdTo
required
string <uuid>
glAccountId
required
string
analyticalAxisId
required
string or null
createdBy
required
string or null <uuid>
required
object or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get the validation of your organisation consolidation

Authorizations:
path Parameters
orgId
required
string <uuid>
query Parameters
report
required
string
Enum: "PL" "BS"

Responses

Get a list of custom metrics

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Get a specific report by report type and view

Authorizations:
path Parameters
orgId
required
string <uuid>
report
required
string
Enum: "PL" "BS" "CF"
reportType
required
string
Enum: "actuals" "forecast" "delta"
query Parameters
from
required
string <date>
lda
required
string <date>
to
required
string <date>
aggregation
required
string
Enum: "year" "quarter" "month" "entity"
Example: aggregation=month
aggregationType
string
Enum: "period" "entity"
selectedDeltaComparison
string

Responses

Get the graph data for a specific report

Authorizations:
path Parameters
orgId
required
string <uuid>
report
required
string
Enum: "PL" "BS" "CF"
reportType
required
string
Enum: "actuals" "forecast" "delta"
query Parameters
from
required
string <date>
lda
required
string <date>
to
required
string <date>
selectedDeltaComparison
string
line
string
mappingId
string
aggregation
required
string
Enum: "year" "quarter" "month" "entity"
Example: aggregation=month
aggregationType
string
Enum: "period" "entity"
pivotColumn
string

Responses

Custom Metrics

Get a list of custom metrics

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Set the list of custom metrics

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
Array of objects[ items ]
Array
id
required
string <uuid>
name
required
string
reporting_line_id
required
string

Responses

Request samples

Content type
application/json
{
  • "customMetrics": [
    ]
}

Get a list of custom metrics

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Set the list of custom metrics

Authorizations:
path Parameters
orgId
required
string <uuid>
Request Body schema: application/json
required
Array of objects[ items ]
Array
id
required
string <uuid>
name
required
string
reporting_line_id
required
string

Responses

Request samples

Content type
application/json
{
  • "customMetrics": [
    ]
}

Adjusting Entries

Get a list of adjusting entries

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set the list of adjusting entries

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
Array
id
required
string
datePeriod
required
string <date>
description
required
string or null
glAccountId
required
string
analyticalAxisId
required
string or null
amount
required
number
createdBy
required
string or null <uuid>
axis
required
string or null <uuid>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get a list of adjusting entries

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set the list of adjusting entries for and organisation

Authorizations:
path Parameters
orgId
required
string <uuid>
Request Body schema: application/json
Array
id
required
string
datePeriod
required
string <date>
description
required
string
amount
required
number
entityIdFrom
required
string <uuid>
entityIdTo
required
string <uuid>
glAccountId
required
string
analyticalAxisId
required
string or null
createdBy
required
string or null <uuid>
required
object or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Outstanding Items

Get a list of all outstanding items by type

Authorizations:
path Parameters
entityId
required
string <uuid>
type
required
string
Enum: "receivable" "payable"
query Parameters
date
string <date>

Responses

Get a list of all due dates by type

Authorizations:
path Parameters
entityId
required
string <uuid>
type
required
string
Enum: "receivable" "payable"

Responses

Set custom due dates for a list of outstanding items

Note: The key in the map is the vendor identifier of the outstanding item

Authorizations:
path Parameters
entityId
required
string <uuid>
type
required
string
Enum: "receivable" "payable"
Request Body schema: application/json
object
due_date
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "0": {
    }
}

Remove a custom due date for a specific outstanding item by vendor id

Authorizations:
path Parameters
entityId
required
string <uuid>
type
required
string
Enum: "receivable" "payable"
vendorId
required
string

Responses

Products

Get a list of products for a specific business entity

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
lastUsed
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Associate budget accounts with products

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
Array of objects non-empty [ items ]
Array (non-empty)
id
required
string <uuid>
budgetAccountId
required
string or null

Responses

Request samples

Content type
application/json
{
  • "products": [
    ]
}

Get the products for a specific budget version

Authorizations:
path Parameters
entityId
required
string <uuid>
budgetVersionId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new recurring revenue budget version

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
Array of objects[ items ]
Array
id
required
string <uuid>
vendorId
required
string or null
name
required
string
description
required
string or null
unitCost
required
number or null
price
required
number or null
recurring
required
boolean
archived
required
boolean
entityId
required
string <uuid>
integrationId
required
string or null <uuid>
budgetAccountId
required
string or null
required
object

Responses

Request samples

Content type
application/json
{
  • "subscriptionModelProducts": [
    ]
}

Reporting

Get a specific report by report type

Authorizations:
path Parameters
entityId
required
string <uuid>
report
required
string
Enum: "PL" "BS" "CF"
reportType
required
string
Enum: "actuals" "forecast" "delta"
query Parameters
from
required
string <date>
lda
required
string <date>
to
required
string <date>
axis
string or array
required
string or string
aggregationType
any
Enum: "period" "analyticalAxis"
selectedDeltaComparison
string
selectedBudgetVersions
string or array
Array of strings or string

Responses

Get a specific report by report type and view

Authorizations:
path Parameters
orgId
required
string <uuid>
report
required
string
Enum: "PL" "BS" "CF"
reportType
required
string
Enum: "actuals" "forecast" "delta"
query Parameters
from
required
string <date>
lda
required
string <date>
to
required
string <date>
aggregation
required
string
Enum: "year" "quarter" "month" "entity"
Example: aggregation=month
aggregationType
string
Enum: "period" "entity"
selectedDeltaComparison
string

Responses

Graphs

Get the graph data for a specific report

Authorizations:
path Parameters
entityId
required
string <uuid>
report
required
string
Enum: "PL" "BS" "CF"
reportType
required
string
Enum: "actuals" "forecast" "delta"
query Parameters
from
required
string <date>
lda
required
string <date>
to
required
string <date>
axis
string or array
selectedDeltaComparison
string
selectedBudgetVersions
string or array
line
string
mappingId
string
aggregation
required
string
Enum: "year" "quarter" "month"
Example: aggregation=month
pivotColumn
string

Responses

Get the graph data for the KPI graph

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
from
required
string <date>
lda
required
string <date>
to
required
string <date>
aggregation
required
string
Enum: "year" "quarter" "month"
selectedComparison
string
selectedBudgetVersions
string or array
reportingLineIds
string or array
list
boolean

Responses

Get the graph data for the waterfall graph

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
from
required
string <date>
lda
required
string <date>
to
required
string <date>
selectedComparison
required
string
selectedBudgetVersions
string or array
reportingLineIds
string or array
list
required
boolean

Responses

Get the graph data for the percentage graph

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
from
required
string <date>
lda
required
string <date>
to
required
string <date>
aggregation
required
string
Enum: "year" "quarter" "month"
selectedBudgetVersions
string or array
reportingLineIds
string or array
list
required
boolean
selectedComparison
string

Responses

Get the graph data for a specific report

Authorizations:
path Parameters
orgId
required
string <uuid>
report
required
string
Enum: "PL" "BS" "CF"
reportType
required
string
Enum: "actuals" "forecast" "delta"
query Parameters
from
required
string <date>
lda
required
string <date>
to
required
string <date>
selectedDeltaComparison
string
line
string
mappingId
string
aggregation
required
string
Enum: "year" "quarter" "month" "entity"
Example: aggregation=month
aggregationType
string
Enum: "period" "entity"
pivotColumn
string

Responses

Integrations

Get custom fields from HubSpot

Authorizations:
path Parameters
entityId
required
string <uuid>
integrationId
required
string <uuid>

Responses

Get custom fields from Teamleader

Authorizations:
path Parameters
entityId
required
string <uuid>
integrationId
required
string <uuid>

Responses

Get a list of all integration providers that Monitr supports

Authorizations:

Responses

Get a list of active integrations for a specific organisation

Authorizations:
path Parameters
orgId
required
string <uuid>
query Parameters
category
Array of strings or string

A list of categories to filter on

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Yuki integration, using the Yuki API key as the credentials

Authorizations:
path Parameters
orgId
required
string <uuid>
Request Body schema: application/json
credentials
required
string

Responses

Request samples

Content type
application/json
{
  • "credentials": "string"
}

Create a new CSV integration

Authorizations:
path Parameters
orgId
required
string <uuid>
Request Body schema: application/json
credentials
required
string <uuid>
entityName
required
string

Responses

Request samples

Content type
application/json
{
  • "credentials": "868741d7-83dc-4432-9191-e0ae1fe1f6fe",
  • "entityName": "string"
}

Get details for a specific integration

Authorizations:
path Parameters
orgId
required
string <uuid>
integrationId
required
string <uuid>
type
required
any (def-4)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "integrationProviderId": "monitr",
  • "settings": { },
  • "entity": { },
  • "entities": [
    ],
  • "import": {
    },
  • "created_at": "2019-08-24T14:15:22Z"
}

Get a list of business entities for a specific integration

Authorizations:
path Parameters
orgId
required
string <uuid>
type
required
string
Enum: "exact" "yuki" "octopus"
integrationId
required
string <uuid>

Responses

Set the integration settings for a specific integration

Authorizations:
path Parameters
orgId
required
string <uuid>
type
required
string
Enum: "teamleader" "hubspot"
integrationId
required
string <uuid>
Request Body schema: application/json
budgetingType
required
string
Enum: "acrossProducts" "perProduct"
defaultBudgetAccount
string
property name*
any

Responses

Request samples

Content type
application/json
{
  • "budgetingType": "acrossProducts",
  • "defaultBudgetAccount": "string"
}

Templates

Get a list of available reporting templates from Exact

Authorizations:
path Parameters
entityId
required
string <uuid>
integrationId
required
string <uuid>

Responses

Get a list of available reporting templates

Authorizations:

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all templates for VAT periods for a given year

Authorizations:
query Parameters
year
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Budgets - Personnel

Get the latest departments and employees for a specific budget version

Authorizations:
path Parameters
entityId
required
string <uuid>
budgetVersionId
required
string

Responses

Get departments and employees for the current active budget version

Authorizations:
path Parameters
entityId
required
string <uuid>

Responses

Set the departments and employees for a specific budget version Deprecated

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
budgetVersionId
required
string
required
Array of objects[ items ]
required
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "budgetVersionId": "string",
  • "departments": [
    ],
  • "employees": [
    ]
}

Compare personnel costs with your actuals and budget

Authorizations:
path Parameters
entityId
required
string <uuid>
budgetComparison
required
string
Enum: "initial" "active"
query Parameters
from
required
string <date>
lda
required
string <date>
to
required
string <date>

Responses

Annotations

Create a new annotation

Authorizations:
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
content
required
string
reportingLineId
string
month
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "reportingLineId": "string",
  • "month": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "content": "string",
  • "createdBy": {
    },
  • "lastEditedBy": {
    },
  • "reportingLine": {
    },
  • "month": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get all annotations for a range of months

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
from
required
string <date>
to
required
string <date>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all global annotations and all annotations on the given reporting lines for a range of months

Returns all global and reporting line specific annotations in the period between the start and end month, grouped by the given reporting line IDs (global annotations are in the group where reportingLineId is null). Optionally includes annotations on descendant reporting lines.

Authorizations:
path Parameters
entityId
required
string <uuid>
query Parameters
from
required
string <date>
to
required
string <date>
required
string or Array of strings
includeDescendantReportingLines
required
boolean
Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update the content of an annotation

Authorizations:
path Parameters
entityId
required
string <uuid>
annotationId
required
string <uuid>
Request Body schema: application/json
content
required
string

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "content": "string",
  • "createdBy": {
    },
  • "lastEditedBy": {
    },
  • "reportingLine": {
    },
  • "month": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete an annotation

Authorizations:
path Parameters
entityId
required
string <uuid>
annotationId
required
string <uuid>

Responses

Organisations

Create a new organisation

Authorizations:
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Get details for a specific organisation

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Update details and settings for a specific organisation

Authorizations:
path Parameters
orgId
required
string <uuid>
Request Body schema: application/json
name
required
string
vatNumber
required
string or null >= 10 characters
required
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "vatNumber": "BE0755664444",
  • "settings": {
    }
}

Teams

Accept a team invite using an invite token

Authorizations:
path Parameters
orgId
required
string <uuid>
teamId
required
string <uuid>
Request Body schema: application/json
token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Get a list of teams for a specific organisation

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Create a new team

Authorizations:
path Parameters
orgId
required
string <uuid>
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Get a list of teams and their members for a specific organisation

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Get a list of teams and their entities for a specific organisation

Authorizations:
path Parameters
orgId
required
string <uuid>

Responses

Update a team

Authorizations:
path Parameters
orgId
required
string <uuid>
teamId
required
string <uuid>
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Delete a team

Authorizations:
path Parameters
orgId
required
string <uuid>
teamId
required
string <uuid>

Responses

Invite a user/email to a team

Authorizations:
path Parameters
orgId
required
string <uuid>
teamId
required
string <uuid>
Request Body schema: application/json
Array
string <email>

Responses