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 string or string or string or string or string or string or string or string or string or string)) or (Array of https://monitr.be/budget/type.schema.json (strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings))

Responses

Delete a budget version

Authorizations:

bearerAuth

path Parameters

entityId required	string <uuid>
budgetVersionId required	string

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
settings required	object

Responses

Request samples

Payload

Content type

application/json

{"budgetVersion": {"name": "string",
"budget_type": "crm",
"active": true,
"integration_id": "55d7337e-1d0a-49fc-9826-925ba40df035",
"comment": "string",
"settings": { }
}
}

Update a specific budget version

Authorizations:

bearerAuth

path Parameters

entityId required	string <uuid>
budgetVersionId required	string

Request Body schema: application/json

active	boolean
initial	boolean

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"initial": true
}

Create a new VAT budget version Deprecated

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
required	(https://monitr.be/budget/type.schema.json (string or string or string or string or string or string or string or string or string or string or 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",
"managed_by_budget_type": "budget"
}
]

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

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": {"mappingId": "string",
"reportingLineId": "string"
},
"revenueRecognition": {"mappingId": "string",
"reportingLineId": "string"
}
}
],
"productRevenues": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"budgetVersionId": "string",
"productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string",
"productsRevenueChannels": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
"name": "string",
"productsRevenueItems": [{"productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
"productsRevenueChannelId": "8d85ab2f-3d5b-42fb-b1e8-bea3670bb970",
"datePeriod": "2019-08-24",
"price": 0,
"quantity": 0,
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string"
}
],
"budgetAccountId": "string",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string",
"mappedBudgetAccount": {"mappingId": "string",
"reportingLineId": "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": {"mappingId": "string",
"reportingLineId": "string"
},
"revenueRecognition": {"mappingId": "string",
"reportingLineId": "string"
}
}
],
"productRevenues": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"budgetVersionId": "string",
"productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string",
"productsRevenueChannels": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
"name": "string",
"productsRevenueItems": [{"productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
"productsRevenueChannelId": "8d85ab2f-3d5b-42fb-b1e8-bea3670bb970",
"datePeriod": "2019-08-24",
"price": 0,
"quantity": 0,
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string"
}
],
"budgetAccountId": "string",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string",
"mappedBudgetAccount": {"mappingId": "string",
"reportingLineId": "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

[{"productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
"productName": "string",
"categories": [{"name": "string",
"dateItems": [{"datePeriod": "2019-08-24",
"value": 0
}
],
"mappedBudgetAccount": {"mappingId": "string",
"reportingLineId": "string"
}
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"productValues": [{"datePeriod": "2019-08-24",
"avgPrice": 0,
"quantity": 0
}
]
}
]

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

[{"cogsItemId": "76e7da50-168e-42c2-b0c6-c5f09bcc0daa",
"productName": "string",
"productValues": [{"datePeriod": "2019-08-24",
"avgPrice": 0,
"quantity": 0
}
],
"category": {"name": "string",
"dateItems": [{"datePeriod": "2019-08-24",
"value": 0
}
],
"mappedBudgetAccount": {"mappingId": "string",
"reportingLineId": "string"
}
},
"productInventoryTransactions": [{"datePeriod": "2019-08-24",
"purchaseAmount": 0
}
],
"startBalance": 0,
"safetyStock": 0,
"prepayments": [{"monthsBefore": 0,
"percentage": 10000
}
],
"inventoryBudgetAccount": {"mappingId": "string",
"reportingLineId": "string"
},
"prepaymentBudgetAccount": {"mappingId": "string",
"reportingLineId": "string"
},
"allCategories": [{"name": "string",
"dateItems": [{"datePeriod": "2019-08-24",
"value": 0
}
],
"mappedBudgetAccount": {"mappingId": "string",
"reportingLineId": "string"
}
}
]
}
]

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

200

Content type

application/json

[{"relationName": "string",
"productId": "string",
"productName": "string",
"description": "string",
"date": "2019-08-24",
"periodStartDate": "2019-08-24",
"periodEndDate": "2019-08-24",
"interval": "day",
"intervalCount": 0,
"recurringRevenueAmount": 0,
"cashFlowAmount": 0,
"recurringRevenueBudgetType": "model",
"amountType": "revenue",
"revenueType": "revenue"
}
]

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

200

Content type

application/json

[{"datePeriod": "2019-08-24",
"type": "budget",
"budgetType": "pxq",
"productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
"productName": "string",
"channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",
"channelName": "string",
"categoryName": "string",
"price": 0,
"quantity": 0,
"revenue": 0,
"cost": 0
}
]

Get the inventory dashboard information

Authorizations:

bearerAuth

path Parameters

entityId

required

string <uuid>

query Parameters

required

Array of strings or string

Responses

Response samples

200

Content type

application/json

[{"productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
"productName": "string",
"inventoryId": "b5d302ca-2693-4070-9397-62a63ec9fb65",
"datePeriod": "2019-08-24",
"inventorySafetyStock": 0,
"inventoryStartBalance": 0,
"inventoryPurchased": 0,
"quantitySold": 0,
"inventoryEndBalance": 0,
"costGoods": 0,
"avgCostGoods": 0,
"revenue": 0
}
]

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

Responses

Response samples

200

Content type

application/json

[{"employee": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"firstName": "string",
"lastName": "string",
"projectIntegrationEmployeeId": "5d274fd7-1821-4a00-b332-1e14360d5bed"
},
"month": "2019-08-24",
"active": true,
"rate": 0,
"billability": 0,
"revenue": 0
}
]

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

Responses

Request samples

Payload

Content type

application/json

{"startDate": "2019-08-24",
"endDate": "2019-08-24",
"employees": [{"integration": {"projectIntegrationEmployeeId": "5d274fd7-1821-4a00-b332-1e14360d5bed",
"rollingWindow": 0
},
"personnelCostsEmployeeId": "6aacc2ed-0017-47e0-9451-3ebee7326347",
"budgetAccount": {"mapping": {"id": "string"
}
},
"revenueParameters": [{"month": "2019-08-24",
"active": true,
"rate": 0,
"billability": 9
}
]
}
]
}

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

Responses

Response samples

200

Content type

application/json

[{"personnelCostsEmployeeId": "6aacc2ed-0017-47e0-9451-3ebee7326347",
"projectIntegrationEmployeeId": "5d274fd7-1821-4a00-b332-1e14360d5bed",
"budgetAccount": {"mapping": {"id": "string"
}
},
"revenueParameters": [{"month": "2019-08-24",
"active": true,
"rate": 0,
"billability": 9
}
]
}
]

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 [ items ]
required	object
startDate required	string <date>
endDate required	string <date>

Responses

Request samples

Payload

Content type

application/json

{"departments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"employees": [{"employee": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"firstName": "string",
"lastName": "string"
},
"budgetAccount": {"name": "string",
"mapping": {"id": "string"
}
},
"jobTitle": "string",
"wage": {"type": "payroll",
"amount": 0,
"socialSecurity": 0
},
"perks": [{"name": "string",
"amount": 0,
"paymentType": "recurring",
"period": {"start": "2019-08-24",
"end": "2019-08-24"
}
}
],
"employmentStart": "2019-08-24",
"employmentEnd": "2019-08-24"
}
]
}
],
"config": {"yearlyRaise": {"month": "2019-08-24",
"percentage": 0
},
"vacationMoney": {"type": "spread",
"percentage": 0
},
"socialSecurity": 0,
"thirteenthMonth": true,
"debtBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
}
},
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}

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

