Monitr API (1.2.0)

Download OpenAPI specification:Download

Engineering Team: engineering@monitr.be Terms of Service

Monitr's API

Authentication

bearerAuth

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

Budgets

Get a list of budget types

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"budgetTypes": ["string"
]
}

Get a list of budget versions

Authorizations:

bearerAuth

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:

bearerAuth

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

Payload

Content type

application/json

{"budgetVersions": [{"id": "string",
"original_id": "string",
"name": "My first budget",
"budget_type": "budget",
"initial": true,
"active": true,
"comment": "This is a comment",
"settings": { }
}
]
}

Create a new budget version

Authorizations:

bearerAuth

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

Payload

Content type

application/json

{"budgetVersion": {"name": "string",
"initial": false,
"budget_type": "crm",
"active": false,
"comment": "string",
"referenceBudgetVersion": "string",
"referenceDate": "2019-08-24",
"integration_id": "55d7337e-1d0a-49fc-9826-925ba40df035",
"settings": { }
}
}

Create a new NWC Unwinding budget version

Authorizations:

bearerAuth

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

Payload

Content type

application/json

{"name": "string",
"reference_date": "2019-08-24",
"budgets": [{"budget_account_id": "string",
"period": "2019-08-24",
"amount": 0
}
],
"outstanding_items": [{"relation_name": "string",
"due_date": "2019-08-24",
"custom_due_date": "2019-08-24",
"amount": 0,
"amount_outstanding": 0,
"type": "receivable"
}
]
}

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

Payload

Content type

application/json

{"name": "string",
"settings": {"general": {"type": "split",
"receivableReportingLine": {"id": "string"
},
"payableReportingLine": {"id": "string"
},
"generatedVatReceivableBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
},
"vatSettlementsReceivableBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
},
"generatedVatPayableBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
},
"vatSettlementsPayableBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
}
},
"rates": [{"month": "2019-08-24",
"budgetAccount": {"id": "string"
},
"rate": 0
}
],
"periods": [{"year": 0,
"periods": [{"name": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"paymentDate": "2019-08-24",
"refundDate": "2019-08-24"
}
]
}
]
}
}

Update the config of an existing VAT budget version

Authorizations:

bearerAuth

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

Payload

Content type

application/json

{"general": {"type": "split",
"receivableReportingLine": {"id": "string"
},
"payableReportingLine": {"id": "string"
},
"generatedVatReceivableBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
},
"vatSettlementsReceivableBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
},
"generatedVatPayableBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
},
"vatSettlementsPayableBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
}
},
"rates": [{"month": "2019-08-24",
"budgetAccount": {"id": "string"
},
"rate": 0
}
],
"periods": [{"year": 0,
"periods": [{"name": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"paymentDate": "2019-08-24",
"refundDate": "2019-08-24"
}
]
}
]
}

Get the settings for a VAT budget version

Authorizations:

bearerAuth

path Parameters

entityId required	string <uuid>
budgetVersionId required	string

query Parameters

any or Array of any

Responses

Response samples

200

Content type

application/json

{"general": {"type": "split",
"receivableReportingLine": {"id": "string"
},
"payableReportingLine": {"id": "string"
},
"generatedVatReceivableBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
},
"vatSettlementsReceivableBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
},
"generatedVatPayableBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
},
"vatSettlementsPayableBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
}
},
"rates": [{"month": "2019-08-24",
"budgetAccount": {"id": "string"
},
"rate": 0
}
],
"periods": [{"year": 0,
"periods": [{"name": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"paymentDate": "2019-08-24",
"refundDate": "2019-08-24"
}
]
}
]
}

Get a list of budget accounts

Authorizations:

bearerAuth

path Parameters

entityId

required

string <uuid>

query Parameters

extended

required

boolean

