Skip to main content
API docs by Redocly

Monitr API (1.2.0)

Download OpenAPI specification:Download

Engineering Team: engineering@monitr.be Terms of Service

Monitr's API

Budgets

Get a list of budget types

Authorizations:
bearerAuth

Responses

Response samples

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

Get a list of budget versions

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

Responses

Delete a budget version

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

Responses

Create a new CRM budget version Deprecated

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
object
name
required
string [ 1 .. 255 ] characters
budget_type
required
string
Value: "crm"
active
boolean
integration_id
required
string <uuid>
comment
string [ 1 .. 255 ] characters
required
object or object
required
object or object

Responses

Request samples

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

Update a specific budget version

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
budgetVersionId
required
string <uuid>
Request Body schema: application/json
active
boolean
initial
boolean
name
string [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "initial": true,
  • "name": "string"
}

Create a new VAT budget version

Authorizations:
bearerAuth
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:
bearerAuth
path Parameters
entityId
required
string <uuid>
budgetVersionId
required
string <uuid>
Request Body schema: application/json
object or object
Array of objects
Array of objects non-empty

Responses

Request samples

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

Get the settings for a VAT budget version

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

Responses

Response samples

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

Create a new outstanding items budget version

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

Responses

Request samples

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

Update an outstanding items budget version

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

Responses

Request samples

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

Get outstanding items budget version settings

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

Responses

Response samples

Content type
application/json
{
  • "manualUnwindingItems": [
    ],
  • "automaticUnwindingSettings": {
    },
  • "forecastPaymentTerms": [
    ],
  • "unwindBudgetAccounts": {
    }
}

Get a list of budget accounts

Authorizations:
bearerAuth
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:
bearerAuth
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
Array
id
required
string
required
string or null
name
required
string
mapping_id
required
string
string or null
required
(https://monitr.be/budget/type.schema.json (https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (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:
bearerAuth
path Parameters
entityId
required
string <uuid>
query Parameters
required
string or Array of strings
required
string or null
required
string or null
required
string or null

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all the budget lines from a budget version for a specific budget account id

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
budgetVersionId
required
string <uuid>
query Parameters
required
Array of strings or string
startDate
required
string <date>
endDate
required
string <date>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get initial budgets by reporting line

Authorizations:
bearerAuth
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
Array of strings or arrays or string
limit
number [ 1 .. 1000 ]
Default: 1000
offset
number >= 0
Default: 0
orderBy
string^([a-zA-Z-_]+):(ASC|DESC)$
Default: "date_period:ASC"
Array of strings or string

Responses

Get the products for a specific budget version

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the products for a specific budget version

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the products for a specific budget version

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the products for a specific budget version

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the recurring revenue products by customer, product and subscription item

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
query Parameters
required
Array of strings or string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the PxQ v COGS dashboard information

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
query Parameters
required
Array of strings or string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the inventory dashboard information

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
query Parameters
required
Array of strings or string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the monthly revenue capacity, for eeach employee and month in the given project revenue budget version

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new project revenue budget version

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
forecastId
required
string <uuid>
scenarioId
required
string <uuid>
Request Body schema: application/json
startDate
required
string <date>
endDate
required
string <date>
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "employees": [
    ]
}

Get all employees, including project revenue parameters, that are used in a given project revenue budget version

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new personnel costs budget version

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
forecastId
required
string <uuid>
scenarioId
required
string <uuid>
Request Body schema: application/json
required
Array of objects non-empty
required
object
startDate
required
string <date>
endDate
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "departments": [
    ],
  • "config": {
    },
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24"
}

Set all the budgets for a specific business entity

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
forecastId
required
string <uuid>
scenarioId
required
string <uuid>
Request Body schema: application/json
required
object
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "budgetVersion": {
    },
  • "budgetTransactions": [
    ]
}

Set all the budgets for a specific business entity

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
forecastId
required
string <uuid>
scenarioId
required
string <uuid>
Request Body schema: application/json
selectedBudgetVersionId
required
string <uuid>
required
object
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "selectedBudgetVersionId": "5362734c-523c-4fea-bcc9-abe199f9e007",
  • "budgetVersion": {
    },
  • "budgetTransactions": [
    ]
}

Get costs and cashflows per personnel member of the given budget version

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all departments of the given personnel costs budget version

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the configuration of the given personnel costs budget version

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

Responses

Response samples

Content type
application/json
{
  • "yearlyRaise": {
    },
  • "vacationMoney": {
    },
  • "socialSecurity": 0,
  • "thirteenthMonth": true,
  • "debtBudgetAccount": {
    }
}

Get the initial budget by reporting line

Authorizations:
bearerAuth
path Parameters
orgId
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
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

Entity

Get details for a specific business entity

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>

Responses

Update an entity's details

Authorizations:
bearerAuth
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 the deleted status of an entity. Setting the status to deleted marks teh entity for deletion. Entitities marked for deletion can be restored by resetting the status to not found.

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
status
required
any
Enum: "not_found" "deleted"

Responses

Request samples

Content type
application/json
{
  • "status": "not_found"
}

Update an entity's settings

Authorizations:
bearerAuth
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.

https://docs.monitr.be/validations/validations
Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
query Parameters
from
required
string <date>
to
required
string <date>

Responses

Response samples

