Monitr API (1.2.0)
Download OpenAPI specification:Download
Engineering Team: engineering@monitr.be Terms of Service
Monitr's API
Get a list of budget versions
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
query Parameters
(https://monitr.be/budget/type.schema.json (https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string))) or (Array of https://monitr.be/budget/type.schema.json (https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string))) |
Responses
Create a new CRM budget version Deprecated
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
Request Body schema: application/json
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": {
- "budgetingType": "acrossProducts",
- "mappingId": "string"
}, - "parameters": {
- "rollingWindow": 1,
- "valueMethod": "weightedAverage"
}
}
}
Update a specific budget version
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
budgetVersionId required | string <uuid> |
Request Body schema: application/json
active | boolean |
initial | boolean |
name | string [ 1 .. 255 ] characters |
Responses
Request samples
- Payload
Content type
application/json
{- "active": true,
- "initial": true,
- "name": "string"
}
Create a new VAT budget version
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
Request Body schema: application/json
name required | string |
required | object |
Responses
Request samples
- 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 <uuid> |
Request Body schema: application/json
object or object | |
Array of objects | |
Array of objects non-empty |
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 <uuid> |
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"
}
]
}
]
}
Create a new outstanding items budget version
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
Request Body schema: application/json
name required | string non-empty |
required | object |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "settings": {
- "manualUnwindingItems": [
- {
- "outstandingItemId": "6b11e695-782b-40a1-b4c9-796136c98bff",
- "paymentDate": "2019-08-24",
- "enabled": true
}
], - "automaticUnwindingSettings": {
- "property1": {
- "property1": [
- {
- "paymentDelay": 0,
- "weight": 1,
- "enabled": true
}
], - "property2": [
- {
- "paymentDelay": 0,
- "weight": 1,
- "enabled": true
}
]
}, - "property2": {
- "property1": [
- {
- "paymentDelay": 0,
- "weight": 1,
- "enabled": true
}
], - "property2": [
- {
- "paymentDelay": 0,
- "weight": 1,
- "enabled": true
}
]
}
}, - "forecastPaymentTerms": [
- {
- "budgetAccountId": "string",
- "itemType": "payable",
- "paymentDelay": 1
}
], - "unwindBudgetAccounts": {
- "property1": {
- "property1": {
- "mappingId": "string",
- "name": "string"
}, - "property2": {
- "mappingId": "string",
- "name": "string"
}
}, - "property2": {
- "property1": {
- "mappingId": "string",
- "name": "string"
}, - "property2": {
- "mappingId": "string",
- "name": "string"
}
}
}
}
}
Update an outstanding items budget version
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
budgetVersionId required | string <uuid> |
Request Body schema: application/json
required | object | ||||||||
|
Responses
Request samples
- Payload
Content type
application/json
{- "settings": {
- "manualUnwindingItems": [
- {
- "outstandingItemId": "6b11e695-782b-40a1-b4c9-796136c98bff",
- "paymentDate": "2019-08-24",
- "enabled": true
}
], - "automaticUnwindingSettings": {
- "property1": {
- "property1": [
- {
- "paymentDelay": 0,
- "weight": 1,
- "enabled": true
}
], - "property2": [
- {
- "paymentDelay": 0,
- "weight": 1,
- "enabled": true
}
]
}, - "property2": {
- "property1": [
- {
- "paymentDelay": 0,
- "weight": 1,
- "enabled": true
}
], - "property2": [
- {
- "paymentDelay": 0,
- "weight": 1,
- "enabled": true
}
]
}
}, - "forecastPaymentTerms": [
- {
- "budgetAccountId": "string",
- "itemType": "payable",
- "paymentDelay": 1
}
], - "unwindBudgetAccounts": {
- "property1": {
- "property1": {
- "mappingId": "string",
- "name": "string"
}, - "property2": {
- "mappingId": "string",
- "name": "string"
}
}, - "property2": {
- "property1": {
- "mappingId": "string",
- "name": "string"
}, - "property2": {
- "mappingId": "string",
- "name": "string"
}
}
}
}
}
Get outstanding items budget version settings
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
budgetVersionId required | string <uuid> |
Responses
Response samples
- 200
Content type
application/json
{- "manualUnwindingItems": [
- {
- "outstandingItemId": "6b11e695-782b-40a1-b4c9-796136c98bff",
- "paymentDate": "2019-08-24",
- "enabled": true
}
], - "automaticUnwindingSettings": {
- "property1": {
- "property1": [
- {
- "paymentDelay": 0,
- "weight": 1,
- "enabled": true
}
], - "property2": [
- {
- "paymentDelay": 0,
- "weight": 1,
- "enabled": true
}
]
}, - "property2": {
- "property1": [
- {
- "paymentDelay": 0,
- "weight": 1,
- "enabled": true
}
], - "property2": [
- {
- "paymentDelay": 0,
- "weight": 1,
- "enabled": true
}
]
}
}, - "forecastPaymentTerms": [
- {
- "budgetAccountId": "string",
- "itemType": "payable",
- "paymentDelay": 1
}
], - "unwindBudgetAccounts": {
- "property1": {
- "property1": {
- "mappingId": "string",
- "name": "string"
}, - "property2": {
- "mappingId": "string",
- "name": "string"
}
}, - "property2": {
- "property1": {
- "mappingId": "string",
- "name": "string"
}, - "property2": {
- "mappingId": "string",
- "name": "string"
}
}
}
}
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",
- "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 |
required | string or null |
name required | string |
mapping_id required | string |
string or null | |
required | (https://monitr.be/budget/type.schema.json (https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string) or https://monitr.be/budget/type.schema.json (string))) or null |
Responses
Request samples
- Payload
Content type
application/json
[- {
- "id": "string",
- "original_id": "string",
- "name": "string",
- "mapping_id": "string",
- "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
required | string or Array of strings |
required | string or null |
required | string or null |
required | string or null |
Responses
Response samples
- 200
Content type
application/json
[- {
- "budgetVersionId": "46793ce2-4beb-4128-be66-694417ef433c",
- "budgetAccountId": "string",
- "period": "2019-08-24",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "amount": 0,
- "budgetType": "budget"
}
]
Get all the budget lines from a budget version for a specific budget account id
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
budgetVersionId required | string <uuid> |
query Parameters
required | Array of strings or string |
startDate required | string <date> |
endDate required | string <date> |
Responses
Response samples
- 200
Content type
application/json
[- {
- "budgetAccountId": "string",
- "datePeriod": "2019-08-24",
- "amount": 0
}
]
Get initial budgets by reporting line
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
lineId required | string |
query Parameters
report required | string Enum: "PL" "BS" "CF" |
from required | string <date> |
to required | string <date> |
mappingId | string |
axis | Array of strings or arrays or string |
limit | number [ 1 .. 1000 ] Default: 1000 |
offset | number >= 0 Default: 0 |
orderBy | string^([a-zA-Z-_]+):(ASC|DESC)$ Default: "date_period:ASC" |
Array of strings or string |
Responses
Get the products for a specific budget version
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
budgetVersionId required | string <uuid> |
Responses
Response samples
- 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": "46793ce2-4beb-4128-be66-694417ef433c",
- "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",
- "recurringRevenueMappingId": "string",
- "revenueRecognitionMappingId": "string"
}
], - "productRevenues": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "budgetVersionId": "46793ce2-4beb-4128-be66-694417ef433c",
- "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",
- "revenueChannel": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "budgetVersionId": "46793ce2-4beb-4128-be66-694417ef433c",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5"
}, - "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",
- "mappingId": "string"
}
]
}
]
}
]
Get the products for a specific budget version
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
budgetVersionId required | string <uuid> |
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": "46793ce2-4beb-4128-be66-694417ef433c",
- "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",
- "recurringRevenueMappingId": "string",
- "revenueRecognitionMappingId": "string"
}
], - "productRevenues": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "budgetVersionId": "46793ce2-4beb-4128-be66-694417ef433c",
- "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",
- "revenueChannel": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "budgetVersionId": "46793ce2-4beb-4128-be66-694417ef433c",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5"
}, - "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",
- "mappingId": "string"
}
]
}
]
}
]
Get the products for a specific budget version
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
budgetVersionId required | string <uuid> |
Responses
Response samples
- 200
Content type
application/json
[- {
- "productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
- "productName": "string",
- "productValues": [
- {
- "datePeriod": "2019-08-24",
- "avgPrice": 0,
- "quantity": 0
}
], - "categories": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "dateItems": [
- {
- "datePeriod": "2019-08-24",
- "value": 0
}
], - "mappingId": "string"
}
]
}
]
Get the products for a specific budget version
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
budgetVersionId required | string <uuid> |
Responses
Response samples
- 200
Content type
application/json
[- {
- "cogsProductId": "805730b7-2d97-497b-9606-f17e22590092",
- "productName": "string",
- "productValues": [
- {
- "datePeriod": "2019-08-24",
- "avgPrice": 0,
- "quantity": 0
}
], - "category": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "dateItems": [
- {
- "datePeriod": "2019-08-24",
- "value": 0
}
], - "mappingId": "string"
}, - "productInventoryTransactions": [
- {
- "datePeriod": "2019-08-24",
- "purchaseAmount": 0
}
], - "startBalance": 0,
- "safetyStock": 0,
- "prepayments": [
- {
- "monthsBefore": 0,
- "percentage": 10000
}
], - "inventoryMappingId": "string",
- "prepaymentMappingId": "string",
- "productRevenueId": "441f09ca-d855-4037-a34a-2fd72b91e20b",
- "allCategories": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "dateItems": [
- {
- "datePeriod": "2019-08-24",
- "value": 0
}
], - "mappingId": "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",
- "subscriptionNumber": "string",
- "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": "string",
- "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 <uuid> |
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 |
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 <uuid> |
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 |
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"
}
Set all the budgets for a specific business entity
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
forecastId required | string <uuid> |
scenarioId required | string <uuid> |
Request Body schema: application/json
required | object |
required | Array of objects |
Responses
Request samples
- Payload
Content type
application/json
{- "budgetVersion": {
- "name": "string",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "budgetTransactions": [
- {
- "budgetAccountId": "string",
- "budgetAccount": {
- "id": "string",
- "name": "string",
- "mapping_id": "string",
- "comment": "string",
- "managed_by_budget_type": "budget"
}, - "period": "2019-08-24",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "amount": 0,
- "budgetType": "budget"
}
]
}
Set all the budgets for a specific business entity
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
forecastId required | string <uuid> |
scenarioId required | string <uuid> |
Request Body schema: application/json
selectedBudgetVersionId required | string <uuid> |
required | object |
required | Array of objects |
Responses
Request samples
- Payload
Content type
application/json
{- "selectedBudgetVersionId": "5362734c-523c-4fea-bcc9-abe199f9e007",
- "budgetVersion": {
- "name": "string",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "budgetTransactions": [
- {
- "budgetAccountId": "string",
- "budgetAccount": {
- "id": "string",
- "name": "string",
- "mapping_id": "string",
- "comment": "string",
- "managed_by_budget_type": "budget"
}, - "period": "2019-08-24",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "amount": 0,
- "budgetType": "budget"
}
]
}
Get costs and cashflows per personnel member of the given budget version
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
budgetVersionId required | string <uuid> |
Responses
Response samples
- 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 <uuid> |
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 <uuid> |
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
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.
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
{- "checkBS": [
- {
- "date": "2019-08-24",
- "amount": 0,
- "bool": true
}
], - "checkPLvBS": [
- {
- "date": "2019-08-24",
- "bool": true,
- "amount": 0,
- "delta": 0
}
], - "checkCFvBS": [
- {
- "date": "2019-08-24",
- "bool": true,
- "amount": 0,
- "delta": 0,
- "amountBSBank": 0
}
], - "hasUnmappedAccounts": true,
- "unmappedProducts": [
- {
- "name": "string",
- "icon": "string",
- "products": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
]
}
], - "budgetAccountsWithoutVatRates": [
- {
- "id": "string",
- "name": "string"
}
]
}
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"
}
}
]
}
]
}
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 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
}
]
}
Get all general ledger transactions by mapping ids
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
query Parameters
required | Array of strings or string |
startDate required | string <date> |
endDate required | string <date> |
Responses
Response samples
- 200
Content type
application/json
[- {
- "mappingId": "string",
- "datePeriod": "2019-08-24",
- "amount": 0
}
]
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 all transactions and budgets by optional reporting line
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
lineId required | string |
query Parameters
report required | string Enum: "PL" "BS" "CF" |
reportType required | string Enum: "actuals" "forecast" "delta" |
type | string Enum: "general_ledger" "adjusting_entry" |
from required | string <date> |
lda required | string <date> |
to required | string <date> |
mappingId | string |
axis | Array of strings or arrays or string |
Array of strings or string | |
aggregation | string Default: "month" |
limit | number [ 1 .. 1000 ] Default: 1000 |
offset | number >= 0 Default: 0 |
orderBy | string^([a-zA-Z-_]+):(ASC|DESC)$ Default: "date_period:ASC" |
pivotColumn | string |
Responses
Get all transactions and budgets by optional reporting line
Authorizations:
bearerAuth
path Parameters
orgId required | string <uuid> |
lineId required | string |
query Parameters
report required | string Enum: "PL" "BS" "CF" |
reportType required | string Enum: "actuals" "forecast" "delta" |
from required | string <date> |
lda required | string <date> |
to required | string <date> |
mappingId | string |
aggregation | string Default: "month" Enum: "year" "quarter" "month" "entity" |
aggregationType | string Enum: "period" "entity" |
limit | number [ 1 .. 1000 ] Default: 1000 |
offset | number >= 0 Default: 0 |
orderBy | string^([a-zA-Z-_]+):(ASC|DESC)$ Default: "date_period:ASC" |
pivotColumn | string |
Responses
Import 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"
}
/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"
}
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"
}
]
Set the list of reporting lines for the cash flow report
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
Request Body schema: application/json
Array
id required | string |
name required | string |
rank required | number |
required | string or null |
top required | boolean |
Responses
Request samples
- Payload
Content type
application/json
[- {
- "id": "string",
- "name": "string",
- "rank": 0,
- "parentId": "string",
- "top": true
}
]
Set the list of reporting lines for a specific report
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
report required | string Enum: "PL" "BS" Example: PL |
Request Body schema: application/json
required | Array of objects | ||||||||||||
Array
|
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) | ||||
|
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"
}
]
}
}
}
Set the list of reporting lines for the cash flow report
Authorizations:
bearerAuth
path Parameters
orgId required | string <uuid> |
Request Body schema: application/json
Array
id required | string |
name required | string |
rank required | number |
required | string or null |
top required | boolean |
Responses
Request samples
- Payload
Content type
application/json
[- {
- "id": "string",
- "name": "string",
- "rank": 0,
- "parentId": "string",
- "top": true
}
]
Set the list of reporting lines for a specific report
Authorizations:
bearerAuth
path Parameters
orgId required | string <uuid> |
report required | string Enum: "PL" "BS" Example: PL |
Request Body schema: application/json
required | Array of objects | ||||||||||||
Array
|
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
}
]
}
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"
}
]
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"
}
]
Set the list of reporting lines for the cash flow report
Authorizations:
bearerAuth
path Parameters
orgId required | string <uuid> |
Request Body schema: application/json
Array
id required | string |
name required | string |
rank required | number |
required | string or null |
top required | boolean |
Responses
Request samples
- Payload
Content type
application/json
[- {
- "id": "string",
- "name": "string",
- "rank": 0,
- "parentId": "string",
- "top": true
}
]
Set the list of reporting lines for a specific report
Authorizations:
bearerAuth
path Parameters
orgId required | string <uuid> |
report required | string Enum: "PL" "BS" Example: PL |
Request Body schema: application/json
required | Array of objects | ||||||||||||
Array
|
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
}
]
}
Set the list of adjusting entries for and organisation
Authorizations:
bearerAuth
path Parameters
orgId required | string <uuid> |
Request Body schema: application/json
Array
id required | string |
datePeriod required | string <date> |
description required | string |
amount required | number |
entityIdFrom required | string <uuid> |
entityIdTo required | string <uuid> |
glAccountId required | string |
required | string or null |
required | string or null |
required | object or null |
Responses
Request samples
- 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 report validation of your organisation's consolidation
Authorizations:
bearerAuth
path Parameters
orgId required | string <uuid> |
query Parameters
required | string or string |
Responses
Response samples
- 200
Content type
application/json
{- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}
Get a specific report by report type and view
Authorizations:
bearerAuth
path Parameters
orgId required | string <uuid> |
report required | string Enum: "PL" "BS" "CF" |
reportType required | string Enum: "actuals" "forecast" "delta" |
query Parameters
from required | string <date> |
lda required | string <date> |
to required | string <date> |
aggregation required | string Enum: "year" "quarter" "month" "entity" Example: aggregation=month |
aggregationType | string Enum: "period" "entity" |
selectedDeltaComparison | string |
Responses
Get a specific report by report type and view
Authorizations:
bearerAuth
path Parameters
orgId required | string <uuid> |
report required | string Enum: "PL" "BS" "CF" |
reportType required | string Enum: "actuals" "forecast" "delta" |
query Parameters
from required | string <date> |
lda required | string <date> |
to required | string <date> |
aggregation required | string Enum: "year" "quarter" "month" "entity" Example: aggregation=month |
aggregationType | string Enum: "period" "entity" |
selectedDeltaComparison | string |
Responses
Get the graph data for a specific report
Authorizations:
bearerAuth
path Parameters
orgId required | string <uuid> |
report required | string Enum: "PL" "BS" "CF" |
reportType required | string Enum: "actuals" "forecast" "delta" |
query Parameters
from required | string <date> |
lda required | string <date> |
to required | string <date> |
selectedDeltaComparison | string |
line | string |
mappingId | string |
aggregation required | string Enum: "year" "quarter" "month" "entity" Example: aggregation=month |
aggregationType | string Enum: "period" "entity" |
pivotColumn | string |
Responses
Set the list of custom metrics
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
Request Body schema: application/json
required | Array of objects | ||||||
Array
|
Responses
Request samples
- Payload
Content type
application/json
{- "customMetrics": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "Revenue",
- "reporting_line_id": "string"
}
]
}
Set the list of custom metrics
Authorizations:
bearerAuth
path Parameters
orgId required | string <uuid> |
Request Body schema: application/json
required | Array of objects | ||||||
Array
|
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 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> |
required | string or null |
glAccountId required | string |
required | string or null |
amount required | number |
required | string or null |
required | string or null |
Responses
Request samples
- 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 |
required | string or null |
required | string or null |
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 a list of all outstanding receivables
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
Responses
Response samples
- 200
Content type
application/json
[- {
- "id": "string",
- "transaction_code": "string",
- "due_date": "2019-08-24",
- "relation_name": "string",
- "amount": "string",
- "amount_outstanding": "string",
- "general_ledger": {
- "transaction_code": "string"
}
}
]
Get a list of all outstanding payables
Authorizations:
bearerAuth
path Parameters
entityId required | string <uuid> |
Responses
Response samples
- 200
Content type
application/json
[- {
- "id": "string",
- "transaction_code": "string",
- "due_date": "2019-08-24",
- "relation_name": "string",
- "amount": "string",
- "amount_outstanding": "string",
- "general_ledger": {
- "transaction_code": "string"
}
}
]