Default: false

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"mapping_id": "string",
"comment": "string",
"entity_id": "8161163a-f227-466f-bc01-090a01e80165",
"nwc_account_id": "string",
"payment_term": 0,
"managed_by_budget_type": "budget",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"mapping": {"id": "string",
"account_id": "string",
"analytical_axis_id": "string",
"reporting_line_id": "string",
"organisation_reporting_line_id": "string",
"entity_id": "8161163a-f227-466f-bc01-090a01e80165",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"account": {"id": "string",
"account_number": "string",
"account_name": "string",
"is_active": true
},
"analytical_axis": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"account": "string",
"description": "string"
},
"reporting_line": {"id": "string",
"name": "string",
"rank": 0,
"parent_id": "string",
"report": "string",
"top": true,
"cash_flow_reporting_line_id": "string",
"entity_id": "8161163a-f227-466f-bc01-090a01e80165",
"organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}
}
}
]

Set the list of budget accounts

Authorizations:

bearerAuth

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

Payload

Content type

application/json

[{"id": "string",
"original_id": "string",
"name": "string",
"mapping_id": "string",
"nwc_account_id": "string",
"payment_term": 0,
"comment": "string"
}
]

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

Authorizations:

bearerAuth

path Parameters

entityId

required

string <uuid>

query Parameters

budget_version

string

Responses

Set all the budgets for a specific business entity

Authorizations:

bearerAuth

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

Payload

Content type

application/json

{"budgets": [{"id": "string",
"budget_account_id": "string",
"budget_version_id": "string",
"amount": 0,
"period": "2019-08-24"
}
]
}

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	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:

bearerAuth

path Parameters

entityId

required

string <uuid>

Responses

Set the budget settings for the NWC module

Authorizations:

bearerAuth

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

Payload

Content type

application/json

{"settings": [{"type": "AR",
"budget_account_id": null
}
]
}

Get the products for a specific budget version

Authorizations:

bearerAuth

path Parameters

entityId required	string <uuid>
budgetVersionId required	string

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"vendorId": "string",
"name": "string",
"description": "string",
"unitCost": 0,
"price": 0,
"recurring": true,
"archived": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"integrationId": "497a18ca-284e-40c0-985d-f72be35d468e",
"budgetAccountId": "string",
"recurringRevenueProducts": [{"budgetVersionId": "string",
"productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
"newCustomers": 0,
"monthlyGrowth": 0,
"churn": 0,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"periods": [{"period": "string",
"interval": 0,
"distribution": 0,
"avgRevenue": 0
}
],
"recurringRevenueBudgetAccountId": "string",
"revenueRecognitionBudgetAccountId": "string",
"recurringRevenue": {"reportingLineId": "string",
"mappingId": "string"
},
"revenueRecognition": {"reportingLineId": "string",
"mappingId": "string"
}
}
]
}
]

Create a new recurring revenue budget version

Authorizations:

bearerAuth

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

Payload

Content type

application/json

{"subscriptionModelProducts": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"vendorId": "string",
"name": "string",
"description": "string",
"unitCost": 0,
"price": 0,
"recurring": true,
"archived": true,
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"integrationId": "497a18ca-284e-40c0-985d-f72be35d468e",
"budgetAccountId": "string",
"recurringRevenueProducts": {"budgetVersionId": "string",
"productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
"newCustomers": 0,
"monthlyGrowth": 0,
"churn": 0,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"periods": [{"period": "string",
"interval": 0,
"distribution": 0,
"avgRevenue": 0
}
],
"recurringRevenue": {"reportingLineId": "string",
"mappingId": "string"
},
"revenueRecognition": {"reportingLineId": "string",
"mappingId": "string"
}
}
}
]
}

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

Payload

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:

bearerAuth

path Parameters

entityId

required

string <uuid>

Request Body schema: application/json

exactImport	object
	object

Responses

Request samples

Payload

Content type

application/json

{"exactImport": { },
"company_settings": {"budget_account_for_debt": "string",
"salary": {"amount": 0,
"period": "2019-08-24T14:15:22Z"
},
"social_security": 0,
"13_month": true,
"vacation_money": {"amount": 0,
"period": "2019-08-24T14:15:22Z",
"type": "spread"
}
}
}

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

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

200

Content type

application/json

