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

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "fiscalPeriod", "correctedPost", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexamplePostType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePostType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePostType%40campusapi.org

• fromDate: (string)

  Get all posts from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all posts 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

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:8573@base.url",
  "date": "2021-07-21T23:15:30.000Z",
  "correctedPostId": "financials.posting.Post:6033@base.url"
}

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "fiscalPeriod", "correctedPost", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PostQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchFiscalPeriodIds": {
      "description": "List of FiscalPeriod Ids for this query to match fiscalPeriod.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fiscalPeriodId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "fiscalPeriodQueries": {
      "description": "financials.FiscalPeriodQueries to match the Fiscal Period. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyFiscalPeriod": {
      "description": "Match fiscal period with any value. true to match Posts with any fiscal period, false to match Posts with no fiscal period",
      "type": "boolean"
    },
    "matchDate": {
      "description": "Matches dates between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyDate": {
      "description": "Match dates with any value. true to match Posts with any date, false to match ProgramOfferings with no date",
      "type": "boolean"

    },
    "matchCorrectedPostIds": {
      "description": "List of Post Ids for this query to match correctedPost.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "correctedPostId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "correctedPostQueries": {
      "description": "posting.PostQueries to match the Corrected Post. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyCorrectedPost": {
      "description": "Match corrected post with any value. true to match Posts with any corrected post, false to match Posts with no corrected post",
      "type": "boolean"
    },
    "matchBusinessIds": {
      "description": "List of Business Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "businessId": {
            "description": "Business id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "businessQueries": {
      "description": "BusinessQueries to match Business. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

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

URI Parameters

• postId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "fiscalPeriod", "correctedPost", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

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:8573@base.url",
  "date": "2021-07-21T23:15:30.000Z",
  "correctedPostId": "financials.posting.Post:6033@base.url"
}

URI Parameters

• postId: required(string)

URI Parameters

• postId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "account", "activity", "post", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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%40base.url

• accountId: (string)

  Id string to match account.

  Example:

  financials.Account%3A22%40base.url

• activityId: (string)

  Id string to match activity.

  Example:

  financials.Activity%3A4454%40base.url

• 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

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:9193@base.url",
  "activityId": "financials.Activity:6549@base.url",
  "amount": "USD+42.00",
  "debit": true
}

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "account", "activity", "post", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PostEntryQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchPostIds": {
      "description": "List of post Ids for this query to match post entry that have a related post.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "postQueries": {
      "description": "PostQueries to match the post. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAccountIds": {
      "description": "List of Account Ids for this query to match account.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "accountId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "accountQueries": {
      "description": "financials.AccountQueries to match the Account. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyAccount": {
      "description": "Match account with any value. true to match PostEntries with any account, false to match PostEntries with no account",
      "type": "boolean"
    },
    "matchActivityIds": {
      "description": "List of Activity Ids for this query to match activity.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "activityId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "activityQueries": {
      "description": "financials.ActivityQueries to match the Activity. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyActivity": {
      "description": "Match activity with any value. true to match PostEntries with any activity, false to match PostEntries with no activity",
      "type": "boolean"
    },
    "matchAmount": {
      "description": "Matches amounts in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "a starting range",
            "type": "string",
            "format": "currency"
          },
          "to": {
            "description": "an ending range",
            "type": "string",
            "format": "currency"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyAmount": {
      "description": "Match amounts with any value. true to match PostEntries with any amount, false to match ProgramOfferings with no amount",
      "type": "boolean"

    },
    "matchDebit": {
      "description": "Match boolean value for debit.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchBusinessIds": {
      "description": "List of Business Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "businessId": {
            "description": "Business id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "businessQueries": {
      "description": "BusinessQueries to match Business. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

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

URI Parameters

• postEntryId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "account", "activity", "post", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

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:9193@base.url",
  "activityId": "financials.Activity:6549@base.url",
  "amount": "USD+42.00",
  "debit": true
}

URI Parameters

• postEntryId: required(string)

URI Parameters

• postEntryId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

• postId: (string)

  Get businesses mapped to this post.

  Example:

  posting.Post%3A224%40demo.dxtera.org

• postEntryId: (string)

  Get businesses mapped to this post-entry.

  Example:

  posting.PostEntry%3A560%40demo.dxtera.org

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

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

• expand: (string)

  Expand object or type for named attribute: , or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "BusinessQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "providerQueries": {
      "description": "resource.ResourceQuery for provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Business with any provider, false to match Business with no provider",
      "type": "boolean"
      }
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQuery for branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Business with any branding, false to match Business with no branding",
      "type": "boolean"
    },
    "matchlicenses": {
      "description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "license": {
            "description": "license to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchBusinessIds": {
      "description": "List of Business Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "businessId": {
            "description": "Business id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "businessQueries": {
      "description": "BusinessQueries to match Business. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

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 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "financials.Business:2663@base.url",
    "uri": "http://base.url/open/campusapi/financials/business/financials.Business%3A2663%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" }

URI Parameters

• businessId: required(string)

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

URI Parameters

• businessId: required(string)

URI Parameters

• businessId: required(string)

URI Parameters

• businessId: required(string)

URI Parameters

• businessId: required(string)
• childId: required(string)

URI Parameters

• businessId: required(string)
• childId: required(string)

URI Parameters

• businessId: required(string)

URI Parameters

• businessId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "fiscalPeriod", "correctedPost", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexamplePostType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePostType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePostType%40campusapi.org

URI Parameters

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

URI Parameters

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

URI Parameters

• businessId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "account", "activity", "post", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

URI Parameters

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

URI Parameters

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