CampusAPI Budgeting Services API documentation version N/A
NOTICE - The CampusAPI Documentation has moved.
Please point your browser to CampusAPI.org for the latest versions.
https://demo.dxtera.org/open/campusapi/budgeting
Overview
The Financials Budgeting package manages budgets.
This package includes the following entities:
Budgets
A Budget relates a Financial Activity to a FiscalPeriod and is composed of BudgetEntries.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this budget, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this budget, provided by system. | string(uri) |
| displayName | The name of this budget for display. | string |
| description | The description of this budget. | string |
| genusType (read‑only) | The immutable type of this budget. Default type set by system unless specified in query parameter. | string(osid‑type) |
| startDate | The starting date of this budget. | string(date‑time) |
| endDate | The ending date of this budget. | string(date‑time) |
| endReasonId | The reason this budget ended. References a process.State object. | string(osid‑id) |
| activityId (read‑only) | The activity associated with this budget. References a financials.Activity object. | string(osid‑id) |
| fiscalPeriodId (read‑only) | The fiscal period associated with this budget. References a financials.Activity object. References a financials.FiscalPeriod object. | string(osid‑id) |
BudgetEntries
A BudgetEntry is relationship relating a Budget to a general ledger Account. The BudgetEntry includes the amount budgeted.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this budget entry, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this budget entry, provided by system. | string(uri) |
| displayName | The name of this budget entry for display. | string |
| description | The description of this budget entry. | string |
| genusType (read‑only) | The immutable type of this budget entry. Default type set by system unless specified in query parameter. | string(osid‑type) |
| startDate | The starting date of this budget entry. | string(date‑time) |
| endDate | The ending date of this budget entry. | string(date‑time) |
| endReasonId | The reason this budget entry ended. References a process.State object. | string(osid‑id) |
| budgetId (read‑only) | The budget associated with this budget entry. References a budgeting.Budget object. | string(osid‑id) |
| accountId (read‑only) | The account associated with this budget entry. References a budgeting.Budget object. References a financials.Account object. | string(osid‑id) |
| amount | The amount of this budget entries. | string(currency) |
| debit | Tests if the budgeted amount is to be debited or a credited to this activity. | boolean |
Businesses
Accounts, Activities, and FiscalPeriods are organized into federaable Businesses.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this business, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this business, provided by system. | string(uri) |
| displayName | The name of this business for display. | string |
| description | The description of this business. | string |
| genusType (read‑only) | The immutable type of this business. Default type set by system unless specified in query parameter. | string(osid‑type) |
| providerId | The provider of this business. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this business. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this business. | string |
License
CampusAPI REST Documentation Copyright 2020 DXtera Institute. Based on the Open Service Interface Defitions: http://osid.org
/budgets
Collection of budgets in a system, federation of systems, or in a default business.
get
Get all budgets in the system or default business.
post
Create a new budget in the default business.
get /budgets
Get all budgets in the system or default business.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusType: (string)
The id string to match a genusType
Example:
type.Type%3AexampleBudgetType%40dxtera.org - parentGenusType: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleBudgetType%40dxtera.org - fromDate: (string)
Get all budgets from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all budgets up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - activityId: (string)
the id string to match a activity.
Example:
financials.Activity%3A480%40demo.dxtera.org - fiscalPeriodId: (string)
the id string to match a fiscal-period.
Example:
financials.FiscalPeriod%3A780%40demo.dxtera.org - businessId: (string)
The id string to match a business
Example:
financials.Business%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "budgeting.Budget:2535@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/budgeting/budget/budgeting.Budget%3A2535%40demo.dxtera.org",
"displayName": "Display Name of this Budget",
"description": "The description of this Budget",
"genusType": "type.Type:defaultBudgetType@dxtera.org",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:2535@demo.dxtera.org",
"activityId": "financials.Activity:4771@demo.dxtera.org",
"fiscalPeriodId": "financials.FiscalPeriod:1002@demo.dxtera.org"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /budgets
Create a new budget in the default business.
Query Parameters
- activityId: required(string)
the activity of this budget.
Example:
financials.Activity%3A480%40demo.dxtera.org - fiscalPeriodId: required(string)
the fiscal-period of this budget.
Example:
financials.FiscalPeriod%3A780%40demo.dxtera.org - genusType: (string)
specify a particular budget type to create
Example:
type.Type%3AexampleBudgetType%40dxtera.org - businessId: (string)
specify in which business to create this budget
Example:
budgeting.Business%3A8374%40demo.dxtera.org
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Budget",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this budget, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this budget, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this budget for display.",
"type": "string"
},
"description": {
"description": "The description of this budget.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this budget. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this budget.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this budget.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this budget ended.",
"type": "string",
"format": "osid-id"
},
"activityId": {
"description": "The activity associated with this budget.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"fiscalPeriodId": {
"description": "The fiscal period associated with this budget.",
"type": "string",
"format": "osid-id",
"readOnly": true
}
}
}Example:
{
"id": "budgeting.Budget:9826@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/budgeting/budget/budgeting.Budget%3A9826%40demo.dxtera.org",
"displayName": "Display Name of this Budget",
"description": "The description of this Budget",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:9826@demo.dxtera.org"
}
Entity representing a budget form metadata.
get
Get form metadata for creating a new budget.
get /budgets/metadata
Get form metadata for creating a new budget.
Query Parameters
- activityId: required(string)
the activity of this metadatum.
Example:
financials.Activity%3A480%40demo.dxtera.org - fiscalPeriodId: required(string)
the fiscal-period of this metadatum.
Example:
financials.FiscalPeriod%3A780%40demo.dxtera.org - genusType: (string)
specify a particular budget type to create
Example:
type.Type%3AexampleBudgetType%40dxtera.org - businessId: (string)
specify in which business to create this budget
Example:
budgeting.Business%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Budget",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this budget, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this budget, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this budget for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Budget.Budget:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this budget",
"linked": false
},
"description": {
"description": "The description of this budget.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Budget.Budget:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this budget",
"linked": false
},
"genusType": {
"description": "The immutable type of this budget. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this budget.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Budget.Budget:startDate@demo.dxtera.org",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this budget",
"linked": false
},
"endDate": {
"description": "The ending date of this budget.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Budget.Budget:endDate@demo.dxtera.org",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this budget",
"linked": false
},
"endReasonId": {
"description": "The reason this budget ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Budget.Budget:endReason@demo.dxtera.org",
"existingValue": "process.State:1860@demo.dxtera.org",
"elementLabel": "End Reason",
"instructions": "Select the reason this budget ended",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a budget
get
Get a budget given its id.
put
Update a given budget.
delete
Delete a given budget.
get /budgets/{budgetId}
Get a budget given its id.
URI Parameters
- budgetId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "budgeting.Budget:2535@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/budgeting/budget/budgeting.Budget%3A2535%40demo.dxtera.org",
"displayName": "Display Name of this Budget",
"description": "The description of this Budget",
"genusType": "type.Type:defaultBudgetType@dxtera.org",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:2535@demo.dxtera.org",
"activityId": "financials.Activity:4771@demo.dxtera.org",
"fiscalPeriodId": "financials.FiscalPeriod:1002@demo.dxtera.org"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "budget not found" }
put /budgets/{budgetId}
Update a given budget.
URI Parameters
- budgetId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Budget",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this budget, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this budget, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this budget for display.",
"type": "string"
},
"description": {
"description": "The description of this budget.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this budget. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this budget.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this budget.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this budget ended.",
"type": "string",
"format": "osid-id"
},
"activityId": {
"description": "The activity associated with this budget.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"fiscalPeriodId": {
"description": "The fiscal period associated with this budget.",
"type": "string",
"format": "osid-id",
"readOnly": true
}
}
}Example:
{
"id": "budgeting.Budget:9826@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/budgeting/budget/budgeting.Budget%3A9826%40demo.dxtera.org",
"displayName": "Display Name of this Budget",
"description": "The description of this Budget",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:9826@demo.dxtera.org"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The budget has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "budget not found" }
delete /budgets/{budgetId}
Delete a given budget.
URI Parameters
- budgetId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The budget has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "budget not found" }
Entity representing a budget form metadata for update
get
Get form metadata for updating an existing budget.
get /budgets/{budgetId}/metadata
Get form metadata for updating an existing budget.
URI Parameters
- budgetId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Budget",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this budget, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this budget, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this budget for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Budget.Budget:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this budget",
"linked": false
},
"description": {
"description": "The description of this budget.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Budget.Budget:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this budget",
"linked": false
},
"genusType": {
"description": "The immutable type of this budget. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this budget.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Budget.Budget:startDate@demo.dxtera.org",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this budget",
"linked": false
},
"endDate": {
"description": "The ending date of this budget.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Budget.Budget:endDate@demo.dxtera.org",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this budget",
"linked": false
},
"endReasonId": {
"description": "The reason this budget ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Budget.Budget:endReason@demo.dxtera.org",
"existingValue": "process.State:1860@demo.dxtera.org",
"elementLabel": "End Reason",
"instructions": "Select the reason this budget ended",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "budget not found" }
/budget-entries
Collection of budget-entries in a system, federation of systems, or in a default business.
get
Get all budget-entries in the system or default business.
post
Create a new budget-entry in the default business.
get /budget-entries
Get all budget-entries in the system or default business.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusType: (string)
The id string to match a genusType
Example:
type.Type%3AexampleBudgetEntryType%40dxtera.org - parentGenusType: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleBudgetEntryType%40dxtera.org - fromDate: (string)
Get all budget-entries from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all budget-entries up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - budgetId: (string)
the id string to match a budget.
Example:
budgeting.Budget%3A594%40demo.dxtera.org - accountId: (string)
the id string to match a account.
Example:
financials.Account%3A770%40demo.dxtera.org - businessId: (string)
The id string to match a business
Example:
financials.Business%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "budgeting.BudgetEntry:9134@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/budgeting/budgetEntry/budgeting.BudgetEntry%3A9134%40demo.dxtera.org",
"displayName": "Display Name of this BudgetEntry",
"description": "The description of this BudgetEntry",
"genusType": "type.Type:defaultBudgetEntryType@dxtera.org",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:9134@demo.dxtera.org",
"budgetId": "financials.budgeting.Budget:9699@demo.dxtera.org",
"accountId": "financials.Account:9698@demo.dxtera.org",
"amount": "USD+42.00",
"debit": true
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /budget-entries
Create a new budget-entry in the default business.
Query Parameters
- budgetId: required(string)
the budget of this budget-entry.
Example:
budgeting.Budget%3A594%40demo.dxtera.org - accountId: required(string)
the account of this budget-entry.
Example:
financials.Account%3A770%40demo.dxtera.org - genusType: (string)
specify a particular budgetEntry type to create
Example:
type.Type%3AexampleBudgetEntryType%40dxtera.org - businessId: (string)
specify in which business to create this budgetEntry
Example:
budgeting.Business%3A8374%40demo.dxtera.org
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "BudgetEntry",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this budget entry, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this budget entry, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this budget entry for display.",
"type": "string"
},
"description": {
"description": "The description of this budget entry.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this budget entry. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this budget entry.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this budget entry.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this budget entry ended.",
"type": "string",
"format": "osid-id"
},
"budgetId": {
"description": "The budget associated with this budget entry.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"accountId": {
"description": "The account associated with this budget entry.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"amount": {
"description": "The amount of this budget entries.",
"type": "string",
"format": "currency"
},
"debit": {
"description": "Tests if the budgeted amount is to be debited or a credited to this activity.",
"type": "boolean"
}
}
}Example:
{
"id": "budgeting.BudgetEntry:9800@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/budgeting/budgetEntry/budgeting.BudgetEntry%3A9800%40demo.dxtera.org",
"displayName": "Display Name of this BudgetEntry",
"description": "The description of this BudgetEntry",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:9800@demo.dxtera.org",
"amount": "USD+42.00",
"debit": true
}
Entity representing a budgetEntry form metadata.
get
Get form metadata for creating a new budgetEntry.
get /budget-entries/metadata
Get form metadata for creating a new budgetEntry.
Query Parameters
- budgetId: required(string)
the budget of this metadatum.
Example:
budgeting.Budget%3A594%40demo.dxtera.org - accountId: required(string)
the account of this metadatum.
Example:
financials.Account%3A770%40demo.dxtera.org - genusType: (string)
specify a particular budgetEntry type to create
Example:
type.Type%3AexampleBudgetEntryType%40dxtera.org - businessId: (string)
specify in which business to create this budgetEntry
Example:
budgeting.Business%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "BudgetEntry",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this budget entry, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this budget entry, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this budget entry for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "BudgetEntry.BudgetEntry:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this budget entry",
"linked": false
},
"description": {
"description": "The description of this budget entry.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "BudgetEntry.BudgetEntry:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this budget entry",
"linked": false
},
"genusType": {
"description": "The immutable type of this budget entry. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this budget entry.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "BudgetEntry.BudgetEntry:startDate@demo.dxtera.org",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this budget entry",
"linked": false
},
"endDate": {
"description": "The ending date of this budget entry.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "BudgetEntry.BudgetEntry:endDate@demo.dxtera.org",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this budget entry",
"linked": false
},
"endReasonId": {
"description": "The reason this budget entry ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "BudgetEntry.BudgetEntry:endReason@demo.dxtera.org",
"existingValue": "process.State:1860@demo.dxtera.org",
"elementLabel": "End Reason",
"instructions": "Select the reason this budget entry ended",
"linked": false
},
"amount": {
"description": "The amount of this budget entries.",
"type": "string",
"format": "currency",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.budgeting.BudgetEntry:amount@dxtera.org",
"existingValue": "USD+120.56",
"elementLabel": "Amount",
"instructions": "Enter the amount of this budget entry.",
"linked": false
},
"debit": {
"description": "Tests if the budgeted amount is to be debited or a credited to this activity.",
"type": "boolean",
"elementId": "financials.budgeting.BudgetEntry:debit@dxtera.org",
"existingValue": false,
"elementLabel": "Debit",
"instructions": "Enter true or false.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a budget-entry
get
Get a budget-entry given its id.
put
Update a given budget-entry.
delete
Delete a given budget-entry.
get /budget-entries/{budgetEntryId}
Get a budget-entry given its id.
URI Parameters
- budgetEntryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "budgeting.BudgetEntry:9134@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/budgeting/budgetEntry/budgeting.BudgetEntry%3A9134%40demo.dxtera.org",
"displayName": "Display Name of this BudgetEntry",
"description": "The description of this BudgetEntry",
"genusType": "type.Type:defaultBudgetEntryType@dxtera.org",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:9134@demo.dxtera.org",
"budgetId": "financials.budgeting.Budget:9699@demo.dxtera.org",
"accountId": "financials.Account:9698@demo.dxtera.org",
"amount": "USD+42.00",
"debit": true
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "budget-entry not found" }
put /budget-entries/{budgetEntryId}
Update a given budget-entry.
URI Parameters
- budgetEntryId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "BudgetEntry",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this budget entry, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this budget entry, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this budget entry for display.",
"type": "string"
},
"description": {
"description": "The description of this budget entry.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this budget entry. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this budget entry.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this budget entry.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this budget entry ended.",
"type": "string",
"format": "osid-id"
},
"budgetId": {
"description": "The budget associated with this budget entry.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"accountId": {
"description": "The account associated with this budget entry.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"amount": {
"description": "The amount of this budget entries.",
"type": "string",
"format": "currency"
},
"debit": {
"description": "Tests if the budgeted amount is to be debited or a credited to this activity.",
"type": "boolean"
}
}
}Example:
{
"id": "budgeting.BudgetEntry:9800@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/budgeting/budgetEntry/budgeting.BudgetEntry%3A9800%40demo.dxtera.org",
"displayName": "Display Name of this BudgetEntry",
"description": "The description of this BudgetEntry",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:9800@demo.dxtera.org",
"amount": "USD+42.00",
"debit": true
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The budget-entry has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "budget-entry not found" }
delete /budget-entries/{budgetEntryId}
Delete a given budget-entry.
URI Parameters
- budgetEntryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The budget-entry has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "budget-entry not found" }
Entity representing a budgetEntry form metadata for update
get
Get form metadata for updating an existing budgetEntry.
get /budget-entries/{budgetEntryId}/metadata
Get form metadata for updating an existing budgetEntry.
URI Parameters
- budgetEntryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "BudgetEntry",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this budget entry, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this budget entry, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this budget entry for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "BudgetEntry.BudgetEntry:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this budget entry",
"linked": false
},
"description": {
"description": "The description of this budget entry.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "BudgetEntry.BudgetEntry:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this budget entry",
"linked": false
},
"genusType": {
"description": "The immutable type of this budget entry. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this budget entry.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "BudgetEntry.BudgetEntry:startDate@demo.dxtera.org",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this budget entry",
"linked": false
},
"endDate": {
"description": "The ending date of this budget entry.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "BudgetEntry.BudgetEntry:endDate@demo.dxtera.org",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this budget entry",
"linked": false
},
"endReasonId": {
"description": "The reason this budget entry ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "BudgetEntry.BudgetEntry:endReason@demo.dxtera.org",
"existingValue": "process.State:1860@demo.dxtera.org",
"elementLabel": "End Reason",
"instructions": "Select the reason this budget entry ended",
"linked": false
},
"amount": {
"description": "The amount of this budget entries.",
"type": "string",
"format": "currency",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.budgeting.BudgetEntry:amount@dxtera.org",
"existingValue": "USD+120.56",
"elementLabel": "Amount",
"instructions": "Enter the amount of this budget entry.",
"linked": false
},
"debit": {
"description": "Tests if the budgeted amount is to be debited or a credited to this activity.",
"type": "boolean",
"elementId": "financials.budgeting.BudgetEntry:debit@dxtera.org",
"existingValue": false,
"elementLabel": "Debit",
"instructions": "Enter true or false.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "budgetEntry not found" }
/businesses
Collection of businesses in a system or federation of systems.
get
Get all businesses.
post
Create a new business.
get /businesses
Get all businesses.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusType: (string)
The id string to match a genusType
Example:
type.Type%3AexampleBusinessType%40dxtera.org - parentGenusType: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleBusinessType%40dxtera.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3007%40demo.dxtera.org - budgetId: (string)
Get businesses mapped to this budget.
Example:
budgeting.Budget%3A432%40demo.dxtera.org - budgetEntryId: (string)
Get businesses mapped to this budget-entry.
Example:
budgeting.BudgetEntry%3A864%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Business:9944@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/financials/business/financials.Business%3A9944%40demo.dxtera.org",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"genusType": "type.Type:defaultBusinessType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Business@demo.dxtera.org",
"license": "The license that applies to this Business"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /businesses
Create a new business.
Query Parameters
- genusType: (string)
specify a particular business type to create
Example:
type.Type%3AexampleBusinessType%40dxtera.org
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Business",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this business, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this business, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this business for display.",
"type": "string"
},
"description": {
"description": "The description of this business.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this business. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this business.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this business. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this business.",
"type": "string"
}
}
}Example:
{
"id": "financials.Business:7975@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/financials/business/financials.Business%3A7975%40demo.dxtera.org",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Business@demo.dxtera.org",
"license": "The license that applies to this Business"
}
Entity representing a business form metadata.
get
Get form metadata for creating a new business.
get /businesses/metadata
Get form metadata for creating a new business.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Business",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this business, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this business, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this business for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this business",
"linked": false
},
"description": {
"description": "The description of this business.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this business",
"linked": false
},
"genusType": {
"description": "The immutable type of this business. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this business.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:provider@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this business",
"linked": false
},
"brandingIds": {
"description": "The branding of this business. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Business.Business:branding@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this business",
"linked": false
},
"license": {
"description": "The licensing that applies to this business.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:license@demo.dxtera.org",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this business",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root businesses in the business hierarchy. A node with no parents is an orphan. While all business Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
get
Get all root root-business
get /businesses/root-business
Get all root root-business
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Business:9944@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/financials/business/financials.Business%3A9944%40demo.dxtera.org",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"genusType": "type.Type:defaultBusinessType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Business@demo.dxtera.org",
"license": "The license that applies to this Business"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a business
get
Get a business given its id.
put
Update a given business.
delete
Delete a given business.
get /businesses/{businessId}
Get a business given its id.
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "financials.Business:9944@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/financials/business/financials.Business%3A9944%40demo.dxtera.org",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"genusType": "type.Type:defaultBusinessType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Business@demo.dxtera.org",
"license": "The license that applies to this Business"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "business not found" }
put /businesses/{businessId}
Update a given business.
URI Parameters
- businessId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Business",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this business, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this business, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this business for display.",
"type": "string"
},
"description": {
"description": "The description of this business.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this business. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this business.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this business. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this business.",
"type": "string"
}
}
}Example:
{
"id": "financials.Business:7975@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/financials/business/financials.Business%3A7975%40demo.dxtera.org",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Business@demo.dxtera.org",
"license": "The license that applies to this Business"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The business has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "business not found" }
delete /businesses/{businessId}
Delete a given business.
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The business has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "business not found" }
Entity representing a business form metadata for update
get
Get form metadata for updating an existing business.
get /businesses/{businessId}/metadata
Get form metadata for updating an existing business.
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Business",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this business, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this business, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this business for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this business",
"linked": false
},
"description": {
"description": "The description of this business.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this business",
"linked": false
},
"genusType": {
"description": "The immutable type of this business. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this business.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:provider@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this business",
"linked": false
},
"brandingIds": {
"description": "The branding of this business. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Business.Business:branding@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this business",
"linked": false
},
"license": {
"description": "The licensing that applies to this business.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:license@demo.dxtera.org",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this business",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "business not found" }
get
Get children businesses for the given business in the hierarchy.
get /businesses/{businessId}/children
Get children businesses for the given business in the hierarchy.
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Business:9944@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/financials/business/financials.Business%3A9944%40demo.dxtera.org",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"genusType": "type.Type:defaultBusinessType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Business@demo.dxtera.org",
"license": "The license that applies to this Business"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add business as child of the given business in the hierarchy.
delete
Remove the given business as a child of the given business in the hierarchy.
put /businesses/{businessId}/children/{childId}
Add business as child of the given business in the hierarchy.
URI Parameters
- businessId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child business has been added" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "business not found" }
delete /businesses/{businessId}/children/{childId}
Remove the given business as a child of the given business in the hierarchy.
get
Get all budgets in this business
get /businesses/{businessId}/budgets
Get all budgets in this business
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "budgeting.Budget:2535@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/budgeting/budget/budgeting.Budget%3A2535%40demo.dxtera.org",
"displayName": "Display Name of this Budget",
"description": "The description of this Budget",
"genusType": "type.Type:defaultBudgetType@dxtera.org",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:2535@demo.dxtera.org",
"activityId": "financials.Activity:4771@demo.dxtera.org",
"fiscalPeriodId": "financials.FiscalPeriod:1002@demo.dxtera.org"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given budget to this business
delete
Remove the given budget from the business.
put /businesses/{businessId}/budgets/{budgetId}
Add the given budget to this business
URI Parameters
- businessId: required(string)
- budgetId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "budget has been added to business" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "budget not found" }
delete /businesses/{businessId}/budgets/{budgetId}
Remove the given budget from the business.
URI Parameters
- businessId: required(string)
- budgetId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "budget has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "budget not found" }
get
Get all budget-entries in this business
get /businesses/{businessId}/budget-entries
Get all budget-entries in this business
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "budgeting.BudgetEntry:9134@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/budgeting/budgetEntry/budgeting.BudgetEntry%3A9134%40demo.dxtera.org",
"displayName": "Display Name of this BudgetEntry",
"description": "The description of this BudgetEntry",
"genusType": "type.Type:defaultBudgetEntryType@dxtera.org",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:9134@demo.dxtera.org",
"budgetId": "financials.budgeting.Budget:9699@demo.dxtera.org",
"accountId": "financials.Account:9698@demo.dxtera.org",
"amount": "USD+42.00",
"debit": true
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given budget-entry to this business
delete
Remove the given budget-entry from the business.
put /businesses/{businessId}/budget-entries/{budgetEntryId}
Add the given budget-entry to this business
URI Parameters
- businessId: required(string)
- budgetEntryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "budget-entry has been added to business" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "budget-entry not found" }
delete /businesses/{businessId}/budget-entries/{budgetEntryId}
Remove the given budget-entry from the business.
URI Parameters
- businessId: required(string)
- budgetEntryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "budget-entry has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "budget-entry not found" }