[{"id": "string",
"account_number": "string",
"account_name": "string",
"is_active": true,
"mappings": [{"id": "string",
"account_id": "string",
"analytical_axis_id": "string",
"reporting_line_id": "string",
"organisation_reporting_line_id": "string",
"entity_id": "8161163a-f227-466f-bc01-090a01e80165",
"reporting_line": {"id": "string",
"name": "string",
"rank": 0,
"parent_id": "string",
"report": "string",
"top": true,
"cash_flow_reporting_line_id": "string",
"entity_id": "8161163a-f227-466f-bc01-090a01e80165",
"organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}
}
]
}
]

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

Authorizations:

bearerAuth

path Parameters

orgId

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"property1": [{"id": "string",
"account_number": "string",
"account_name": "string",
"is_active": true,
"mappings": [{"id": "string",
"account_id": "string",
"analytical_axis_id": "string",
"reporting_line_id": "string",
"organisation_reporting_line_id": "string",
"entity_id": "8161163a-f227-466f-bc01-090a01e80165",
"reporting_line": {"id": "string",
"name": "string",
"rank": 0,
"parent_id": "string",
"report": "string",
"top": true,
"cash_flow_reporting_line_id": "string",
"entity_id": "8161163a-f227-466f-bc01-090a01e80165",
"organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}
}
]
}
],
"property2": [{"id": "string",
"account_number": "string",
"account_name": "string",
"is_active": true,
"mappings": [{"id": "string",
"account_id": "string",
"analytical_axis_id": "string",
"reporting_line_id": "string",
"organisation_reporting_line_id": "string",
"entity_id": "8161163a-f227-466f-bc01-090a01e80165",
"reporting_line": {"id": "string",
"name": "string",
"rank": 0,
"parent_id": "string",
"report": "string",
"top": true,
"cash_flow_reporting_line_id": "string",
"entity_id": "8161163a-f227-466f-bc01-090a01e80165",
"organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}
}
]
}
]
}

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

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"account": "string",
"description": "string",
"axis": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"vendorId": "string",
"name": "string"
},
"used": true
}
]

Get all axes for a specific business entity

Authorizations:

bearerAuth

path Parameters

entityId

required

string <uuid>

query Parameters

used

boolean

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"vendorId": "string",
"name": "string"
}
]

Get all analytical axes for a specific business entity

Authorizations:

bearerAuth

path Parameters

orgId

required

string <uuid>

query Parameters

used

boolean

Responses

Response samples

200

Content type

application/json

{"property1": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"account": "string",
"description": "string",
"axis": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"vendorId": "string",
"name": "string"
},
"used": true
}
],
"property2": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"account": "string",
"description": "string",
"axis": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"vendorId": "string",
"name": "string"
},
"used": true
}
]
}

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

200

Content type

application/json

[{"year": 2019
},
{"year": 2020
},
{"year": 2021
}
]

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 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

Payload

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	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:

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

Payload

Content type

application/json

