CampusAPI Billing 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", "activity", "resource", 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%3AexampleCustomerType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCustomerType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCustomerType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

  Get all customers up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

• resourceId: (string)

  the id string to match a resource.

  Example:

  resource.Resource%3A512%40base.url

• activityId: (string)

  Id string to match activity.

  Example:

  financials.Activity%3A8475%40base.url

• businessId: (string)

  The id string to match a business

  Example:

  billing.Business%3A8374%40base.url

Query Parameters

• resourceId: required(string)

  the resource of this customer.

  Example:

  resource.Resource%3A512%40base.url

• genusType: (string)

  specify a particular customer type to create

  Example:

  type.Type%3AexampleCustomerType%40dxtera.org

• recordType: (array of )

  specify support for one or more customer record types

  Example:

  [
    "type.Type%3AexampleCustomerRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this customer

  Example:

  billing.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Customer",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this customer, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this customer, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this customer for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this customer.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this customer. 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 customer. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this customer.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this customer.",
      "type": "string",
      "format": "date-time"
    },
    "resourceId": {
      "description": "The resource associated with this customer.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "customerNumber": {
      "description": "The customer account number.",
      "type": "string"
    },
    "activityId": {
      "description": "The activity.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Customer",
  "description": "The description of this Customer",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "customerNumber": "101",
  "activityId": "financials.Activity:4376@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", "activity", "resource", 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": "CustomerQuery",
  "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"
          }
        }
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchResourceIds": {
      "description": "List of resource Ids for this query to match customer that have a related resource.",
      "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"
          }
        }
      }
    },
    "resourceQueries": {
      "description": "ResourceQueries to match the resource. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchCustomerNumber": {
      "description": "List of CustomerNumber strings to match. Boolean OR performed among multiple customerNumbers.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customerNumbers": {
            "description": "customerNumbers 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"
          }
        }
      }
    },
    "matchAnyCustomerNumber": {
      "description": "Match customerNumbers with any value. true to match Customers with any customer number, false to match ProgramOfferings with no customer number",
      "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 Customers with any activity, false to match Customers with no activity",
      "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

• resourceId: required(string)

  the resource of this metadatum.

  Example:

  resource.Resource%3A512%40base.url

• genusType: (string)

  specify a particular customer type to create

  Example:

  type.Type%3AexampleCustomerType%40dxtera.org

• recordType: (array of )

  specify support for one or more customer record types

  Example:

  [
    "type.Type%3AexampleCustomerRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this customer

  Example:

  billing.Business%3A8374%40base.url

URI Parameters

• customerId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• customerId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Customer",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this customer, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this customer, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this customer for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this customer.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this customer. 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 customer. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this customer.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this customer.",
      "type": "string",
      "format": "date-time"
    },
    "resourceId": {
      "description": "The resource associated with this customer.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "customerNumber": {
      "description": "The customer account number.",
      "type": "string"
    },
    "activityId": {
      "description": "The activity.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Customer",
  "description": "The description of this Customer",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "customerNumber": "101",
  "activityId": "financials.Activity:4376@base.url"
}

URI Parameters

• customerId: required(string)

URI Parameters

• customerId: 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", "category", "account", "product", 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%3AexampleItemType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleItemType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleItemType%40campusapi.org

• categoryId: (string)

  Id string to match category.

  Example:

  billing.Category%3A22%40base.url

• accountId: (string)

  Id string to match account.

  Example:

  financials.Account%3A4454%40base.url

• productId: (string)

  Id string to match product.

  Example:

  ordering.Product%3A7216%40base.url

• businessId: (string)

  The id string to match a business

  Example:

  billing.Business%3A8374%40base.url

Query Parameters

• genusType: (string)

  specify a particular item type to create

  Example:

  type.Type%3AexampleItemType%40dxtera.org

• recordType: (array of )

  specify support for one or more item record types

  Example:

  [
    "type.Type%3AexampleItemRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this item

  Example:

  billing.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Item",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this item, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this item, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this item for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this item.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this item. 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 item. 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
    },
    "categoryId": {
      "description": "The item category.",
      "type": "string",
      "format": "osid-id"
    },
    "accountId": {
      "description": "The item account.",
      "type": "string",
      "format": "osid-id"
    },
    "productId": {
      "description": "The product.",
      "type": "string",
      "format": "osid-id"
    },
    "amount": {
      "description": "The amount of this item.",
      "type": "boolean"
    },
    "debit": {
      "description": "-- could someone please write a description for this --",
      "type": "SYNTAX_TYPE_NOT_FOUND"
    },
    "recurringInterval": {
      "description": "The recurring interval.",
      "type": "string",
      "format": "duration"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Item",
  "description": "The description of this Item",
  "categoryId": "billing.Category:8762@base.url",
  "accountId": "financials.Account:2449@base.url",
  "productId": "ordering.Product:953@base.url",
  "amount": true,
  "recurringInterval": "P3DT3H"
}

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", "category", "account", "product", 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": "ItemQuery",
  "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"
          }
        }
      }
    },
    "matchCategoryIds": {
      "description": "List of Category Ids for this query to match category.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "categoryId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "categoryQueries": {
      "description": "billing.CategoryQueries to match the Category. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyCategory": {
      "description": "Match category with any value. true to match Items with any category, false to match Items with no category",
      "type": "boolean"
    },
    "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 Items with any account, false to match Items with no account",
      "type": "boolean"
    },
    "matchProductIds": {
      "description": "List of Product Ids for this query to match product.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "productId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "productQueries": {
      "description": "ordering.ProductQueries to match the Product. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyProduct": {
      "description": "Match product with any value. true to match Items with any product, false to match Items with no product",
      "type": "boolean"
    },
    "matchAmount": {
      "description": "Match boolean value for amount.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchDebit": {
      "description": "not yet supported",
      "type": "NONE"
    },
    "matchRecurringInterval": {
      "description": "Matches recurringIntervals in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyRecurringInterval": {
      "description": "Match recurringIntervals with any value. true to match Items with any recurring interval, false to match ProgramOfferings with no recurring interval",
      "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 item type to create

  Example:

  type.Type%3AexampleItemType%40dxtera.org

• recordType: (array of )

  specify support for one or more item record types

  Example:

  [
    "type.Type%3AexampleItemRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this item

  Example:

  billing.Business%3A8374%40base.url

URI Parameters

• itemId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• itemId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Item",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this item, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this item, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this item for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this item.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this item. 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 item. 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
    },
    "categoryId": {
      "description": "The item category.",
      "type": "string",
      "format": "osid-id"
    },
    "accountId": {
      "description": "The item account.",
      "type": "string",
      "format": "osid-id"
    },
    "productId": {
      "description": "The product.",
      "type": "string",
      "format": "osid-id"
    },
    "amount": {
      "description": "The amount of this item.",
      "type": "boolean"
    },
    "debit": {
      "description": "-- could someone please write a description for this --",
      "type": "SYNTAX_TYPE_NOT_FOUND"
    },
    "recurringInterval": {
      "description": "The recurring interval.",
      "type": "string",
      "format": "duration"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Item",
  "description": "The description of this Item",
  "categoryId": "billing.Category:8762@base.url",
  "accountId": "financials.Account:2449@base.url",
  "productId": "ordering.Product:953@base.url",
  "amount": true,
  "recurringInterval": "P3DT3H"
}

URI Parameters

• itemId: required(string)

URI Parameters

• itemId: 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", 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%3AexampleCategoryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCategoryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCategoryType%40campusapi.org

• businessId: (string)

  The id string to match a business

  Example:

  billing.Business%3A8374%40base.url

Query Parameters

• genusType: (string)

  specify a particular category type to create

  Example:

  type.Type%3AexampleCategoryType%40dxtera.org

• recordType: (array of )

  specify support for one or more category record types

  Example:

  [
    "type.Type%3AexampleCategoryRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this category

  Example:

  billing.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

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

Example:

{
  "displayName": "Display Name of this Category",
  "description": "The description of this Category"
}

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", 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": "CategoryQuery",
  "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"
          }
        }
      }
    },
    "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 category type to create

  Example:

  type.Type%3AexampleCategoryType%40dxtera.org

• recordType: (array of )

  specify support for one or more category record types

  Example:

  [
    "type.Type%3AexampleCategoryRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this category

  Example:

  billing.Business%3A8374%40base.url

URI Parameters

• categoryId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• categoryId: required(string)

Body

Media type: application/json

Type: json

Content:

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

Example:

{
  "displayName": "Display Name of this Category",
  "description": "The description of this Category"
}

URI Parameters

• categoryId: required(string)

URI Parameters

• categoryId: 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", "endReason", "customer", "item", "period", 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%3AexampleEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleEntryType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

  Get all entries up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

• customerId: (string)

  the id string to match a customer.

  Example:

  billing.Customer%3A280%40base.url

• itemId: (string)

  the id string to match a item.

  Example:

  billing.Item%3A140%40base.url

• periodId: (string)

  the id string to match a period.

  Example:

  billing.Period%3A210%40base.url

• businessId: (string)

  The id string to match a business

  Example:

  billing.Business%3A8374%40base.url

Query Parameters

• customerId: required(string)

  the customer of this entry.

  Example:

  billing.Customer%3A280%40base.url

• itemId: required(string)

  the item of this entry.

  Example:

  billing.Item%3A140%40base.url

• periodId: required(string)

  the period of this entry.

  Example:

  billing.Period%3A210%40base.url

• genusType: (string)

  specify a particular entry type to create

  Example:

  type.Type%3AexampleEntryType%40dxtera.org

• recordType: (array of )

  specify support for one or more entry record types

  Example:

  [
    "type.Type%3AexampleEntryRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this entry

  Example:

  billing.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Entry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this 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 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
    },
    "startDate": {
      "description": "The starting date of this entry.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this entry.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this entry ended.",
      "type": "string",
      "format": "osid-id"
    },
    "customerId": {
      "description": "The customer associated with this entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "itemId": {
      "description": "The item associated with this entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "periodId": {
      "description": "The period associated with this entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "quantity": {
      "description": "The quantity of the item.",
      "type": "integer",
      "minimum": 1
    },
    "amount": {
      "description": "The amount of this entry.",
      "type": "string",
      "format": "currency"
    },
    "debit": {
      "description": "Tests if the amount is a debit or a credit.",
      "type": "boolean"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Entry",
  "description": "The description of this Entry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:820@base.url",
  "quantity": 19,
  "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", "endReason", "customer", "item", "period", 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": "EntryQuery",
  "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"
          }
        }
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndReasonIds": {
      "description": "List of end reason Id's 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"
          }
        }
      }
    },
    "endReasonQueries": {
      "description": "process.StateQueries to match end reason state. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyEndReason": {
      "description": "Match end reasons with any value. true to match Entries with any end reason, false to match Entries with no end reason",
      "type": "boolean"
    },
    "matchCustomerIds": {
      "description": "List of customer Ids for this query to match entry that have a related customer.",
      "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"
          }
        }
      }
    },
    "customerQueries": {
      "description": "CustomerQueries to match the customer. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchItemIds": {
      "description": "List of item Ids for this query to match entry that have a related item.",
      "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"
          }
        }
      }
    },
    "itemQueries": {
      "description": "ItemQueries to match the item. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchPeriodIds": {
      "description": "List of period Ids for this query to match entry that have a related period.",
      "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"
          }
        }
      }
    },
    "periodQueries": {
      "description": "PeriodQueries to match the period. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchQuantity": {
      "description": "Match Entries with quantitys between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyQuantity": {
      "description": "Match quantitys with any value. true to match Entries with any quantity, false to match ProgramOfferings with no quantity",
      "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 Entries 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

• customerId: required(string)

  the customer of this metadatum.

  Example:

  billing.Customer%3A280%40base.url

• itemId: required(string)

  the item of this metadatum.

  Example:

  billing.Item%3A140%40base.url

• periodId: required(string)

  the period of this metadatum.

  Example:

  billing.Period%3A210%40base.url

• genusType: (string)

  specify a particular entry type to create

  Example:

  type.Type%3AexampleEntryType%40dxtera.org

• recordType: (array of )

  specify support for one or more entry record types

  Example:

  [
    "type.Type%3AexampleEntryRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this entry

  Example:

  billing.Business%3A8374%40base.url

URI Parameters

• entryId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• entryId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Entry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this 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 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
    },
    "startDate": {
      "description": "The starting date of this entry.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this entry.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this entry ended.",
      "type": "string",
      "format": "osid-id"
    },
    "customerId": {
      "description": "The customer associated with this entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "itemId": {
      "description": "The item associated with this entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "periodId": {
      "description": "The period associated with this entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "quantity": {
      "description": "The quantity of the item.",
      "type": "integer",
      "minimum": 1
    },
    "amount": {
      "description": "The amount of this entry.",
      "type": "string",
      "format": "currency"
    },
    "debit": {
      "description": "Tests if the amount is a debit or a credit.",
      "type": "boolean"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Entry",
  "description": "The description of this Entry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:820@base.url",
  "quantity": 19,
  "amount": "USD+42.00",
  "debit": true
}

URI Parameters

• entryId: required(string)

URI Parameters

• entryId: 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", 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%3AexamplePeriodType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePeriodType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePeriodType%40campusapi.org

• businessId: (string)

  The id string to match a business

  Example:

  billing.Business%3A8374%40base.url

Query Parameters

• genusType: (string)

  specify a particular period type to create

  Example:

  type.Type%3AexamplePeriodType%40dxtera.org

• recordType: (array of )

  specify support for one or more period record types

  Example:

  [
    "type.Type%3AexamplePeriodRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this period

  Example:

  billing.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Period",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this period, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this period, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this period for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this period.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this period. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this period. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "displayLabel": {
      "description": "A display label for this period which may be less formal than the display name.",
      "type": "string"
    },
    "openDate": {
      "description": "The open date.",
      "type": "string",
      "format": "date-time"
    },
    "closeDate": {
      "description": "The close date.",
      "type": "string",
      "format": "date-time"
    },
    "billingDate": {
      "description": "The billing date.",
      "type": "string",
      "format": "date-time"
    },
    "dueDate": {
      "description": "The due date.",
      "type": "string",
      "format": "date-time"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Period",
  "description": "The description of this Period",
  "displayLabel": "This is the DisplayLabel",
  "openDate": "2020-10-03T08:00:00.000Z",
  "closeDate": "2020-12-18T17:00:00.000Z",
  "billingDate": "2021-07-21T23:15:30.000Z",
  "dueDate": "2021-07-21T23:15:30.000Z"
}

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", 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": "PeriodQuery",
  "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"
          }
        }
      }
    },
    "matchDisplayLabel": {
      "description": "List of DisplayLabel strings to match. Boolean OR performed among multiple displayLabels.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayLabels": {
            "description": "displayLabels 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"
          }
        }
      }
    },
    "matchAnyDisplayLabel": {
      "description": "Match displayLabels with any value. true to match Periods with any display label, false to match ProgramOfferings with no display label",
      "type": "boolean"

    },
    "matchOpenDate": {
      "description": "Matches openDates 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"
          }
        }
      }
    },
    "matchAnyOpenDate": {
      "description": "Match openDates with any value. true to match Periods with any open date, false to match ProgramOfferings with no open date",
      "type": "boolean"

    },
    "matchCloseDate": {
      "description": "Matches closeDates 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"
          }
        }
      }
    },
    "matchAnyCloseDate": {
      "description": "Match closeDates with any value. true to match Periods with any close date, false to match ProgramOfferings with no close date",
      "type": "boolean"

    },
    "matchBillingDate": {
      "description": "Matches billingDates 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"
          }
        }
      }
    },
    "matchAnyBillingDate": {
      "description": "Match billingDates with any value. true to match Periods with any billing date, false to match ProgramOfferings with no billing date",
      "type": "boolean"

    },
    "matchDueDate": {
      "description": "Matches dueDates 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"
          }
        }
      }
    },
    "matchAnyDueDate": {
      "description": "Match dueDates with any value. true to match Periods with any due date, false to match ProgramOfferings with no due date",
      "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 period type to create

  Example:

  type.Type%3AexamplePeriodType%40dxtera.org

• recordType: (array of )

  specify support for one or more period record types

  Example:

  [
    "type.Type%3AexamplePeriodRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this period

  Example:

  billing.Business%3A8374%40base.url

URI Parameters

• periodId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• periodId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Period",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this period, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this period, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this period for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this period.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this period. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this period. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "displayLabel": {
      "description": "A display label for this period which may be less formal than the display name.",
      "type": "string"
    },
    "openDate": {
      "description": "The open date.",
      "type": "string",
      "format": "date-time"
    },
    "closeDate": {
      "description": "The close date.",
      "type": "string",
      "format": "date-time"
    },
    "billingDate": {
      "description": "The billing date.",
      "type": "string",
      "format": "date-time"
    },
    "dueDate": {
      "description": "The due date.",
      "type": "string",
      "format": "date-time"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Period",
  "description": "The description of this Period",
  "displayLabel": "This is the DisplayLabel",
  "openDate": "2020-10-03T08:00:00.000Z",
  "closeDate": "2020-12-18T17:00:00.000Z",
  "billingDate": "2021-07-21T23:15:30.000Z",
  "dueDate": "2021-07-21T23:15:30.000Z"
}

URI Parameters

• periodId: required(string)

URI Parameters

• periodId: 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

• customerId: (string)

  Get businesses mapped to this customer.

  Example:

  billing.Customer%3A448%40demo.dxtera.org

• itemId: (string)

  Get businesses mapped to this item.

  Example:

  billing.Item%3A224%40demo.dxtera.org

• categoryId: (string)

  Get businesses mapped to this category.

  Example:

  billing.Category%3A448%40demo.dxtera.org

• entryId: (string)

  Get businesses mapped to this entry.

  Example:

  billing.Entry%3A280%40demo.dxtera.org

• periodId: (string)

  Get businesses mapped to this period.

  Example:

  billing.Period%3A336%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: "genusType", "recordType", 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": "billing.Business:70@base.url",
    "uri": "http://base.url/open/campusapi/billing/business/billing.Business%3A70%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", "activity", "resource", 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%3AexampleCustomerType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCustomerType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCustomerType%40campusapi.org

URI Parameters

• businessId: required(string)
• customerId: required(string)

URI Parameters

• businessId: required(string)
• customerId: 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", "category", "account", "product", 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%3AexampleItemType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleItemType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleItemType%40campusapi.org

URI Parameters

• businessId: required(string)
• itemId: required(string)

URI Parameters

• businessId: required(string)
• itemId: 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", 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%3AexampleCategoryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCategoryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCategoryType%40campusapi.org

URI Parameters

• businessId: required(string)
• categoryId: required(string)

URI Parameters

• businessId: required(string)
• categoryId: 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", "endReason", "customer", "item", "period", 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%3AexampleEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleEntryType%40campusapi.org

URI Parameters

• businessId: required(string)
• entryId: required(string)

URI Parameters

• businessId: required(string)
• entryId: 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", 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%3AexamplePeriodType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePeriodType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePeriodType%40campusapi.org

URI Parameters

• businessId: required(string)
• periodId: required(string)

URI Parameters

• businessId: required(string)
• periodId: required(string)