CampusAPI Posting Services API documentation version 0.1.2
Based on OSID version 3.0.0

https://base.url/posting

Overview

The Financials Posting package manages accounting transactions.

This package includes the following entities:

Posts

A Post is the entire accounting transaction composed of PostEntries. The sum of all PostEntries in a Post should balance in a double entry accounting scheme.

A Post is related to a specific FiscalPeriod. A Post may also be marked as a correction to a previous Post where the posting date falls outside the targeted FiscalPeriod.

The posting is complete when the Post if posted. Before it is posted, the Post may be updated and assembled by creating PostEntries. Typically, once a Post is submitted it is frozen.

A Post is transactional in that the posting of all PostEntries succeeeds or fails.

FieldDescriptionType
id(read‑only)The unique id of this post, provided by system.string(osid‑id)
uri(read‑only)The uri of this post, provided by system.string(uri)
displayNameThe name of this post for display.string
descriptionThe description of this post.string
genusTypeId
(read‑only)		Id of the immutable type of this post. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this post. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
fiscalPeriodIdThe FiscalPeriod. References a financials.FiscalPeriod objectstring(osid‑id)
dateThe posting date.string(date‑time)
correctedPostIdThe corrected Post. References a posting.Post objectstring(osid‑id)

PostEntries

A PostEntry is a debit or a credit to or from an Activity and general ledger Account. Post entries are part of a Post.

FieldDescriptionType
id(read‑only)The unique id of this post entry, provided by system.string(osid‑id)
uri(read‑only)The uri of this post entry, provided by system.string(uri)
displayNameThe name of this post entry for display.string
descriptionThe description of this post entry.string
genusTypeId
(read‑only)		Id of the immutable type of this post entry. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this post entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
postId
(read‑only)		The post associated with this post entry. References a posting.Post object.string(osid‑id)
accountIdThe G/L account to which this entry applies. References a financials.Account objectstring(osid‑id)
activityIdThe financial activity to which this entry applies. References a financials.Activity objectstring(osid‑id)
amountThe amount.string(currency)
debitTests if the amount is a debit or a credit.boolean

Businesses

Accounts, Activities, and FiscalPeriods are organized into federaable Businesses.

FieldDescriptionType
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)
displayNameThe name of this business for display.string
descriptionThe 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)[]
providerIdThe provider of this business. References a resource.Resource object.string(osid‑id)
brandingIdsThe branding of this business. References repository.Asset objects.string(osid‑id)[]
licenseThe 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

/posts

Collection of posts in a system, federation of systems, or in a default business.

get post

get

Get all posts in the system or default business.

post

Create a new post in the default business.

Create a new post in the default business.

Query Parameters

  • genusType: (string)

    specify a particular post type to create

    Example:

    type.Type%3AexamplePostType%40dxtera.org
  • recordType: (array of )

    specify support for one or more post record types

    Example:

    [
  "type.Type%3AexamplePostRecordType%40campusapi.org",
  "..."
]
  • businessId: (string)

    specify in which business to create this post

    Example:

    posting.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Post",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this post, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this post, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this post for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this post.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this post. 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 post. 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
    },
    "fiscalPeriodId": {
      "description": "The FiscalPeriod.",
      "type": "string",
      "format": "osid-id"
    },
    "date": {
      "description": "The posting date.",
      "type": "string",
      "format": "date-time"
    },
    "correctedPostId": {
      "description": "The corrected Post.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Post",
  "description": "The description of this Post",
  "fiscalPeriodId": "financials.FiscalPeriod:8802@base.url",
  "date": "2021-07-21T23:15:30.000Z",
  "correctedPostId": "financials.posting.Post:4242@base.url"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The post has been created",
  "postId": "posting.Post:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a post form metadata.

get

Get form metadata for creating a new post.

get put delete

Entity representing a post

get

Get a post given its id.

put

Update a given post.

delete

Delete a given post.

Get a post given its id.

URI Parameters

  • postId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "posting.Post:6054@base.url",
  "uri": "http://base.url/open/campusapi/posting/post/posting.Post%3A6054%40base.url",
  "displayName": "Display Name of this Post",
  "description": "The description of this Post",
  "genusTypeId": "type.Type:defaultPostType@base.url",
  "recordTypeIds": [ "type.Type:examplePostRecordType@campusapi.org", "..."],
  "fiscalPeriodId": "financials.FiscalPeriod:5603@base.url",
  "date": "2021-07-21T23:15:30.000Z",
  "correctedPostId": "financials.posting.Post:5222@base.url"
}

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": "post not found" }