{"replace": {"from": "2019-08-24",
"to": "2019-08-24"
},
"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

Payload

Content type

application/json

{"replace": {"from": "2019-08-24",
"to": "2019-08-24"
},
"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

Payload

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

Payload

Content type

application/json

{"paymentDueDate": "string"
}

Sync a Yuki 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

200

Content type

application/json

[{"id": "9c9fc0c9-5c2e-4e56-bba7-8e27d25b711b",
"name": "Factuur voorbeeld",
"fileName": "voorbeeld.pdf"
}
]

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

Set the list of reporting lines for the cash flow report

Authorizations:

bearerAuth

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

Payload

Content type

application/json

{"cashFlowReportingLines": [{"id": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000",
"name": "My Reporting Line",
"rank": 1,
"top": true,
"parent_id": "00000000-0000-0000-0000-000000000000_11111111-1111-1111-1111-111111111111"
}
]
}

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[ 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

Payload

Content type

application/json

{"reportingLines": [{"id": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000",
"name": "My Reporting Line",
"rank": 1,
"top": true,
"parent_id": "00000000-0000-0000-0000-000000000000_11111111-1111-1111-1111-111111111111",
"cash_flow_reporting_line_id": null
}
]
}

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

Payload

Content type

application/json

{"template": {"meta": {"title": "string",
"description": "string",
"tags": ["string"
],
"autoMapped": true,
"vendor": {"id": "string",
"provider": "monitr"
}
},
"definitions": {"CF": [{"name": "string",
"top": true,
"children": [ ],
"type": "reporting_line"
}
],
"PL": [{"name": "string",
"top": true,
"children": [ ],
"custom_metric": "string",
"cash_flow_reporting_line": "string",
"type": "reporting_line"
}
],
"BS": [{"name": "string",
"top": true,
"children": [ ],
"custom_metric": "string",
"cash_flow_reporting_line": "string",
"type": "reporting_line"
}
]
}
}
}

Get a list of reporting lines for the cash flow report

Authorizations:

bearerAuth

path Parameters

orgId

required

string <uuid>

Responses

Set the list of reporting lines for the cash flow report

Authorizations:

bearerAuth

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

Payload

Content type

application/json

{"cashFlowReportingLines": [{"id": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000",
"name": "My Reporting Line",
"rank": 1,
"top": true,
"parent_id": "00000000-0000-0000-0000-000000000000_11111111-1111-1111-1111-111111111111"
}
]
}

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[ 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

Payload

Content type

application/json

{"reportingLines": [{"id": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000",
"name": "My Reporting Line",
"rank": 1,
"top": true,
"parent_id": "00000000-0000-0000-0000-000000000000_11111111-1111-1111-1111-111111111111",
"cash_flow_reporting_line_id": null
}
]
}

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

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

Payload

Content type

application/json

{"mappings": [{"account_id": "string",
"account_number": "string",
"analytical_axis_id": "string",
"analytical_axis_account": "string",
"organisation_reporting_line_id": "string",
"reporting_line_id": "string"
}
]
}

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

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

Payload

Content type

application/json

{"mappings": [{"account_id": "string",
"account_number": "string",
"analytical_axis_id": "string",
"analytical_axis_account": "string",
"organisation_reporting_line_id": "string",
"reporting_line_id": "string"
}
]
}

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

Set the list of reporting lines for the cash flow report

Authorizations:

bearerAuth

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

Payload

Content type

application/json

{"cashFlowReportingLines": [{"id": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000",
"name": "My Reporting Line",
"rank": 1,
"top": true,
"parent_id": "00000000-0000-0000-0000-000000000000_11111111-1111-1111-1111-111111111111"
}
]
}

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[ 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

Payload

Content type

application/json

{"reportingLines": [{"id": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000",
"name": "My Reporting Line",
"rank": 1,
"top": true,
"parent_id": "00000000-0000-0000-0000-000000000000_11111111-1111-1111-1111-111111111111",
"cash_flow_reporting_line_id": null
}
]
}

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
analyticalAxisId required	string or null
createdBy required	string or null <uuid>
required	object or null

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"datePeriod": "2019-08-24",
"description": "string",
"amount": 0,
"entityIdFrom": "177f39e6-bdd1-4222-9b12-21497656cd8b",
"entityIdTo": "4d4dd440-bef7-4aa4-9c2a-96ce468524ce",
"glAccountId": "string",
"analyticalAxisId": "string",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"firstName": "string",
"lastName": "string"
}
}
]

Get the validation of your organisation consolidation

Authorizations:

bearerAuth

path Parameters

orgId

required

string <uuid>

query Parameters

report

required

string

Enum: "PL" "BS"

Responses

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 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[ items ]

Array

id required	string <uuid>
name required	string
reporting_line_id required	string

Responses

Request samples

Payload

Content type

application/json

{"customMetrics": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Revenue",
"reporting_line_id": "string"
}
]
}

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[ items ]

Array

id required	string <uuid>
name required	string
reporting_line_id required	string

Responses

Request samples

Payload

Content type

application/json

{"customMetrics": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Revenue",
"reporting_line_id": "string"
}
]
}

Adjusting Entries

Get a list of adjusting entries

Authorizations:

bearerAuth

path Parameters

entityId

required

string <uuid>

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"datePeriod": "2019-08-24",
"description": "string",
"glAccountId": "string",
"analyticalAxisId": "string",
"amount": 0,
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"firstName": "string",
"lastName": "string"
}
}
]

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>
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

Payload

Content type

application/json

[{"id": "string",
"datePeriod": "2019-08-24",
"description": "string",
"glAccountId": "string",
"analyticalAxisId": "string",
"amount": 0,
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"axis": "c7060fc4-1cd2-4402-a2ba-7546f6637c60"
}
]