Authorizations:

bearerAuth

path Parameters

entityId required	string <uuid>
budgetVersionId required	string

Responses

Response samples

200

Content type

application/json

[{"employee": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"firstName": "string",
"lastName": "string"
},
"department": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"reportingLine": {"id": "string",
"name": "string"
},
"month": "2019-08-24",
"wage": 0,
"fee": 0,
"socialSecurity": 0,
"thirteenthMonthCost": 0,
"thirteenthMonthCash": 0,
"vacationMoneyCost": 0,
"vacationMoneyCash": 0,
"perks": 0
}
]

Get all departments of the given personnel costs 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",
"name": "string",
"employees": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"employee": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"firstName": "string",
"lastName": "string"
},
"budgetAccount": {"name": "string",
"mapping": {"id": "string"
}
},
"wage": {"type": "payroll",
"amount": 0,
"socialSecurity": 0
},
"perks": [{"name": "string",
"amount": 0,
"paymentType": "recurring",
"period": {"start": "2019-08-24",
"end": "2019-08-24"
}
}
],
"employmentStart": "2019-08-24",
"employmentEnd": "2019-08-24"
}
]
}
]

Get the configuration of the given personnel costs budget version

Authorizations:

bearerAuth

path Parameters

entityId required	string <uuid>
budgetVersionId required	string

Responses

Response samples

200

Content type

application/json

{"yearlyRaise": {"month": "2019-08-24",
"percentage": 0
},
"vacationMoney": {"type": "spread",
"percentage": 0
},
"socialSecurity": 0,
"thirteenthMonth": true,
"debtBudgetAccount": {"name": "string",
"mapping": {"id": "string"
}
}
}

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