Content type
application/json
{
  • "checkBS": [
    ],
  • "checkPLvBS": [
    ],
  • "checkCFvBS": [
    ],
  • "hasUnmappedAccounts": true,
  • "unmappedProducts": [
    ],
  • "budgetAccountsWithoutVatRates": [
    ]
}

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

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Accounts

Get all general ledger accounts for a specific business entity

Authorizations:
bearerAuth
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:
bearerAuth
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:
bearerAuth
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:
bearerAuth
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:
bearerAuth
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:
bearerAuth
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:
bearerAuth
path Parameters
entityId
required
string <uuid>

Responses

Response samples

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

Get all general ledger transactions by relation id

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

Responses

Get all general ledger transactions by mapping ids

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
query Parameters
required
Array of strings or string
startDate
required
string <date>
endDate
required
string <date>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all general ledger transactions by reporting line ids

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
query Parameters
required
Array of strings or string
startDate
required
string <date>
endDate
required
string <date>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Authorizations:
bearerAuth
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:
bearerAuth
path Parameters
entityId
required
string <uuid>

Responses

Get all transactions and budgets by optional reporting line

Authorizations:
bearerAuth
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
Array of strings or arrays or string
Array of strings or string
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:
bearerAuth
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:
bearerAuth
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:
bearerAuth
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:
bearerAuth
path Parameters
entityId
required
string <uuid>

Responses

Sync all data with HubSpot

Authorizations:
bearerAuth
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:
bearerAuth
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"
}

/organisations/{orgId}/integrations/subscription/stripe

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>
query Parameters
entityId
required
string <uuid>
Request Body schema: application/json
apiKey
required
string

Responses

Request samples

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

Sync a Yuki integration for a specific organisation

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Sync a Odoo integration for a specific organisation

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Sync an Exact Online integration for a specific organisation

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

Responses

Sync an Octopus integration for a specific organisation

Authorizations:
bearerAuth
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:
bearerAuth
path Parameters
entityId
required
string <uuid>
generalLedgerId
required
string

Responses

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

Authorizations:
bearerAuth
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:
bearerAuth
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:
bearerAuth
path Parameters
entityId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set the list of reporting lines for the cash flow report

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
Array
id
required
string
name
required
string
rank
required
number
required
string or null
top
required
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

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

Authorizations:
bearerAuth
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:
bearerAuth
path Parameters
entityId
required
string <uuid>

Responses

Get a list of reporting lines for a specific report

Authorizations:
bearerAuth
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:
bearerAuth
path Parameters
entityId
required
string <uuid>
report
required
string
Enum: "PL" "BS"
Example: PL
Request Body schema: application/json
required
Array of objects
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:
bearerAuth
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:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set the list of reporting lines for the cash flow report

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>
Request Body schema: application/json
Array
id
required
string
name
required
string
rank
required
number
required
string or null
top
required
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

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

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Get a list of reporting lines for a specific report

Authorizations:
bearerAuth
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:
bearerAuth
path Parameters
orgId
required
string <uuid>
report
required
string
Enum: "PL" "BS"
Example: PL
Request Body schema: application/json
required
Array of objects
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:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Mappings

Get all mappings for a specific business entity

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>

Responses

Set all mappings for a specific business entity

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
Array
account_id
required
string
account_number
required
string
analytical_axis_id
string or null
analytical_axis_account
string or null
organisation_reporting_line_id
string or null
reporting_line_id
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get all mappings for a specific business entity

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

Responses

Consolidation

Set all mappings for a specific business entity

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
Array
account_id
required
string
account_number
required
string
analytical_axis_id
string or null
analytical_axis_account
string or null
organisation_reporting_line_id
string or null
reporting_line_id
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get all relations from all entities

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Get a list of reporting lines for the cash flow report

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set the list of reporting lines for the cash flow report

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>
Request Body schema: application/json
Array
id
required
string
name
required
string
rank
required
number
required
string or null
top
required
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

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

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Get a list of reporting lines for a specific report

Authorizations:
bearerAuth
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:
bearerAuth
path Parameters
orgId
required
string <uuid>
report
required
string
Enum: "PL" "BS"
Example: PL
Request Body schema: application/json
required
Array of objects
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:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Set the list of adjusting entries for and organisation

Authorizations:
bearerAuth
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
required
string or null
required
string or null
required
object or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get the mapping validation of your organisation's consolidation

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Response samples

Content type
application/json
true

Get the report validation of your organisation's consolidation

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>
query Parameters
required
string or string

Responses

Response samples

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

Get a list of custom metrics

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Get a specific report by report type and view

Authorizations:
bearerAuth
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 a specific report by report type and view

Authorizations:
bearerAuth
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:
bearerAuth
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:
bearerAuth
path Parameters
entityId
required
string <uuid>

Responses

Set the list of custom metrics

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>
Request Body schema: application/json
required
Array of objects
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:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Set the list of custom metrics

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>
Request Body schema: application/json
required
Array of objects
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:
bearerAuth
path Parameters
entityId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set the list of adjusting entries

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

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get a list of adjusting entries

Authorizations:
bearerAuth
path Parameters
orgId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set the list of adjusting entries for and organisation

Authorizations:
bearerAuth
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
required
string or null
required
string or null
required
object or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Outstanding Items

Get a list of all outstanding receivables

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of all outstanding payables

Authorizations:
bearerAuth
path Parameters
entityId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get historic outstanding items by reference date

Authorizations:
bearerAuth
path Parameters
<