Update a given post.

URI Parameters

  • postId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Post",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this post, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this post, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this post for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this post.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this post. 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 post. 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
    },
    "fiscalPeriodId": {
      "description": "The FiscalPeriod.",
      "type": "string",
      "format": "osid-id"
    },
    "date": {
      "description": "The posting date.",
      "type": "string",
      "format": "date-time"
    },
    "correctedPostId": {
      "description": "The corrected Post.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Post",
  "description": "The description of this Post",
  "fiscalPeriodId": "financials.FiscalPeriod:8802@base.url",
  "date": "2021-07-21T23:15:30.000Z",
  "correctedPostId": "financials.posting.Post:4242@base.url"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The post 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": "post not found" }

Delete a given post.

URI Parameters

  • postId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The post 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": "post not found" }

get

Entity representing a post form metadata for update

get

Get form metadata for updating an existing post.

Get form metadata for updating an existing post.

URI Parameters

  • postId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "Post",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this post, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this post, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this post for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Post.Post:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this post",
      "linked": false
    },
    "description": {
      "description": "The description of this post.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Post.Post:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this post",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this post. 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 post. 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
    },
    "fiscalPeriodId": {
      "description": "The FiscalPeriod.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "financials.posting.Post:fiscalPeriod@dxtera.org",
      "existingValue": null,
      "elementLabel": "Fiscal Period",
      "instructions": "Enter the Id of the fiscal period for this post.",
      "linked": false
    },
    "date": {
      "description": "The posting date.",
      "type": "string",
      "format": "date-time",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "financials.posting.Post:date@dxtera.org",
      "existingValue": "",
      "elementLabel": "Date",
      "instructions": "Enter the date of this post.",
      "linked": false
    },
    "correctedPostId": {
      "description": "The corrected Post.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "financials.posting.Post:correctedPost@dxtera.org",
      "existingValue": null,
      "elementLabel": "Corrected Post",
      "instructions": "Enter the Id of the corrected post for this post.",
      "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": "post not found" }

/post-entries

Collection of post-entries in a system, federation of systems, or in a default business.

get post

get

Get all post-entries in the system or default business.

post

Create a new post-entry in the default business.

Get all post-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
  • genusTypeId: (string)

    The id string to match a genusType

    Example:

    type.Type%3AexamplePostEntryType%40dxtera.org
  • parentGenusTypeId: (string)

    The id string to match a parent genusType

    Example:

    type.Type%3AparentTypeExamplePostEntryType%40dxtera.org
  • recordTypeId: (string)

    The id string to match a recordType

    Example:

    type.Type%3AexamplePostEntryType%40campusapi.org
  • postId: (string)

    the id string to match a post.

    Example:

    posting.Post%3A252%40base.url
  • fiscalPeriodId: (string)

    Id string to match fiscalPeriod.

    Example:

    financials.FiscalPeriod%3A7638%40demo.dxtera.org
  • accountId: (string)

    Id string to match account.

    Example:

    financials.Account%3A22%40demo.dxtera.org
  • activityId: (string)

    Id string to match activity.

    Example:

    financials.Activity%3A4454%40demo.dxtera.org
  • fromDate: (string)

    Get all post-entries from this date inclusive. Use with toDate to define date range query.

    Example:

    2020-10-03
  • toDate: (string)

    Get all post-entries 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": "posting.PostEntry:7212@base.url",
    "uri": "http://base.url/open/campusapi/posting/post_entry/posting.PostEntry%3A7212%40base.url",
    "displayName": "Display Name of this PostEntry",
    "description": "The description of this PostEntry",
    "genusTypeId": "type.Type:defaultPostEntryType@base.url",
    "recordTypeIds": [ "type.Type:examplePostEntryRecordType@campusapi.org", "..."],
    "postId": "financials.posting.Post:9765@base.url",
    "accountId": "financials.Account:7523@base.url",
    "activityId": "financials.Activity:2516@base.url",
    "amount": "USD+42.00",
    "debit": true
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

Create a new post-entry in the default business.

