CampusAPI Financials Services API documentation version 0.1.2
Based on OSID version 3.0.0
https://base.url/financials
Overview
The Financials services provide management of financial data through G/L accounts, activity accounts, budgeting, and posting transactions.
This package includes the following entities:
Accounts
An Account is an account of the General Ledger. G/L Accounts are hierarchical to define more granular accounts. Root level accounts generally map to the top-level accounting equation.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this account, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this account, provided by system. | string(uri) |
| displayName | The name of this account for display. | string |
| description | The description of this account. | string |
| genusTypeId (read‑only) | Id of the immutable type of this account. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this account. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| creditBalance | Tests if this account is a credit or debit account. | boolean |
| code | A code for this G/L account. | string |
Activities
An Activity is a view of the General Ledger from an activity or organizational perspective. An Activity contains one or more Accounts from the General Ledger. Activities are also hierarchical and may be used to map to a financial organizational hierarchy.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this activity, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this activity, provided by system. | string(uri) |
| displayName | The name of this activity for display. | string |
| description | The description of this activity. | string |
| genusTypeId (read‑only) | Id of the immutable type of this activity. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this activity. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| startDate | The starting date of this activity. | string(date‑time) |
| endDate | The ending date of this activity. | string(date‑time) |
| organizationId | The organization associated with this activity. References a resource.Resource object | string(osid‑id) |
| supervisorId | The resource supervising this activity account. References a resource.Resource object | string(osid‑id) |
| code | The code for this activity account. | string |
FiscalPeriods
A FiscalPeriod is a period of time used to capture transactions and perform reporting. Generally, a fiscal period is a fiscal quarter or year.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this fiscal period, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this fiscal period, provided by system. | string(uri) |
| displayName | The name of this fiscal period for display. | string |
| description | The description of this fiscal period. | string |
| genusTypeId (read‑only) | Id of the immutable type of this fiscal period. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this fiscal period. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| displayLabel | A display label for this fiscal period which may be less formal than the display name. | string |
| fiscalYear | Ges the fiscal year. | integer |
| startDate | Get sthe start date of this period. | string(date‑time) |
| endDate | Get sthe end date of this period. | string(date‑time) |
| budgetDeadline | The budget deadline. | string(date‑time) |
| postingDeadline | The last date transactions can be posted for this period. | string(date‑time) |
| closing | The date of the closing for this period. | string(date‑time) |
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 |
| genusTypeId (read‑only) | Id of the immutable type of this business. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this business. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| 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
/accounts
Collection of accounts in a system, federation of systems, or in a default business.
get
Get all accounts in the system or default business.
post
Create a new account in the default business.
get /accounts
Get all accounts 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 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleAccountType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleAccountType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleAccountType%40campusapi.org - code: (string)
query string to match code.
Example:
S9374 - businessId: (string)
The id string to match a business
Example:
financials.Business%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Account:4434@base.url",
"uri": "http://base.url/open/campusapi/financials/account/financials.Account%3A4434%40base.url",
"displayName": "Display Name of this Account",
"description": "The description of this Account",
"genusTypeId": "type.Type:defaultAccountType@base.url",
"recordTypeIds": [ "type.Type:exampleAccountRecordType@campusapi.org", "..."],
"creditBalance": true,
"code": "This is the string for Code"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /accounts
Create a new account in the default business.
Query Parameters
- genusType: (string)
specify a particular account type to create
Example:
type.Type%3AexampleAccountType%40dxtera.org - recordType: (array of )
specify support for one or more account record types
Example:
[ "type.Type%3AexampleAccountRecordType%40campusapi.org", "..." ] - businessId: (string)
specify in which business to create this account
Example:
financials.Business%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Account",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this account, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this account, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this account for display.",
"type": "string"
},
"description": {
"description": "The description of this account.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this account. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this account. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"creditBalance": {
"description": "Tests if this account is a credit or debit account.",
"type": "boolean"
},
"code": {
"description": "A code for this G/L account.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Account",
"description": "The description of this Account",
"creditBalance": true,
"code": "This is the string for Code"
}
Entity representing a account form metadata.
get
Get form metadata for creating a new account.
get /accounts/metadata
Get form metadata for creating a new account.
Query Parameters
- genusType: (string)
specify a particular account type to create
Example:
type.Type%3AexampleAccountType%40dxtera.org - recordType: (array of )
specify support for one or more account record types
Example:
[ "type.Type%3AexampleAccountRecordType%40campusapi.org", "..." ] - businessId: (string)
specify in which business to create this account
Example:
financials.Business%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Account",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this account, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this account, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this account for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Account.Account:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this account",
"linked": false
},
"description": {
"description": "The description of this account.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Account.Account:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this account",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this account. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this account. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"creditBalance": {
"description": "Tests if this account is a credit or debit account.",
"type": "boolean",
"elementId": "financials.Account:creditBalance@dxtera.org",
"existingValue": false,
"elementLabel": "Credit Balance",
"instructions": "Enter true or false.",
"linked": false
},
"code": {
"description": "A code for this G/L account.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.Account:code@dxtera.org",
"existingValue": "The existing code",
"elementLabel": "Code",
"instructions": "Enter a code for this account.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root accounts in the account hierarchy. A node with no parents is an orphan. While all account 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-accounts
get /accounts/root-accounts
Get all root root-accounts
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Account:4434@base.url",
"uri": "http://base.url/open/campusapi/financials/account/financials.Account%3A4434%40base.url",
"displayName": "Display Name of this Account",
"description": "The description of this Account",
"genusTypeId": "type.Type:defaultAccountType@base.url",
"recordTypeIds": [ "type.Type:exampleAccountRecordType@campusapi.org", "..."],
"creditBalance": true,
"code": "This is the string for Code"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given account as a root in the account hierarchy
delete
Remove the given account as a root in the account hierarchy.
put /accounts/root-accounts/{accountId}
Add the given account as a root in the account hierarchy
URI Parameters
- accountId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The account has been added as a root" }
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": "account not found" }
delete /accounts/root-accounts/{accountId}
Remove the given account as a root in the account hierarchy.
URI Parameters
- accountId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The account has been removed as a root from the hierarchy" }
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": "account not found" }
Entity representing a account
get
Get a account given its id.
put
Update a given account.
delete
Delete a given account.
get /accounts/{accountId}
Get a account given its id.
URI Parameters
- accountId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "financials.Account:4434@base.url",
"uri": "http://base.url/open/campusapi/financials/account/financials.Account%3A4434%40base.url",
"displayName": "Display Name of this Account",
"description": "The description of this Account",
"genusTypeId": "type.Type:defaultAccountType@base.url",
"recordTypeIds": [ "type.Type:exampleAccountRecordType@campusapi.org", "..."],
"creditBalance": true,
"code": "This is the string for Code"
}
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": "account not found" }
put /accounts/{accountId}
Update a given account.
URI Parameters
- accountId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Account",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this account, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this account, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this account for display.",
"type": "string"
},
"description": {
"description": "The description of this account.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this account. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this account. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"creditBalance": {
"description": "Tests if this account is a credit or debit account.",
"type": "boolean"
},
"code": {
"description": "A code for this G/L account.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Account",
"description": "The description of this Account",
"creditBalance": true,
"code": "This is the string for Code"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The account 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": "account not found" }
delete /accounts/{accountId}
Delete a given account.
URI Parameters
- accountId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The account 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": "account not found" }
Entity representing a account form metadata for update
get
Get form metadata for updating an existing account.
get /accounts/{accountId}/metadata
Get form metadata for updating an existing account.
URI Parameters
- accountId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Account",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this account, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this account, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this account for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Account.Account:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this account",
"linked": false
},
"description": {
"description": "The description of this account.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Account.Account:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this account",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this account. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this account. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"creditBalance": {
"description": "Tests if this account is a credit or debit account.",
"type": "boolean",
"elementId": "financials.Account:creditBalance@dxtera.org",
"existingValue": false,
"elementLabel": "Credit Balance",
"instructions": "Enter true or false.",
"linked": false
},
"code": {
"description": "A code for this G/L account.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.Account:code@dxtera.org",
"existingValue": "The existing code",
"elementLabel": "Code",
"instructions": "Enter a code for this account.",
"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": "account not found" }
get
Get child accounts for the given account in the hierarchy.
get /accounts/{accountId}/children
Get child accounts for the given account in the hierarchy.
URI Parameters
- accountId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Account:4434@base.url",
"uri": "http://base.url/open/campusapi/financials/account/financials.Account%3A4434%40base.url",
"displayName": "Display Name of this Account",
"description": "The description of this Account",
"genusTypeId": "type.Type:defaultAccountType@base.url",
"recordTypeIds": [ "type.Type:exampleAccountRecordType@campusapi.org", "..."],
"creditBalance": true,
"code": "This is the string for Code"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add account as child of the given account in the hierarchy.
delete
Remove the given account as a child of the given account in the hierarchy.
put /accounts/{accountId}/children/{childId}
Add account as child of the given account in the hierarchy.
URI Parameters
- accountId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child account has been added to the hierarchy" }
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": "account not found" }
delete /accounts/{accountId}/children/{childId}
Remove the given account as a child of the given account in the hierarchy.
URI Parameters
- accountId: required(string)
- childId: required(string)
get
Get parent accounts for the given account in the hierarchy.
get /accounts/{accountId}/parents
Get parent accounts for the given account in the hierarchy.
URI Parameters
- accountId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Account:4434@base.url",
"uri": "http://base.url/open/campusapi/financials/account/financials.Account%3A4434%40base.url",
"displayName": "Display Name of this Account",
"description": "The description of this Account",
"genusTypeId": "type.Type:defaultAccountType@base.url",
"recordTypeIds": [ "type.Type:exampleAccountRecordType@campusapi.org", "..."],
"creditBalance": true,
"code": "This is the string for Code"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
/activities
Collection of activities in a system, federation of systems, or in a default business.
get
Get all activities in the system or default business.
post
Create a new activity in the default business.
get /activities
Get all activities 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 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleActivityType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleActivityType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleActivityType%40campusapi.org - fromDate: (string)
Get all activities from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all activities up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - businessId: (string)
The id string to match a business
Example:
financials.Business%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Activity:8824@base.url",
"uri": "http://base.url/open/campusapi/financials/activity/financials.Activity%3A8824%40base.url",
"displayName": "Display Name of this Activity",
"description": "The description of this Activity",
"genusTypeId": "type.Type:defaultActivityType@base.url",
"recordTypeIds": [ "type.Type:exampleActivityRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"organizationId": "resource.Resource:247@base.url",
"supervisorId": "resource.Resource:5246@base.url",
"code": "This is the string for Code"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /activities
Create a new activity in the default business.
Query Parameters
- genusType: (string)
specify a particular activity type to create
Example:
type.Type%3AexampleActivityType%40dxtera.org - recordType: (array of )
specify support for one or more activity record types
Example:
[ "type.Type%3AexampleActivityRecordType%40campusapi.org", "..." ] - businessId: (string)
specify in which business to create this activity
Example:
financials.Business%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Activity",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this activity, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this activity, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this activity for display.",
"type": "string"
},
"description": {
"description": "The description of this activity.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this activity. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this activity. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"startDate": {
"description": "The starting date of this activity.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this activity.",
"type": "string",
"format": "date-time"
},
"organizationId": {
"description": "The organization associated with this activity.",
"type": "string",
"format": "osid-id"
},
"supervisorId": {
"description": "The resource supervising this activity account.",
"type": "string",
"format": "osid-id"
},
"code": {
"description": "The code for this activity account.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Activity",
"description": "The description of this Activity",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"organizationId": "resource.Resource:3843@base.url",
"supervisorId": "resource.Resource:7327@base.url",
"code": "This is the string for Code"
}
Entity representing a activity form metadata.
get
Get form metadata for creating a new activity.
get /activities/metadata
Get form metadata for creating a new activity.
Query Parameters
- genusType: (string)
specify a particular activity type to create
Example:
type.Type%3AexampleActivityType%40dxtera.org - recordType: (array of )
specify support for one or more activity record types
Example:
[ "type.Type%3AexampleActivityRecordType%40campusapi.org", "..." ] - businessId: (string)
specify in which business to create this activity
Example:
financials.Business%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Activity",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this activity, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this activity, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this activity for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Activity.Activity:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this activity",
"linked": false
},
"description": {
"description": "The description of this activity.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Activity.Activity:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this activity",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this activity. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this activity. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"startDate": {
"description": "The starting date of this activity.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Activity.Activity:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this activity",
"linked": false
},
"endDate": {
"description": "The ending date of this activity.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Activity.Activity:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this activity",
"linked": false
},
"organizationId": {
"description": "The organization associated with this activity.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.Activity:organization@dxtera.org",
"existingValue": null,
"elementLabel": "Organization",
"instructions": "Enter the Id of the organization for this activity.",
"linked": false
},
"supervisorId": {
"description": "The resource supervising this activity account.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.Activity:supervisor@dxtera.org",
"existingValue": null,
"elementLabel": "Supervisor",
"instructions": "Enter the Id of the supervisor for this activity.",
"linked": false
},
"code": {
"description": "The code for this activity account.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.Activity:code@dxtera.org",
"existingValue": "The existing code",
"elementLabel": "Code",
"instructions": "Enter a code for this activity.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root activities in the activity hierarchy. A node with no parents is an orphan. While all activity 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-activities
get /activities/root-activities
Get all root root-activities
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Activity:8824@base.url",
"uri": "http://base.url/open/campusapi/financials/activity/financials.Activity%3A8824%40base.url",
"displayName": "Display Name of this Activity",
"description": "The description of this Activity",
"genusTypeId": "type.Type:defaultActivityType@base.url",
"recordTypeIds": [ "type.Type:exampleActivityRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"organizationId": "resource.Resource:247@base.url",
"supervisorId": "resource.Resource:5246@base.url",
"code": "This is the string for Code"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given activity as a root in the activity hierarchy
delete
Remove the given activity as a root in the activity hierarchy.
put /activities/root-activities/{activityId}
Add the given activity as a root in the activity hierarchy
URI Parameters
- activityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The activity has been added as a root" }
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": "activity not found" }
delete /activities/root-activities/{activityId}
Remove the given activity as a root in the activity hierarchy.
URI Parameters
- activityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The activity has been removed as a root from the hierarchy" }
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": "activity not found" }
Entity representing a activity
get
Get a activity given its id.
put
Update a given activity.
delete
Delete a given activity.
get /activities/{activityId}
Get a activity given its id.
URI Parameters
- activityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "financials.Activity:8824@base.url",
"uri": "http://base.url/open/campusapi/financials/activity/financials.Activity%3A8824%40base.url",
"displayName": "Display Name of this Activity",
"description": "The description of this Activity",
"genusTypeId": "type.Type:defaultActivityType@base.url",
"recordTypeIds": [ "type.Type:exampleActivityRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"organizationId": "resource.Resource:247@base.url",
"supervisorId": "resource.Resource:5246@base.url",
"code": "This is the string for Code"
}
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": "activity not found" }
put /activities/{activityId}
Update a given activity.
URI Parameters
- activityId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Activity",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this activity, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this activity, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this activity for display.",
"type": "string"
},
"description": {
"description": "The description of this activity.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this activity. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this activity. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"startDate": {
"description": "The starting date of this activity.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this activity.",
"type": "string",
"format": "date-time"
},
"organizationId": {
"description": "The organization associated with this activity.",
"type": "string",
"format": "osid-id"
},
"supervisorId": {
"description": "The resource supervising this activity account.",
"type": "string",
"format": "osid-id"
},
"code": {
"description": "The code for this activity account.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Activity",
"description": "The description of this Activity",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"organizationId": "resource.Resource:3843@base.url",
"supervisorId": "resource.Resource:7327@base.url",
"code": "This is the string for Code"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The activity 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": "activity not found" }
delete /activities/{activityId}
Delete a given activity.
URI Parameters
- activityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The activity 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": "activity not found" }
Entity representing a activity form metadata for update
get
Get form metadata for updating an existing activity.
get /activities/{activityId}/metadata
Get form metadata for updating an existing activity.
URI Parameters
- activityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Activity",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this activity, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this activity, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this activity for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Activity.Activity:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this activity",
"linked": false
},
"description": {
"description": "The description of this activity.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Activity.Activity:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this activity",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this activity. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this activity. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"startDate": {
"description": "The starting date of this activity.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Activity.Activity:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this activity",
"linked": false
},
"endDate": {
"description": "The ending date of this activity.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Activity.Activity:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this activity",
"linked": false
},
"organizationId": {
"description": "The organization associated with this activity.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.Activity:organization@dxtera.org",
"existingValue": null,
"elementLabel": "Organization",
"instructions": "Enter the Id of the organization for this activity.",
"linked": false
},
"supervisorId": {
"description": "The resource supervising this activity account.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.Activity:supervisor@dxtera.org",
"existingValue": null,
"elementLabel": "Supervisor",
"instructions": "Enter the Id of the supervisor for this activity.",
"linked": false
},
"code": {
"description": "The code for this activity account.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.Activity:code@dxtera.org",
"existingValue": "The existing code",
"elementLabel": "Code",
"instructions": "Enter a code for this activity.",
"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": "activity not found" }
get
Get child activities for the given activity in the hierarchy.
get /activities/{activityId}/children
Get child activities for the given activity in the hierarchy.
URI Parameters
- activityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Activity:8824@base.url",
"uri": "http://base.url/open/campusapi/financials/activity/financials.Activity%3A8824%40base.url",
"displayName": "Display Name of this Activity",
"description": "The description of this Activity",
"genusTypeId": "type.Type:defaultActivityType@base.url",
"recordTypeIds": [ "type.Type:exampleActivityRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"organizationId": "resource.Resource:247@base.url",
"supervisorId": "resource.Resource:5246@base.url",
"code": "This is the string for Code"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add activity as child of the given activity in the hierarchy.
delete
Remove the given activity as a child of the given activity in the hierarchy.
put /activities/{activityId}/children/{childId}
Add activity as child of the given activity in the hierarchy.
URI Parameters
- activityId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child activity has been added to the hierarchy" }
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": "activity not found" }
delete /activities/{activityId}/children/{childId}
Remove the given activity as a child of the given activity in the hierarchy.
URI Parameters
- activityId: required(string)
- childId: required(string)
get
Get parent activities for the given activity in the hierarchy.
get /activities/{activityId}/parents
Get parent activities for the given activity in the hierarchy.
URI Parameters
- activityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Activity:8824@base.url",
"uri": "http://base.url/open/campusapi/financials/activity/financials.Activity%3A8824%40base.url",
"displayName": "Display Name of this Activity",
"description": "The description of this Activity",
"genusTypeId": "type.Type:defaultActivityType@base.url",
"recordTypeIds": [ "type.Type:exampleActivityRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"organizationId": "resource.Resource:247@base.url",
"supervisorId": "resource.Resource:5246@base.url",
"code": "This is the string for Code"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
/fiscal-periods
Collection of fiscal-periods in a system, federation of systems, or in a default business.
get
Get all fiscal-periods in the system or default business.
post
Create a new fiscal-period in the default business.
get /fiscal-periods
Get all fiscal-periods 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 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleFiscalPeriodType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleFiscalPeriodType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleFiscalPeriodType%40campusapi.org - fiscalPeriodDate: (string)
query string to match date-time within fiscalPeriod date range.
Example:
2020-10-03 - businessId: (string)
The id string to match a business
Example:
financials.Business%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.FiscalPeriod:8070@base.url",
"uri": "http://base.url/open/campusapi/financials/fiscal_period/financials.FiscalPeriod%3A8070%40base.url",
"displayName": "Display Name of this FiscalPeriod",
"description": "The description of this FiscalPeriod",
"genusTypeId": "type.Type:defaultFiscalPeriodType@base.url",
"recordTypeIds": [ "type.Type:exampleFiscalPeriodRecordType@campusapi.org", "..."],
"displayLabel": "This is the DisplayLabel",
"fiscalYear": 19,
"startDate": "2020-10-03T08:00:00.000Z",
"endDate": "2020-12-18T17:00:00.000Z",
"budgetDeadline": "2021-07-21T23:15:30.000Z",
"postingDeadline": "2021-07-21T23:15:30.000Z",
"closing": "2021-07-21T23:15:30.000Z"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /fiscal-periods
Create a new fiscal-period in the default business.
Query Parameters
- genusType: (string)
specify a particular fiscalPeriod type to create
Example:
type.Type%3AexampleFiscalPeriodType%40dxtera.org - recordType: (array of )
specify support for one or more fiscalPeriod record types
Example:
[ "type.Type%3AexampleFiscalPeriodRecordType%40campusapi.org", "..." ] - businessId: (string)
specify in which business to create this fiscalPeriod
Example:
financials.Business%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "FiscalPeriod",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this fiscal period, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this fiscal period, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this fiscal period for display.",
"type": "string"
},
"description": {
"description": "The description of this fiscal period.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this fiscal period. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this fiscal period. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"displayLabel": {
"description": "A display label for this fiscal period which may be less formal than the display name.",
"type": "string"
},
"fiscalYear": {
"description": "Ges the fiscal year.",
"type": "integer"
},
"startDate": {
"description": "Get sthe start date of this period.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "Get sthe end date of this period.",
"type": "string",
"format": "date-time"
},
"budgetDeadline": {
"description": "The budget deadline.",
"type": "string",
"format": "date-time"
},
"postingDeadline": {
"description": "The last date transactions can be posted for this period.",
"type": "string",
"format": "date-time"
},
"closing": {
"description": "The date of the closing for this period.",
"type": "string",
"format": "date-time"
}
}
}Example:
{
"displayName": "Display Name of this FiscalPeriod",
"description": "The description of this FiscalPeriod",
"displayLabel": "This is the DisplayLabel",
"fiscalYear": 19,
"startDate": "2020-10-03T08:00:00.000Z",
"endDate": "2020-12-18T17:00:00.000Z",
"budgetDeadline": "2021-07-21T23:15:30.000Z",
"postingDeadline": "2021-07-21T23:15:30.000Z",
"closing": "2021-07-21T23:15:30.000Z"
}
Entity representing a fiscalPeriod form metadata.
get
Get form metadata for creating a new fiscalPeriod.
get /fiscal-periods/metadata
Get form metadata for creating a new fiscalPeriod.
Query Parameters
- genusType: (string)
specify a particular fiscalPeriod type to create
Example:
type.Type%3AexampleFiscalPeriodType%40dxtera.org - recordType: (array of )
specify support for one or more fiscalPeriod record types
Example:
[ "type.Type%3AexampleFiscalPeriodRecordType%40campusapi.org", "..." ] - businessId: (string)
specify in which business to create this fiscalPeriod
Example:
financials.Business%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "FiscalPeriod",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this fiscal period, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this fiscal period, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this fiscal period for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "FiscalPeriod.FiscalPeriod:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this fiscal period",
"linked": false
},
"description": {
"description": "The description of this fiscal period.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "FiscalPeriod.FiscalPeriod:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this fiscal period",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this fiscal period. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this fiscal period. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"displayLabel": {
"description": "A display label for this fiscal period which may be less formal than the display name.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.FiscalPeriod:displayLabel@dxtera.org",
"existingValue": "The existing display label",
"elementLabel": "Display Label",
"instructions": "Enter a display label for this fiscal period.",
"linked": false
},
"fiscalYear": {
"description": "Ges the fiscal year.",
"type": "integer",
"minimum": null,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "financials.FiscalPeriod:fiscalYear@dxtera.org",
"existingValue": 42,
"elementLabel": "Fiscal Year",
"instructions": "Enter the fiscal year of this fiscal period.",
"linked": false
},
"startDate": {
"description": "Get sthe start date of this period.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.FiscalPeriod:startDate@dxtera.org",
"existingValue": "",
"elementLabel": "Start Date",
"instructions": "Enter the start date of this fiscal period.",
"linked": false
},
"endDate": {
"description": "Get sthe end date of this period.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.FiscalPeriod:endDate@dxtera.org",
"existingValue": "",
"elementLabel": "End Date",
"instructions": "Enter the end date of this fiscal period.",
"linked": false
},
"budgetDeadline": {
"description": "The budget deadline.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.FiscalPeriod:budgetDeadline@dxtera.org",
"existingValue": "",
"elementLabel": "Budget Deadline",
"instructions": "Enter the budget deadline of this fiscal period.",
"linked": false
},
"postingDeadline": {
"description": "The last date transactions can be posted for this period.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.FiscalPeriod:postingDeadline@dxtera.org",
"existingValue": "",
"elementLabel": "Posting Deadline",
"instructions": "Enter the posting deadline of this fiscal period.",
"linked": false
},
"closing": {
"description": "The date of the closing for this period.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.FiscalPeriod:closing@dxtera.org",
"existingValue": "",
"elementLabel": "Closing",
"instructions": "Enter the closing of this fiscal period.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a fiscal-period
get
Get a fiscal-period given its id.
put
Update a given fiscal-period.
delete
Delete a given fiscal-period.
get /fiscal-periods/{fiscalPeriodId}
Get a fiscal-period given its id.
URI Parameters
- fiscalPeriodId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "financials.FiscalPeriod:8070@base.url",
"uri": "http://base.url/open/campusapi/financials/fiscal_period/financials.FiscalPeriod%3A8070%40base.url",
"displayName": "Display Name of this FiscalPeriod",
"description": "The description of this FiscalPeriod",
"genusTypeId": "type.Type:defaultFiscalPeriodType@base.url",
"recordTypeIds": [ "type.Type:exampleFiscalPeriodRecordType@campusapi.org", "..."],
"displayLabel": "This is the DisplayLabel",
"fiscalYear": 19,
"startDate": "2020-10-03T08:00:00.000Z",
"endDate": "2020-12-18T17:00:00.000Z",
"budgetDeadline": "2021-07-21T23:15:30.000Z",
"postingDeadline": "2021-07-21T23:15:30.000Z",
"closing": "2021-07-21T23:15:30.000Z"
}
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": "fiscal-period not found" }
put /fiscal-periods/{fiscalPeriodId}
Update a given fiscal-period.
URI Parameters
- fiscalPeriodId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "FiscalPeriod",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this fiscal period, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this fiscal period, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this fiscal period for display.",
"type": "string"
},
"description": {
"description": "The description of this fiscal period.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this fiscal period. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this fiscal period. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"displayLabel": {
"description": "A display label for this fiscal period which may be less formal than the display name.",
"type": "string"
},
"fiscalYear": {
"description": "Ges the fiscal year.",
"type": "integer"
},
"startDate": {
"description": "Get sthe start date of this period.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "Get sthe end date of this period.",
"type": "string",
"format": "date-time"
},
"budgetDeadline": {
"description": "The budget deadline.",
"type": "string",
"format": "date-time"
},
"postingDeadline": {
"description": "The last date transactions can be posted for this period.",
"type": "string",
"format": "date-time"
},
"closing": {
"description": "The date of the closing for this period.",
"type": "string",
"format": "date-time"
}
}
}Example:
{
"displayName": "Display Name of this FiscalPeriod",
"description": "The description of this FiscalPeriod",
"displayLabel": "This is the DisplayLabel",
"fiscalYear": 19,
"startDate": "2020-10-03T08:00:00.000Z",
"endDate": "2020-12-18T17:00:00.000Z",
"budgetDeadline": "2021-07-21T23:15:30.000Z",
"postingDeadline": "2021-07-21T23:15:30.000Z",
"closing": "2021-07-21T23:15:30.000Z"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The fiscal-period 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": "fiscal-period not found" }
delete /fiscal-periods/{fiscalPeriodId}
Delete a given fiscal-period.
URI Parameters
- fiscalPeriodId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The fiscal-period 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": "fiscal-period not found" }
Entity representing a fiscalPeriod form metadata for update
get
Get form metadata for updating an existing fiscalPeriod.
get /fiscal-periods/{fiscalPeriodId}/metadata
Get form metadata for updating an existing fiscalPeriod.
URI Parameters
- fiscalPeriodId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "FiscalPeriod",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this fiscal period, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this fiscal period, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this fiscal period for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "FiscalPeriod.FiscalPeriod:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this fiscal period",
"linked": false
},
"description": {
"description": "The description of this fiscal period.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "FiscalPeriod.FiscalPeriod:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this fiscal period",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this fiscal period. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this fiscal period. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"displayLabel": {
"description": "A display label for this fiscal period which may be less formal than the display name.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.FiscalPeriod:displayLabel@dxtera.org",
"existingValue": "The existing display label",
"elementLabel": "Display Label",
"instructions": "Enter a display label for this fiscal period.",
"linked": false
},
"fiscalYear": {
"description": "Ges the fiscal year.",
"type": "integer",
"minimum": null,
"maximum": null,
"units": "",
"default": null,
"enum": [],
"elementId": "financials.FiscalPeriod:fiscalYear@dxtera.org",
"existingValue": 42,
"elementLabel": "Fiscal Year",
"instructions": "Enter the fiscal year of this fiscal period.",
"linked": false
},
"startDate": {
"description": "Get sthe start date of this period.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.FiscalPeriod:startDate@dxtera.org",
"existingValue": "",
"elementLabel": "Start Date",
"instructions": "Enter the start date of this fiscal period.",
"linked": false
},
"endDate": {
"description": "Get sthe end date of this period.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.FiscalPeriod:endDate@dxtera.org",
"existingValue": "",
"elementLabel": "End Date",
"instructions": "Enter the end date of this fiscal period.",
"linked": false
},
"budgetDeadline": {
"description": "The budget deadline.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.FiscalPeriod:budgetDeadline@dxtera.org",
"existingValue": "",
"elementLabel": "Budget Deadline",
"instructions": "Enter the budget deadline of this fiscal period.",
"linked": false
},
"postingDeadline": {
"description": "The last date transactions can be posted for this period.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.FiscalPeriod:postingDeadline@dxtera.org",
"existingValue": "",
"elementLabel": "Posting Deadline",
"instructions": "Enter the posting deadline of this fiscal period.",
"linked": false
},
"closing": {
"description": "The date of the closing for this period.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "financials.FiscalPeriod:closing@dxtera.org",
"existingValue": "",
"elementLabel": "Closing",
"instructions": "Enter the closing of this fiscal period.",
"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": "fiscalPeriod 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 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleBusinessType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleBusinessType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleBusinessType%40campusapi.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3007%40demo.dxtera.org - accountId: (string)
Get businesses mapped to this account.
Example:
financials.Account%3A560%40demo.dxtera.org - activityId: (string)
Get businesses mapped to this activity.
Example:
financials.Activity%3A640%40demo.dxtera.org - fiscalPeriodId: (string)
Get businesses mapped to this fiscal-period.
Example:
financials.FiscalPeriod%3A1040%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Business:2454@base.url",
"uri": "http://base.url/open/campusapi/financials/business/financials.Business%3A2454%40base.url",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"genusTypeId": "type.Type:defaultBusinessType@base.url",
"recordTypeIds": [ "type.Type:exampleBusinessRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Business@base.url",
"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 - recordType: (array of )
specify support for one or more business record types
Example:
[ "type.Type%3AexampleBusinessRecordType%40campusapi.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"
},
"genusTypeId": {
"description": "Id of the immutable type of this business. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this business. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"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:
{
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Business@base.url",
"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@base.url",
"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.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this business",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this business. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this business. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this business.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:provider@base.url",
"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@base.url",
"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@base.url",
"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:2454@base.url",
"uri": "http://base.url/open/campusapi/financials/business/financials.Business%3A2454%40base.url",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"genusTypeId": "type.Type:defaultBusinessType@base.url",
"recordTypeIds": [ "type.Type:exampleBusinessRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Business@base.url",
"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:2454@base.url",
"uri": "http://base.url/open/campusapi/financials/business/financials.Business%3A2454%40base.url",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"genusTypeId": "type.Type:defaultBusinessType@base.url",
"recordTypeIds": [ "type.Type:exampleBusinessRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Business@base.url",
"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"
},
"genusTypeId": {
"description": "Id of the immutable type of this business. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this business. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"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:
{
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Business@base.url",
"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@base.url",
"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.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this business",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this business. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this business. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this business.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:provider@base.url",
"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@base.url",
"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@base.url",
"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 child businesses for the given business in the hierarchy.
get /businesses/{businessId}/children
Get child 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:2454@base.url",
"uri": "http://base.url/open/campusapi/financials/business/financials.Business%3A2454%40base.url",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"genusTypeId": "type.Type:defaultBusinessType@base.url",
"recordTypeIds": [ "type.Type:exampleBusinessRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Business@base.url",
"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 to the hierarchy" }
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.
URI Parameters
- businessId: required(string)
- childId: required(string)
get
Get parent businesses for the given business in the hierarchy.
get /businesses/{businessId}/parents
Get parent 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:2454@base.url",
"uri": "http://base.url/open/campusapi/financials/business/financials.Business%3A2454%40base.url",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"genusTypeId": "type.Type:defaultBusinessType@base.url",
"recordTypeIds": [ "type.Type:exampleBusinessRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Business@base.url",
"license": "The license that applies to this Business"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
get
Get all accounts in this business
get /businesses/{businessId}/accounts
Get all accounts in this business
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Account:4434@base.url",
"uri": "http://base.url/open/campusapi/financials/account/financials.Account%3A4434%40base.url",
"displayName": "Display Name of this Account",
"description": "The description of this Account",
"genusTypeId": "type.Type:defaultAccountType@base.url",
"recordTypeIds": [ "type.Type:exampleAccountRecordType@campusapi.org", "..."],
"creditBalance": true,
"code": "This is the string for Code"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given account to this business
delete
Remove the given account from the business.
put /businesses/{businessId}/accounts/{accountId}
Add the given account to this business
URI Parameters
- businessId: required(string)
- accountId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "account 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": "account not found" }
delete /businesses/{businessId}/accounts/{accountId}
Remove the given account from the business.
URI Parameters
- businessId: required(string)
- accountId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "account 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": "account not found" }
get
Get all activities in this business
get /businesses/{businessId}/activities
Get all activities in this business
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.Activity:8824@base.url",
"uri": "http://base.url/open/campusapi/financials/activity/financials.Activity%3A8824%40base.url",
"displayName": "Display Name of this Activity",
"description": "The description of this Activity",
"genusTypeId": "type.Type:defaultActivityType@base.url",
"recordTypeIds": [ "type.Type:exampleActivityRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"organizationId": "resource.Resource:247@base.url",
"supervisorId": "resource.Resource:5246@base.url",
"code": "This is the string for Code"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given activity to this business
delete
Remove the given activity from the business.
put /businesses/{businessId}/activities/{activityId}
Add the given activity to this business
URI Parameters
- businessId: required(string)
- activityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "activity 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": "activity not found" }
delete /businesses/{businessId}/activities/{activityId}
Remove the given activity from the business.
URI Parameters
- businessId: required(string)
- activityId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "activity 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": "activity not found" }
get
Get all fiscal-periods in this business
get /businesses/{businessId}/fiscal-periods
Get all fiscal-periods in this business
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "financials.FiscalPeriod:8070@base.url",
"uri": "http://base.url/open/campusapi/financials/fiscal_period/financials.FiscalPeriod%3A8070%40base.url",
"displayName": "Display Name of this FiscalPeriod",
"description": "The description of this FiscalPeriod",
"genusTypeId": "type.Type:defaultFiscalPeriodType@base.url",
"recordTypeIds": [ "type.Type:exampleFiscalPeriodRecordType@campusapi.org", "..."],
"displayLabel": "This is the DisplayLabel",
"fiscalYear": 19,
"startDate": "2020-10-03T08:00:00.000Z",
"endDate": "2020-12-18T17:00:00.000Z",
"budgetDeadline": "2021-07-21T23:15:30.000Z",
"postingDeadline": "2021-07-21T23:15:30.000Z",
"closing": "2021-07-21T23:15:30.000Z"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given fiscal-period to this business
delete
Remove the given fiscal-period from the business.
put /businesses/{businessId}/fiscal-periods/{fiscalPeriodId}
Add the given fiscal-period to this business
URI Parameters
- businessId: required(string)
- fiscalPeriodId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "fiscal-period 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": "fiscal-period not found" }
delete /businesses/{businessId}/fiscal-periods/{fiscalPeriodId}
Remove the given fiscal-period from the business.
URI Parameters
- businessId: required(string)
- fiscalPeriodId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "fiscal-period 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": "fiscal-period not found" }