Get a list of adjusting entries

Authorizations:

bearerAuth

path Parameters

orgId

required

string <uuid>

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"datePeriod": "2019-08-24",
"description": "string",
"amount": 0,
"entityIdFrom": "177f39e6-bdd1-4222-9b12-21497656cd8b",
"entityIdTo": "4d4dd440-bef7-4aa4-9c2a-96ce468524ce",
"glAccountId": "string",
"analyticalAxisId": "string",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"firstName": "string",
"lastName": "string"
}
}
]

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
analyticalAxisId required	string or null
createdBy required	string or null <uuid>
required	object or null

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"datePeriod": "2019-08-24",
"description": "string",
"amount": 0,
"entityIdFrom": "177f39e6-bdd1-4222-9b12-21497656cd8b",
"entityIdTo": "4d4dd440-bef7-4aa4-9c2a-96ce468524ce",
"glAccountId": "string",
"analyticalAxisId": "string",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"firstName": "string",
"lastName": "string"
}
}
]

Outstanding Items

Get a list of all outstanding items by type

Authorizations:

bearerAuth

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:

bearerAuth

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:

bearerAuth

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

Payload

Content type

application/json

{"0": {"due_date": "2022-02-30"
}
}

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

Authorizations:

bearerAuth

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:

bearerAuth

path Parameters

entityId

required

string <uuid>

query Parameters

lastUsed

boolean

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"vendorId": "string",
"name": "string",
"description": "string",
"unitCost": 0,
"price": 0,
"recurring": true,
"archived": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"integrationId": "497a18ca-284e-40c0-985d-f72be35d468e",
"budgetAccountId": "string",
"recurringRevenueProducts": [{"budgetVersionId": "string",
"productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
"newCustomers": 0,
"monthlyGrowth": 0,
"churn": 0,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"periods": [{"period": "string",
"interval": 0,
"distribution": 0,
"avgRevenue": 0
}
],
"recurringRevenueBudgetAccountId": "string",
"revenueRecognitionBudgetAccountId": "string",
"recurringRevenue": {"reportingLineId": "string",
"mappingId": "string"
},
"revenueRecognition": {"reportingLineId": "string",
"mappingId": "string"
}
}
]
}
]

Associate budget accounts with products

Authorizations:

bearerAuth

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

Payload

Content type

application/json

{"products": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"budgetAccountId": "string"
}
]
}

Get the products for a specific budget version

Authorizations:

bearerAuth

path Parameters

entityId required	string <uuid>
budgetVersionId required	string

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"vendorId": "string",
"name": "string",
"description": "string",
"unitCost": 0,
"price": 0,
"recurring": true,
"archived": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"integrationId": "497a18ca-284e-40c0-985d-f72be35d468e",
"budgetAccountId": "string",
"recurringRevenueProducts": [{"budgetVersionId": "string",
"productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
"newCustomers": 0,
"monthlyGrowth": 0,
"churn": 0,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"periods": [{"period": "string",
"interval": 0,
"distribution": 0,
"avgRevenue": 0
}
],
"recurringRevenueBudgetAccountId": "string",
"revenueRecognitionBudgetAccountId": "string",
"recurringRevenue": {"reportingLineId": "string",
"mappingId": "string"
},
"revenueRecognition": {"reportingLineId": "string",
"mappingId": "string"
}
}
]
}
]

Create a new recurring revenue budget version

Authorizations:

bearerAuth

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

Payload

Content type

application/json

{"subscriptionModelProducts": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"vendorId": "string",
"name": "string",
"description": "string",
"unitCost": 0,
"price": 0,
"recurring": true,
"archived": true,
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"integrationId": "497a18ca-284e-40c0-985d-f72be35d468e",
"budgetAccountId": "string",
"recurringRevenueProducts": {"budgetVersionId": "string",
"productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
"newCustomers": 0,
"monthlyGrowth": 0,
"churn": 0,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"periods": [{"period": "string",
"interval": 0,
"distribution": 0,
"avgRevenue": 0
}
],
"recurringRevenue": {"reportingLineId": "string",
"mappingId": "string"
},
"revenueRecognition": {"reportingLineId": "string",
"mappingId": "string"
}
}
}
]
}