Payload

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

Payload

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

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

200

Content type

application/json

[{"reportingLine": {"id": "string",
"name": "string"
},
"month": "2019-08-24",
"amount": 0
}
]

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

/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

Payload

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

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

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

Payload

Content type

application/json

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

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

Payload

Content type

application/json

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

integrationType	string (https://monitr.be/integration/types.schema.json) Enum: "bookkeeping" "crm" "other" "subscription" "inventory" "project"
	string or string or string or string or string or string or string or string or string or string or string (https://monitr.be/budget/type.schema.json)

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": {"mappingId": "string",
"reportingLineId": "string"
},
"revenueRecognition": {"mappingId": "string",
"reportingLineId": "string"
}
}
],
"productRevenues": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"budgetVersionId": "string",
"productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string",
"productsRevenueChannels": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
"name": "string",
"productsRevenueItems": [{"productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
"productsRevenueChannelId": "8d85ab2f-3d5b-42fb-b1e8-bea3670bb970",
"datePeriod": "2019-08-24",
"price": 0,
"quantity": 0,
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string"
}
],
"budgetAccountId": "string",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string",
"mappedBudgetAccount": {"mappingId": "string",
"reportingLineId": "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": {"mappingId": "string",
"reportingLineId": "string"
},
"revenueRecognition": {"mappingId": "string",
"reportingLineId": "string"
}
}
],
"productRevenues": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"budgetVersionId": "string",
"productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string",
"productsRevenueChannels": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
"name": "string",
"productsRevenueItems": [{"productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
"productsRevenueChannelId": "8d85ab2f-3d5b-42fb-b1e8-bea3670bb970",
"datePeriod": "2019-08-24",
"price": 0,
"quantity": 0,
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string"
}
],
"budgetAccountId": "string",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string",
"mappedBudgetAccount": {"mappingId": "string",
"reportingLineId": "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": {"mappingId": "string",
"reportingLineId": "string"
},
"revenueRecognition": {"mappingId": "string",
"reportingLineId": "string"
}
}
],
"productRevenues": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"budgetVersionId": "string",
"productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string",
"productsRevenueChannels": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
"name": "string",
"productsRevenueItems": [{"productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
"productsRevenueChannelId": "8d85ab2f-3d5b-42fb-b1e8-bea3670bb970",
"datePeriod": "2019-08-24",
"price": 0,
"quantity": 0,
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string"
}
],
"budgetAccountId": "string",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"createdAt": "string",
"updatedAt": "string",
"mappedBudgetAccount": {"mappingId": "string",
"reportingLineId": "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

[{"productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
"productName": "string",
"categories": [{"name": "string",
"dateItems": [{"datePeriod": "2019-08-24",
"value": 0
}
],
"mappedBudgetAccount": {"mappingId": "string",
"reportingLineId": "string"
}
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"productValues": [{"datePeriod": "2019-08-24",
"avgPrice": 0,
"quantity": 0
}
]
}
]

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

[{"cogsItemId": "76e7da50-168e-42c2-b0c6-c5f09bcc0daa",
"productName": "string",
"productValues": [{"datePeriod": "2019-08-24",
"avgPrice": 0,
"quantity": 0
}
],
"category": {"name": "string",
"dateItems": [{"datePeriod": "2019-08-24",
"value": 0
}
],
"mappedBudgetAccount": {"mappingId": "string",
"reportingLineId": "string"
}
},
"productInventoryTransactions": [{"datePeriod": "2019-08-24",
"purchaseAmount": 0
}
],
"startBalance": 0,
"safetyStock": 0,
"prepayments": [{"monthsBefore": 0,
"percentage": 10000
}
],
"inventoryBudgetAccount": {"mappingId": "string",
"reportingLineId": "string"
},
"prepaymentBudgetAccount": {"mappingId": "string",
"reportingLineId": "string"
},
"allCategories": [{"name": "string",
"dateItems": [{"datePeriod": "2019-08-24",
"value": 0
}
],
"mappedBudgetAccount": {"mappingId": "string",
"reportingLineId": "string"
}
}
]
}
]

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

200

Content type

application/json

[{"relationName": "string",
"productId": "string",
"productName": "string",
"description": "string",
"date": "2019-08-24",
"periodStartDate": "2019-08-24",
"periodEndDate": "2019-08-24",
"interval": "day",
"intervalCount": 0,
"recurringRevenueAmount": 0,
"cashFlowAmount": 0,
"recurringRevenueBudgetType": "model",
"amountType": "revenue",
"revenueType": "revenue"
}
]

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