Query Parameters

  • postId: required(string)

    the post of this post-entry.

    Example:

    posting.Post%3A252%40base.url
  • genusType: (string)

    specify a particular postEntry type to create

    Example:

    type.Type%3AexamplePostEntryType%40dxtera.org
  • recordType: (array of )

    specify support for one or more postEntry record types

    Example:

    [
  "type.Type%3AexamplePostEntryRecordType%40campusapi.org",
  "..."
]
  • businessId: (string)

    specify in which business to create this postEntry

    Example:

    posting.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PostEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this post entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this post entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this post entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this post entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this post entry. 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 post entry. 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
    },
    "postId": {
      "description": "The post associated with this post entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "accountId": {
      "description": "The G/L account to which this entry applies.",
      "type": "string",
      "format": "osid-id"
    },
    "activityId": {
      "description": "The financial activity to which this entry applies.",
      "type": "string",
      "format": "osid-id"
    },
    "amount": {
      "description": "The amount.",
      "type": "string",
      "format": "currency"
    },
    "debit": {
      "description": "Tests if the amount is a debit or a credit.",
      "type": "boolean"
    }
  }
}

Example:

{
  "displayName": "Display Name of this PostEntry",
  "description": "The description of this PostEntry",
  "accountId": "financials.Account:913@base.url",
  "activityId": "financials.Activity:8131@base.url",
  "amount": "USD+42.00",
  "debit": true
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The post-entry has been created",
  "post-entryId": "posting.PostEntry:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a postEntry form metadata.

get

Get form metadata for creating a new postEntry.

Get form metadata for creating a new postEntry.

Query Parameters

  • postId: required(string)

    the post of this metadatum.

    Example:

    posting.Post%3A252%40base.url
  • genusType: (string)

    specify a particular postEntry type to create

    Example:

    type.Type%3AexamplePostEntryType%40dxtera.org
  • recordType: (array of )

    specify support for one or more postEntry record types

    Example:

    [
  "type.Type%3AexamplePostEntryRecordType%40campusapi.org",
  "..."
]
  • businessId: (string)

    specify in which business to create this postEntry

    Example:

    posting.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": "PostEntry",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this post entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this post entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this post entry for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "PostEntry.PostEntry:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this post entry",
      "linked": false
    },
    "description": {
      "description": "The description of this post entry.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "PostEntry.PostEntry:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this post entry",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this post entry. 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 post entry. 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
    },
    "accountId": {
      "description": "The G/L account to which this entry applies.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "financials.posting.PostEntry:account@dxtera.org",
      "existingValue": null,
      "elementLabel": "Account",
      "instructions": "Enter the Id of the account for this post entry.",
      "linked": false
    },
    "activityId": {
      "description": "The financial activity to which this entry applies.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "financials.posting.PostEntry:activity@dxtera.org",
      "existingValue": null,
      "elementLabel": "Activity",
      "instructions": "Enter the Id of the activity for this post entry.",
      "linked": false
    },
    "amount": {
      "description": "The amount.",
      "type": "string",
      "format": "currency",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "financials.posting.PostEntry:amount@dxtera.org",
      "existingValue": "USD+120.56",
      "elementLabel": "Amount",
      "instructions": "Enter the amount of this post entry.",
      "linked": false
    },
    "debit": {
      "description": "Tests if the amount is a debit or a credit.",
      "type": "boolean",
      "elementId": "financials.posting.PostEntry: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" }

get put delete

Entity representing a post-entry

get

Get a post-entry given its id.

put

Update a given post-entry.

delete

Delete a given post-entry.

Get a post-entry given its id.

URI Parameters

  • postEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "posting.PostEntry:7212@base.url",
  "uri": "http://base.url/open/campusapi/posting/post_entry/posting.PostEntry%3A7212%40base.url",
  "displayName": "Display Name of this PostEntry",
  "description": "The description of this PostEntry",
  "genusTypeId": "type.Type:defaultPostEntryType@base.url",
  "recordTypeIds": [ "type.Type:examplePostEntryRecordType@campusapi.org", "..."],
  "postId": "financials.posting.Post:9765@base.url",
  "accountId": "financials.Account:7523@base.url",
  "activityId": "financials.Activity:2516@base.url",
  "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": "post-entry not found" }

Update a given post-entry.

URI Parameters

  • postEntryId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PostEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this post entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this post entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this post entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this post entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this post entry. 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 post entry. 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
    },
    "postId": {
      "description": "The post associated with this post entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "accountId": {
      "description": "The G/L account to which this entry applies.",
      "type": "string",
      "format": "osid-id"
    },
    "activityId": {
      "description": "The financial activity to which this entry applies.",
      "type": "string",
      "format": "osid-id"
    },
    "amount": {
      "description": "The amount.",
      "type": "string",
      "format": "currency"
    },
    "debit": {
      "description": "Tests if the amount is a debit or a credit.",
      "type": "boolean"
    }
  }
}

Example:

{
  "displayName": "Display Name of this PostEntry",
  "description": "The description of this PostEntry",
  "accountId": "financials.Account:913@base.url",
  "activityId": "financials.Activity:8131@base.url",
  "amount": "USD+42.00",
  "debit": true
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The post-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": "post-entry not found" }

Delete a given post-entry.

URI Parameters

  • postEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The post-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": "post-entry not found" }

get

Entity representing a postEntry form metadata for update

get

Get form metadata for updating an existing postEntry.

Get form metadata for updating an existing postEntry.

URI Parameters

  • postEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "PostEntry",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this post entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this post entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this post entry for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "PostEntry.PostEntry:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this post entry",
      "linked": false
    },
    "description": {
      "description": "The description of this post entry.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "PostEntry.PostEntry:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this post entry",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this post entry. 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 post entry. 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
    },
    "accountId": {
      "description": "The G/L account to which this entry applies.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "financials.posting.PostEntry:account@dxtera.org",
      "existingValue": null,
      "elementLabel": "Account",
      "instructions": "Enter the Id of the account for this post entry.",
      "linked": false
    },
    "activityId": {
      "description": "The financial activity to which this entry applies.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "financials.posting.PostEntry:activity@dxtera.org",
      "existingValue": null,
      "elementLabel": "Activity",
      "instructions": "Enter the Id of the activity for this post entry.",
      "linked": false
    },
    "amount": {
      "description": "The amount.",
      "type": "string",
      "format": "currency",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "financials.posting.PostEntry:amount@dxtera.org",
      "existingValue": "USD+120.56",
      "elementLabel": "Amount",
      "instructions": "Enter the amount of this post entry.",
      "linked": false
    },
    "debit": {
      "description": "Tests if the amount is a debit or a credit.",
      "type": "boolean",
      "elementId": "financials.posting.PostEntry: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": "postEntry not found" }

/businesses

Collection of businesses in a system or federation of systems.

get post

get

Get all businesses.

post

Create a new business.

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The business has been created",
  "businessId": "posting.Business:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a business form metadata.

get

Get form metadata for creating a new business.

get

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

Entity representing a business

get

Get a business given its id.

put

Update a given business.

delete

Delete a given business.

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

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

get

Entity representing a business form metadata for update

get

Get form metadata for updating an existing business.

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

Get child businesses for the given business in the hierarchy.

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 delete

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.

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

Remove the given business as a 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 removed from the hierarchy" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

get

Get parent businesses for the given business in the hierarchy.

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

Get all posts in this business

Get all posts in this business

URI Parameters

  • businessId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "posting.Post:6054@base.url",
    "uri": "http://base.url/open/campusapi/posting/post/posting.Post%3A6054%40base.url",
    "displayName": "Display Name of this Post",
    "description": "The description of this Post",
    "genusTypeId": "type.Type:defaultPostType@base.url",
    "recordTypeIds": [ "type.Type:examplePostRecordType@campusapi.org", "..."],
    "fiscalPeriodId": "financials.FiscalPeriod:5603@base.url",
    "date": "2021-07-21T23:15:30.000Z",
    "correctedPostId": "financials.posting.Post:5222@base.url"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add the given post to this business

delete

Remove the given post from the business.

Add the given post to this business

URI Parameters

  • businessId: required(string)
  • postId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "post 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": "post not found" }

Remove the given post from the business.

URI Parameters

  • businessId: required(string)
  • postId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "post 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": "post not found" }

get

get

Get all post-entries in this business

Get all post-entries in this business

URI Parameters

  • businessId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "posting.PostEntry:7212@base.url",
    "uri": "http://base.url/open/campusapi/posting/post_entry/posting.PostEntry%3A7212%40base.url",
    "displayName": "Display Name of this PostEntry",
    "description": "The description of this PostEntry",
    "genusTypeId": "type.Type:defaultPostEntryType@base.url",
    "recordTypeIds": [ "type.Type:examplePostEntryRecordType@campusapi.org", "..."],
    "postId": "financials.posting.Post:9765@base.url",
    "accountId": "financials.Account:7523@base.url",
    "activityId": "financials.Activity:2516@base.url",
    "amount": "USD+42.00",
    "debit": true
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add the given post-entry to this business

delete

Remove the given post-entry from the business.

Add the given post-entry to this business

URI Parameters

  • businessId: required(string)
  • postEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "post-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": "post-entry not found" }

Remove the given post-entry from the business.

URI Parameters

  • businessId: required(string)
  • postEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "post-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": "post-entry not found" }