Reporting

Get a specific report by report type

Authorizations:

bearerAuth

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:

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

Graphs

Get the graph data for a specific report

Authorizations:

bearerAuth

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:

bearerAuth

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:

bearerAuth

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:

bearerAuth

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:

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

Integrations

Get custom fields from HubSpot

Authorizations:

bearerAuth

path Parameters

entityId required	string <uuid>
integrationId required	string <uuid>

Responses

Get custom fields from Teamleader

Authorizations:

bearerAuth

path Parameters

entityId required	string <uuid>
integrationId required	string <uuid>

Responses

Get a list of all integration providers that Monitr supports

Authorizations:

bearerAuth

Responses

Get a list of active integrations for a specific organisation

Authorizations:

bearerAuth

path Parameters

orgId

required

string <uuid>

query Parameters

Responses

Response samples

200

Content type

application/json

[{"id": "monitr",
"provider": "monitr",
"name": "string",
"author": "string",
"icon": "http://example.com",
"integrations": [null
],
"integrationProvidersTypes": [{"description": "string",
"integrationType": "bookkeeping"
}
]
}
]

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

Authorizations:

bearerAuth

path Parameters

orgId

required

string <uuid>

Request Body schema: application/json

credentials

required

string

Responses

Request samples

Payload

Content type

application/json

{"credentials": "string"
}

Create a new CSV integration

Authorizations:

bearerAuth

path Parameters

orgId

required

string <uuid>

Request Body schema: application/json

credentials required	string <uuid>
entityName required	string

Responses

Request samples

Payload

Content type

application/json

{"credentials": "868741d7-83dc-4432-9191-e0ae1fe1f6fe",
"entityName": "string"
}

Get details for a specific integration

Authorizations:

bearerAuth

path Parameters

orgId required	string <uuid>
integrationId required	string <uuid>
type required	any (def-4)

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"integrationProviderId": "monitr",
"settings": { },
"entity": { },
"entities": [{ }
],
"import": {"entity_id": "8161163a-f227-466f-bc01-090a01e80165",
"integration_id": "55d7337e-1d0a-49fc-9826-925ba40df035",
"started_at": "2019-08-24T14:15:22Z",
"finished_at": "2019-08-24T14:15:22Z",
"last_success_at": "2019-08-24T14:15:22Z",
"status": "waiting"
},
"created_at": "2019-08-24T14:15:22Z"
}

Get a list of business entities for a specific integration

Authorizations:

bearerAuth

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:

bearerAuth

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

Payload

Content type

application/json

{"budgetingType": "acrossProducts",
"defaultBudgetAccount": "string"
}

Templates

Get a list of available reporting templates from Exact

Authorizations:

bearerAuth

path Parameters

entityId required	string <uuid>
integrationId required	string <uuid>

Responses

Get a list of available reporting templates

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

[{"meta": {"title": "string",
"description": "string",
"tags": ["string"
],
"autoMapped": true,
"vendor": {"id": "string",
"provider": "monitr"
}
},
"definitions": {"CF": [{"name": "string",
"top": true,
"children": [ ],
"type": "reporting_line"
}
],
"PL": [{"name": "string",
"top": true,
"children": [ ],
"custom_metric": "string",
"cash_flow_reporting_line": "string",
"type": "reporting_line"
}
],
"BS": [{"name": "string",
"top": true,
"children": [ ],
"custom_metric": "string",
"cash_flow_reporting_line": "string",
"type": "reporting_line"
}
]
}
}
]

Get all templates for VAT periods for a given year

Authorizations:

bearerAuth

query Parameters

year

number

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"year": 0,
"periods": [{"name": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"paymentDate": "2019-08-24",
"refundDate": "2019-08-24"
}
]
}
]

Budgets - Personnel

Get the latest departments and employees for a specific budget version

Authorizations:

bearerAuth

path Parameters

entityId required	string <uuid>
budgetVersionId required	string

Responses

Get departments and employees for the current active budget version

Authorizations:

bearerAuth

path Parameters

entityId

required

string <uuid>

Responses

Set the departments and employees for a specific budget version Deprecated

Authorizations:

bearerAuth

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

Payload

Content type

application/json

{"budgetVersionId": "string",
"departments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"budget_account_id": "string"
}
],
"employees": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"budget_account_id": "string",
"vendor_id": "string",
"employee_type": "employee",
"first_name": "string",
"last_name": "string",
"wage": { },
"perks": [ ],
"job_title": "string",
"employment_start": "2019-08-24",
"employment_end": "2019-08-24"
}
]
}

Compare personnel costs with your actuals and budget

Authorizations:

bearerAuth

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:

bearerAuth

path Parameters

entityId

required

string <uuid>

Request Body schema: application/json

content required	string
reportingLineId	string
month required	string <date>

Responses

Request samples

Payload

Content type

application/json

{"content": "string",
"reportingLineId": "string",
"month": "2019-08-24"
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content": "string",
"createdBy": {"firstName": "string",
"lastName": "string",
"email": "string"
},
"lastEditedBy": {"firstName": "string",
"lastName": "string",
"email": "string"
},
"reportingLine": {"id": "string",
"name": "string"
},
"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:

bearerAuth

path Parameters

entityId

required

string <uuid>

query Parameters

from required	string <date>
to required	string <date>

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content": "string",
"createdBy": {"firstName": "string",
"lastName": "string",
"email": "string"
},
"lastEditedBy": {"firstName": "string",
"lastName": "string",
"email": "string"
},
"reportingLine": {"id": "string",
"name": "string"
},
"month": "2019-08-24",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

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:

bearerAuth

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

200

Content type

application/json

[{"reportingLineId": null,
"annotations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content": "string",
"createdBy": {"firstName": "string",
"lastName": "string",
"email": "string"
},
"lastEditedBy": {"firstName": "string",
"lastName": "string",
"email": "string"
},
"reportingLine": {"id": "string",
"name": "string"
},
"month": "2019-08-24",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isLowestLevel": true
}
]
}
]

Update the content of an annotation

Authorizations:

bearerAuth

path Parameters

entityId required	string <uuid>
annotationId required	string <uuid>

Request Body schema: application/json

content

required

string

Responses

Request samples

Payload

Content type

application/json

{"content": "string"
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content": "string",
"createdBy": {"firstName": "string",
"lastName": "string",
"email": "string"
},
"lastEditedBy": {"firstName": "string",
"lastName": "string",
"email": "string"
},
"reportingLine": {"id": "string",
"name": "string"
},
"month": "2019-08-24",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete an annotation

Authorizations:

bearerAuth

path Parameters

entityId required	string <uuid>
annotationId required	string <uuid>

Responses

Organisations

Create a new organisation

Authorizations:

bearerAuth

Request Body schema: application/json

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Get details for a specific organisation

Authorizations:

bearerAuth

path Parameters

orgId

required

string <uuid>

Responses

Update details and settings for a specific organisation

Authorizations:

bearerAuth

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

Payload

Content type

application/json

{"name": "string",
"vatNumber": "BE0755664444",
"settings": {"consolidation": {"is_active": true,
"relations": { }
}
}
}

Teams

Accept a team invite using an invite token

Authorizations:

bearerAuth

path Parameters

orgId required	string <uuid>
teamId required	string <uuid>

Request Body schema: application/json

token

required

string

Responses

Request samples

Payload

Content type

application/json

{"token": "string"
}

Get a list of teams for a specific organisation

Authorizations:

bearerAuth

path Parameters

orgId

required

string <uuid>

Responses

Create a new team

Authorizations:

bearerAuth

path Parameters

orgId

required

string <uuid>

Request Body schema: application/json

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

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

Authorizations:

bearerAuth

path Parameters

orgId

required

string <uuid>

Responses

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

Authorizations:

bearerAuth

path Parameters

orgId

required

string <uuid>

Responses

Update a team

Authorizations:

bearerAuth

path Parameters

orgId required	string <uuid>
teamId required	string <uuid>

Request Body schema: application/json

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Delete a team

Authorizations:

bearerAuth

path Parameters

orgId required	string <uuid>
teamId required	string <uuid>

Responses

Invite a user/email to a team

Authorizations:

bearerAuth

path Parameters

orgId required	string <uuid>
teamId required	string <uuid>

Request Body schema: application/json

Array

string <email>