CampusAPI Payment Services API documentation version N/A
NOTICE - The CampusAPI Documentation has moved.
Please point your browser to CampusAPI.org for the latest versions.
https://demo.dxtera.org/open/campusapi/payment
Overview
The Billing Payment service package manages billing payments.
This package includes the following entities:
Payers
A Payer is an entity that pays bills. A Payer a method of payment. Customers can have multiple Payers but a Payer is not required to relate to a Customer. A Payer may have its own identity through a Resource.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this payer, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this payer, provided by system. | string(uri) |
| displayName | The name of this payer for display. | string |
| description | The description of this payer. | string |
| genusType (read‑only) | The immutable type of this payer. Default type set by system unless specified in query parameter. | string(osid‑type) |
| startDate | The starting date of this payer. | string(date‑time) |
| endDate | The ending date of this payer. | string(date‑time) |
| resourceId (read‑only) | The resource associated with this payer. References a resource.Resource object. | string(osid‑id) |
| customerId | The customer. References a billing.Customer object | string(osid‑id) |
| usesActivity | Tests if this payer uses the customer financial activity for payments. | boolean |
| usesCash | Tests if this payer uses cash for payments. | boolean |
| creditCardNumber | The credit card number. | string |
| creditCardExpiration | The credit card expiration date. | string(date‑time) |
| creditCardCode | The credit card security code. | string |
| bankRoutingNumber | The bank routing number. | string |
| bankAccountNumber | The bank account number. | string |
Payments
A Payment is an amount paid by a Payer for an amount owed by a Customer. Typically, the Customer for which the Payment applied is the same Customer related to the Payer but Payments may be applied to different Customers.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this payment, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this payment, provided by system. | string(uri) |
| displayName | The name of this payment for display. | string |
| description | The description of this payment. | string |
| genusType (read‑only) | The immutable type of this payment. Default type set by system unless specified in query parameter. | string(osid‑type) |
| payerId (read‑only) | The payer associated with this payment. References a payment.Payer object. | string(osid‑id) |
| customerId (read‑only) | The customer associated with this payment. References a payment.Payer object. References a billing.Customer object. | string(osid‑id) |
| periodId | The billing period to which this payment applied. References a billing.Period object | string(osid‑id) |
| paymentDate | The date the payment was made. | string(date‑time) |
| processDate | The date the payment was or will be processed. | string(date‑time) |
| amount | The amount of this payment. | string(currency) |
Businesses
Customers, Items, Categories, Entries, and Periods can be organized into federateble Businesses.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this business, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this business, provided by system. | string(uri) |
| displayName | The name of this business for display. | string |
| description | The description of this business. | string |
| genusType (read‑only) | The immutable type of this business. Default type set by system unless specified in query parameter. | string(osid‑type) |
| providerId | The provider of this business. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this business. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this business. | string |
License
CampusAPI REST Documentation Copyright 2020 DXtera Institute. Based on the Open Service Interface Defitions: http://osid.org
/payers
Collection of payers in a system, federation of systems, or in a default business.
get
Get all payers in the system or default business.
post
Create a new payer in the default business.
get /payers
Get all payers in the system or default business.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusType: (string)
The id string to match a genusType
Example:
type.Type%3AexamplePayerType%40dxtera.org - parentGenusType: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExamplePayerType%40dxtera.org - fromDate: (string)
Get all payers from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all payers 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%3A320%40demo.dxtera.org - customerId: (string)
Id string to match customer.
Example:
billing.Customer%3A6704%40demo.dxtera.org - businessId: (string)
The id string to match a business
Example:
billing.Business%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "payment.Payer:8301@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/payment/payer/payment.Payer%3A8301%40demo.dxtera.org",
"displayName": "Display Name of this Payer",
"description": "The description of this Payer",
"genusType": "type.Type:defaultPayerType@dxtera.org",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"resourceId": "resource.Resource:3034@demo.dxtera.org",
"customerId": "billing.Customer:6704@demo.dxtera.org",
"usesActivity": true,
"usesCash": true,
"creditCardNumber": "101",
"creditCardExpiration": "2021-07-21T23:15:30.000Z",
"creditCardCode": "This is the string for CreditCardCode",
"bankRoutingNumber": "101",
"bankAccountNumber": "101"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /payers
Create a new payer in the default business.
Query Parameters
- resourceId: required(string)
the resource of this payer.
Example:
resource.Resource%3A320%40demo.dxtera.org - genusType: (string)
specify a particular payer type to create
Example:
type.Type%3AexamplePayerType%40dxtera.org - businessId: (string)
specify in which business to create this payer
Example:
payment.Business%3A8374%40demo.dxtera.org
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Payer",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this payer, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this payer, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this payer for display.",
"type": "string"
},
"description": {
"description": "The description of this payer.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this payer. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this payer.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this payer.",
"type": "string",
"format": "date-time"
},
"resourceId": {
"description": "The resource associated with this payer.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"customerId": {
"description": "The customer.",
"type": "string",
"format": "osid-id"
},
"usesActivity": {
"description": "Tests if this payer uses the customer financial activity for payments.",
"type": "boolean"
},
"usesCash": {
"description": "Tests if this payer uses cash for payments.",
"type": "boolean"
},
"creditCardNumber": {
"description": "The credit card number.",
"type": "string"
},
"creditCardExpiration": {
"description": "The credit card expiration date.",
"type": "string",
"format": "date-time"
},
"creditCardCode": {
"description": "The credit card security code.",
"type": "string"
},
"bankRoutingNumber": {
"description": "The bank routing number.",
"type": "string"
},
"bankAccountNumber": {
"description": "The bank account number.",
"type": "string"
}
}
}Example:
{
"id": "payment.Payer:5053@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/payment/payer/payment.Payer%3A5053%40demo.dxtera.org",
"displayName": "Display Name of this Payer",
"description": "The description of this Payer",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"customerId": "billing.Customer:5891@demo.dxtera.org",
"usesActivity": true,
"usesCash": true,
"creditCardNumber": "101",
"creditCardExpiration": "2021-07-21T23:15:30.000Z",
"creditCardCode": "This is the string for CreditCardCode",
"bankRoutingNumber": "101",
"bankAccountNumber": "101"
}
Entity representing a payer form metadata.
get
Get form metadata for creating a new payer.
get /payers/metadata
Get form metadata for creating a new payer.
Query Parameters
- resourceId: required(string)
the resource of this metadatum.
Example:
resource.Resource%3A320%40demo.dxtera.org - genusType: (string)
specify a particular payer type to create
Example:
type.Type%3AexamplePayerType%40dxtera.org - businessId: (string)
specify in which business to create this payer
Example:
payment.Business%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Payer",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this payer, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this payer, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this payer for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Payer.Payer:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this payer",
"linked": false
},
"description": {
"description": "The description of this payer.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Payer.Payer:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this payer",
"linked": false
},
"genusType": {
"description": "The immutable type of this payer. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this payer.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Payer.Payer:startDate@demo.dxtera.org",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this payer",
"linked": false
},
"endDate": {
"description": "The ending date of this payer.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Payer.Payer:endDate@demo.dxtera.org",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this payer",
"linked": false
},
"customerId": {
"description": "The customer.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payer:customer@dxtera.org",
"existingValue": null,
"elementLabel": "Customer",
"instructions": "Enter the Id of the customer for this payer.",
"linked": false
},
"usesActivity": {
"description": "Tests if this payer uses the customer financial activity for payments.",
"type": "boolean",
"elementId": "billing.payment.Payer:usesActivity@dxtera.org",
"existingValue": false,
"elementLabel": "Uses Activity",
"instructions": "Enter true or false.",
"linked": false
},
"usesCash": {
"description": "Tests if this payer uses cash for payments.",
"type": "boolean",
"elementId": "billing.payment.Payer:usesCash@dxtera.org",
"existingValue": false,
"elementLabel": "Uses Cash",
"instructions": "Enter true or false.",
"linked": false
},
"creditCardNumber": {
"description": "The credit card number.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payer:creditCardNumber@dxtera.org",
"existingValue": "The existing credit card number",
"elementLabel": "Credit Card Number",
"instructions": "Enter a credit card number for this payer.",
"linked": false
},
"creditCardExpiration": {
"description": "The credit card expiration date.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payer:creditCardExpiration@dxtera.org",
"existingValue": "",
"elementLabel": "Credit Card Expiration",
"instructions": "Enter the credit card expiration of this payer.",
"linked": false
},
"creditCardCode": {
"description": "The credit card security code.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payer:creditCardCode@dxtera.org",
"existingValue": "The existing credit card code",
"elementLabel": "Credit Card Code",
"instructions": "Enter a credit card code for this payer.",
"linked": false
},
"bankRoutingNumber": {
"description": "The bank routing number.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payer:bankRoutingNumber@dxtera.org",
"existingValue": "The existing bank routing number",
"elementLabel": "Bank Routing Number",
"instructions": "Enter a bank routing number for this payer.",
"linked": false
},
"bankAccountNumber": {
"description": "The bank account number.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payer:bankAccountNumber@dxtera.org",
"existingValue": "The existing bank account number",
"elementLabel": "Bank Account Number",
"instructions": "Enter a bank account number for this payer.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a payer
get
Get a payer given its id.
put
Update a given payer.
delete
Delete a given payer.
get /payers/{payerId}
Get a payer given its id.
URI Parameters
- payerId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "payment.Payer:8301@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/payment/payer/payment.Payer%3A8301%40demo.dxtera.org",
"displayName": "Display Name of this Payer",
"description": "The description of this Payer",
"genusType": "type.Type:defaultPayerType@dxtera.org",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"resourceId": "resource.Resource:3034@demo.dxtera.org",
"customerId": "billing.Customer:6704@demo.dxtera.org",
"usesActivity": true,
"usesCash": true,
"creditCardNumber": "101",
"creditCardExpiration": "2021-07-21T23:15:30.000Z",
"creditCardCode": "This is the string for CreditCardCode",
"bankRoutingNumber": "101",
"bankAccountNumber": "101"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "payer not found" }
put /payers/{payerId}
Update a given payer.
URI Parameters
- payerId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Payer",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this payer, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this payer, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this payer for display.",
"type": "string"
},
"description": {
"description": "The description of this payer.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this payer. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this payer.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this payer.",
"type": "string",
"format": "date-time"
},
"resourceId": {
"description": "The resource associated with this payer.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"customerId": {
"description": "The customer.",
"type": "string",
"format": "osid-id"
},
"usesActivity": {
"description": "Tests if this payer uses the customer financial activity for payments.",
"type": "boolean"
},
"usesCash": {
"description": "Tests if this payer uses cash for payments.",
"type": "boolean"
},
"creditCardNumber": {
"description": "The credit card number.",
"type": "string"
},
"creditCardExpiration": {
"description": "The credit card expiration date.",
"type": "string",
"format": "date-time"
},
"creditCardCode": {
"description": "The credit card security code.",
"type": "string"
},
"bankRoutingNumber": {
"description": "The bank routing number.",
"type": "string"
},
"bankAccountNumber": {
"description": "The bank account number.",
"type": "string"
}
}
}Example:
{
"id": "payment.Payer:5053@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/payment/payer/payment.Payer%3A5053%40demo.dxtera.org",
"displayName": "Display Name of this Payer",
"description": "The description of this Payer",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"customerId": "billing.Customer:5891@demo.dxtera.org",
"usesActivity": true,
"usesCash": true,
"creditCardNumber": "101",
"creditCardExpiration": "2021-07-21T23:15:30.000Z",
"creditCardCode": "This is the string for CreditCardCode",
"bankRoutingNumber": "101",
"bankAccountNumber": "101"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The payer has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "payer not found" }
delete /payers/{payerId}
Delete a given payer.
URI Parameters
- payerId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The payer has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "payer not found" }
Entity representing a payer form metadata for update
get
Get form metadata for updating an existing payer.
get /payers/{payerId}/metadata
Get form metadata for updating an existing payer.
URI Parameters
- payerId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Payer",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this payer, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this payer, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this payer for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Payer.Payer:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this payer",
"linked": false
},
"description": {
"description": "The description of this payer.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Payer.Payer:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this payer",
"linked": false
},
"genusType": {
"description": "The immutable type of this payer. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this payer.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Payer.Payer:startDate@demo.dxtera.org",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this payer",
"linked": false
},
"endDate": {
"description": "The ending date of this payer.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Payer.Payer:endDate@demo.dxtera.org",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this payer",
"linked": false
},
"customerId": {
"description": "The customer.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payer:customer@dxtera.org",
"existingValue": null,
"elementLabel": "Customer",
"instructions": "Enter the Id of the customer for this payer.",
"linked": false
},
"usesActivity": {
"description": "Tests if this payer uses the customer financial activity for payments.",
"type": "boolean",
"elementId": "billing.payment.Payer:usesActivity@dxtera.org",
"existingValue": false,
"elementLabel": "Uses Activity",
"instructions": "Enter true or false.",
"linked": false
},
"usesCash": {
"description": "Tests if this payer uses cash for payments.",
"type": "boolean",
"elementId": "billing.payment.Payer:usesCash@dxtera.org",
"existingValue": false,
"elementLabel": "Uses Cash",
"instructions": "Enter true or false.",
"linked": false
},
"creditCardNumber": {
"description": "The credit card number.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payer:creditCardNumber@dxtera.org",
"existingValue": "The existing credit card number",
"elementLabel": "Credit Card Number",
"instructions": "Enter a credit card number for this payer.",
"linked": false
},
"creditCardExpiration": {
"description": "The credit card expiration date.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payer:creditCardExpiration@dxtera.org",
"existingValue": "",
"elementLabel": "Credit Card Expiration",
"instructions": "Enter the credit card expiration of this payer.",
"linked": false
},
"creditCardCode": {
"description": "The credit card security code.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payer:creditCardCode@dxtera.org",
"existingValue": "The existing credit card code",
"elementLabel": "Credit Card Code",
"instructions": "Enter a credit card code for this payer.",
"linked": false
},
"bankRoutingNumber": {
"description": "The bank routing number.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payer:bankRoutingNumber@dxtera.org",
"existingValue": "The existing bank routing number",
"elementLabel": "Bank Routing Number",
"instructions": "Enter a bank routing number for this payer.",
"linked": false
},
"bankAccountNumber": {
"description": "The bank account number.",
"type": "string",
"read-only": false,
"minLength": null,
"maxLength": null,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payer:bankAccountNumber@dxtera.org",
"existingValue": "The existing bank account number",
"elementLabel": "Bank Account Number",
"instructions": "Enter a bank account number for this payer.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "payer not found" }
/payments
Collection of payments in a system, federation of systems, or in a default business.
get
Get all payments in the system or default business.
post
Create a new payment in the default business.
get /payments
Get all payments in the system or default business.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusType: (string)
The id string to match a genusType
Example:
type.Type%3AexamplePaymentType%40dxtera.org - parentGenusType: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExamplePaymentType%40dxtera.org - payerId: (string)
the id string to match a payer.
Example:
payment.Payer%3A245%40demo.dxtera.org - customerId: (string)
the id string to match a customer.
Example:
billing.Customer%3A392%40demo.dxtera.org - fromDate: (string)
Get all payments from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all payments up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - businessId: (string)
The id string to match a business
Example:
billing.Business%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "payment.Payment:1731@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/payment/payment/payment.Payment%3A1731%40demo.dxtera.org",
"displayName": "Display Name of this Payment",
"description": "The description of this Payment",
"genusType": "type.Type:defaultPaymentType@dxtera.org",
"payerId": "billing.payment.Payer:7031@demo.dxtera.org",
"customerId": "billing.Customer:6745@demo.dxtera.org",
"periodId": "billing.Period:5488@demo.dxtera.org",
"paymentDate": "2021-07-21T23:15:30.000Z",
"processDate": "2021-07-21T23:15:30.000Z",
"amount": "USD+42.00"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /payments
Create a new payment in the default business.
Query Parameters
- payerId: required(string)
the payer of this payment.
Example:
payment.Payer%3A245%40demo.dxtera.org - customerId: required(string)
the customer of this payment.
Example:
billing.Customer%3A392%40demo.dxtera.org - genusType: (string)
specify a particular payment type to create
Example:
type.Type%3AexamplePaymentType%40dxtera.org - businessId: (string)
specify in which business to create this payment
Example:
payment.Business%3A8374%40demo.dxtera.org
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Payment",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this payment, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this payment, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this payment for display.",
"type": "string"
},
"description": {
"description": "The description of this payment.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this payment. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"payerId": {
"description": "The payer associated with this payment.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"customerId": {
"description": "The customer associated with this payment.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"periodId": {
"description": "The billing period to which this payment applied.",
"type": "string",
"format": "osid-id"
},
"paymentDate": {
"description": "The date the payment was made.",
"type": "string",
"format": "date-time"
},
"processDate": {
"description": "The date the payment was or will be processed.",
"type": "string",
"format": "date-time"
},
"amount": {
"description": "The amount of this payment.",
"type": "string",
"format": "currency"
}
}
}Example:
{
"id": "payment.Payment:5210@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/payment/payment/payment.Payment%3A5210%40demo.dxtera.org",
"displayName": "Display Name of this Payment",
"description": "The description of this Payment",
"periodId": "billing.Period:3933@demo.dxtera.org",
"paymentDate": "2021-07-21T23:15:30.000Z",
"processDate": "2021-07-21T23:15:30.000Z",
"amount": "USD+42.00"
}
Entity representing a payment form metadata.
get
Get form metadata for creating a new payment.
get /payments/metadata
Get form metadata for creating a new payment.
Query Parameters
- payerId: required(string)
the payer of this metadatum.
Example:
payment.Payer%3A245%40demo.dxtera.org - customerId: required(string)
the customer of this metadatum.
Example:
billing.Customer%3A392%40demo.dxtera.org - genusType: (string)
specify a particular payment type to create
Example:
type.Type%3AexamplePaymentType%40dxtera.org - businessId: (string)
specify in which business to create this payment
Example:
payment.Business%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Payment",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this payment, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this payment, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this payment for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Payment.Payment:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this payment",
"linked": false
},
"description": {
"description": "The description of this payment.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Payment.Payment:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this payment",
"linked": false
},
"genusType": {
"description": "The immutable type of this payment. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"periodId": {
"description": "The billing period to which this payment applied.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payment:period@dxtera.org",
"existingValue": null,
"elementLabel": "Period",
"instructions": "Enter the Id of the period for this payment.",
"linked": false
},
"paymentDate": {
"description": "The date the payment was made.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payment:paymentDate@dxtera.org",
"existingValue": "",
"elementLabel": "Payment Date",
"instructions": "Enter the payment date of this payment.",
"linked": false
},
"processDate": {
"description": "The date the payment was or will be processed.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payment:processDate@dxtera.org",
"existingValue": "",
"elementLabel": "Process Date",
"instructions": "Enter the process date of this payment.",
"linked": false
},
"amount": {
"description": "The amount of this payment.",
"type": "string",
"format": "currency",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payment:amount@dxtera.org",
"existingValue": "USD+120.56",
"elementLabel": "Amount",
"instructions": "Enter the amount of this payment.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a payment
get
Get a payment given its id.
put
Update a given payment.
delete
Delete a given payment.
get /payments/{paymentId}
Get a payment given its id.
URI Parameters
- paymentId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "payment.Payment:1731@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/payment/payment/payment.Payment%3A1731%40demo.dxtera.org",
"displayName": "Display Name of this Payment",
"description": "The description of this Payment",
"genusType": "type.Type:defaultPaymentType@dxtera.org",
"payerId": "billing.payment.Payer:7031@demo.dxtera.org",
"customerId": "billing.Customer:6745@demo.dxtera.org",
"periodId": "billing.Period:5488@demo.dxtera.org",
"paymentDate": "2021-07-21T23:15:30.000Z",
"processDate": "2021-07-21T23:15:30.000Z",
"amount": "USD+42.00"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "payment not found" }
put /payments/{paymentId}
Update a given payment.
URI Parameters
- paymentId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Payment",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this payment, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this payment, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this payment for display.",
"type": "string"
},
"description": {
"description": "The description of this payment.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this payment. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"payerId": {
"description": "The payer associated with this payment.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"customerId": {
"description": "The customer associated with this payment.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"periodId": {
"description": "The billing period to which this payment applied.",
"type": "string",
"format": "osid-id"
},
"paymentDate": {
"description": "The date the payment was made.",
"type": "string",
"format": "date-time"
},
"processDate": {
"description": "The date the payment was or will be processed.",
"type": "string",
"format": "date-time"
},
"amount": {
"description": "The amount of this payment.",
"type": "string",
"format": "currency"
}
}
}Example:
{
"id": "payment.Payment:5210@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/payment/payment/payment.Payment%3A5210%40demo.dxtera.org",
"displayName": "Display Name of this Payment",
"description": "The description of this Payment",
"periodId": "billing.Period:3933@demo.dxtera.org",
"paymentDate": "2021-07-21T23:15:30.000Z",
"processDate": "2021-07-21T23:15:30.000Z",
"amount": "USD+42.00"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The payment has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "payment not found" }
delete /payments/{paymentId}
Delete a given payment.
URI Parameters
- paymentId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The payment has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "payment not found" }
Entity representing a payment form metadata for update
get
Get form metadata for updating an existing payment.
get /payments/{paymentId}/metadata
Get form metadata for updating an existing payment.
URI Parameters
- paymentId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Payment",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this payment, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this payment, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this payment for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Payment.Payment:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this payment",
"linked": false
},
"description": {
"description": "The description of this payment.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Payment.Payment:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this payment",
"linked": false
},
"genusType": {
"description": "The immutable type of this payment. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"periodId": {
"description": "The billing period to which this payment applied.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payment:period@dxtera.org",
"existingValue": null,
"elementLabel": "Period",
"instructions": "Enter the Id of the period for this payment.",
"linked": false
},
"paymentDate": {
"description": "The date the payment was made.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payment:paymentDate@dxtera.org",
"existingValue": "",
"elementLabel": "Payment Date",
"instructions": "Enter the payment date of this payment.",
"linked": false
},
"processDate": {
"description": "The date the payment was or will be processed.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payment:processDate@dxtera.org",
"existingValue": "",
"elementLabel": "Process Date",
"instructions": "Enter the process date of this payment.",
"linked": false
},
"amount": {
"description": "The amount of this payment.",
"type": "string",
"format": "currency",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "billing.payment.Payment:amount@dxtera.org",
"existingValue": "USD+120.56",
"elementLabel": "Amount",
"instructions": "Enter the amount of this payment.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "payment not found" }
/businesses
Collection of businesses in a system or federation of systems.
get
Get all businesses.
post
Create a new business.
get /businesses
Get all businesses.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusType: (string)
The id string to match a genusType
Example:
type.Type%3AexampleBusinessType%40dxtera.org - parentGenusType: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleBusinessType%40dxtera.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3007%40demo.dxtera.org - payerId: (string)
Get businesses mapped to this payer.
Example:
payment.Payer%3A280%40demo.dxtera.org - paymentId: (string)
Get businesses mapped to this payment.
Example:
payment.Payment%3A392%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "billing.Business:2698@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/billing/business/billing.Business%3A2698%40demo.dxtera.org",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"genusType": "type.Type:defaultBusinessType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Business@demo.dxtera.org",
"license": "The license that applies to this Business"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /businesses
Create a new business.
Query Parameters
- genusType: (string)
specify a particular business type to create
Example:
type.Type%3AexampleBusinessType%40dxtera.org
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Business",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this business, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this business, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this business for display.",
"type": "string"
},
"description": {
"description": "The description of this business.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this business. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this business.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this business. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this business.",
"type": "string"
}
}
}Example:
{
"id": "billing.Business:7994@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/billing/business/billing.Business%3A7994%40demo.dxtera.org",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Business@demo.dxtera.org",
"license": "The license that applies to this Business"
}
Entity representing a business form metadata.
get
Get form metadata for creating a new business.
get /businesses/metadata
Get form metadata for creating a new business.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Business",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this business, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this business, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this business for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this business",
"linked": false
},
"description": {
"description": "The description of this business.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this business",
"linked": false
},
"genusType": {
"description": "The immutable type of this business. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this business.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:provider@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this business",
"linked": false
},
"brandingIds": {
"description": "The branding of this business. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Business.Business:branding@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this business",
"linked": false
},
"license": {
"description": "The licensing that applies to this business.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:license@demo.dxtera.org",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this business",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root businesses in the business hierarchy. A node with no parents is an orphan. While all business Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
get
Get all root root-business
get /businesses/root-business
Get all root root-business
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "billing.Business:2698@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/billing/business/billing.Business%3A2698%40demo.dxtera.org",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"genusType": "type.Type:defaultBusinessType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Business@demo.dxtera.org",
"license": "The license that applies to this Business"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a business
get
Get a business given its id.
put
Update a given business.
delete
Delete a given business.
get /businesses/{businessId}
Get a business given its id.
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "billing.Business:2698@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/billing/business/billing.Business%3A2698%40demo.dxtera.org",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"genusType": "type.Type:defaultBusinessType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Business@demo.dxtera.org",
"license": "The license that applies to this Business"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "business not found" }
put /businesses/{businessId}
Update a given business.
URI Parameters
- businessId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Business",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this business, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this business, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this business for display.",
"type": "string"
},
"description": {
"description": "The description of this business.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this business. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this business.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this business. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this business.",
"type": "string"
}
}
}Example:
{
"id": "billing.Business:7994@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/billing/business/billing.Business%3A7994%40demo.dxtera.org",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Business@demo.dxtera.org",
"license": "The license that applies to this Business"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The business has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "business not found" }
delete /businesses/{businessId}
Delete a given business.
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The business has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "business not found" }
Entity representing a business form metadata for update
get
Get form metadata for updating an existing business.
get /businesses/{businessId}/metadata
Get form metadata for updating an existing business.
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Business",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this business, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this business, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this business for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this business",
"linked": false
},
"description": {
"description": "The description of this business.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this business",
"linked": false
},
"genusType": {
"description": "The immutable type of this business. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this business.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:provider@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this business",
"linked": false
},
"brandingIds": {
"description": "The branding of this business. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Business.Business:branding@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this business",
"linked": false
},
"license": {
"description": "The licensing that applies to this business.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Business.Business:license@demo.dxtera.org",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this business",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "business not found" }
get
Get children businesses for the given business in the hierarchy.
get /businesses/{businessId}/children
Get children businesses for the given business in the hierarchy.
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "billing.Business:2698@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/billing/business/billing.Business%3A2698%40demo.dxtera.org",
"displayName": "Display Name of this Business",
"description": "The description of this Business",
"genusType": "type.Type:defaultBusinessType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Business@demo.dxtera.org",
"license": "The license that applies to this Business"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add business as child of the given business in the hierarchy.
delete
Remove the given business as a child of the given business in the hierarchy.
put /businesses/{businessId}/children/{childId}
Add business as child of the given business in the hierarchy.
URI Parameters
- businessId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child business has been added" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "business not found" }
delete /businesses/{businessId}/children/{childId}
Remove the given business as a child of the given business in the hierarchy.
get
Get all payers in this business
get /businesses/{businessId}/payers
Get all payers in this business
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "payment.Payer:8301@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/payment/payer/payment.Payer%3A8301%40demo.dxtera.org",
"displayName": "Display Name of this Payer",
"description": "The description of this Payer",
"genusType": "type.Type:defaultPayerType@dxtera.org",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"resourceId": "resource.Resource:3034@demo.dxtera.org",
"customerId": "billing.Customer:6704@demo.dxtera.org",
"usesActivity": true,
"usesCash": true,
"creditCardNumber": "101",
"creditCardExpiration": "2021-07-21T23:15:30.000Z",
"creditCardCode": "This is the string for CreditCardCode",
"bankRoutingNumber": "101",
"bankAccountNumber": "101"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given payer to this business
delete
Remove the given payer from the business.
put /businesses/{businessId}/payers/{payerId}
Add the given payer to this business
URI Parameters
- businessId: required(string)
- payerId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "payer has been added to business" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "payer not found" }
delete /businesses/{businessId}/payers/{payerId}
Remove the given payer from the business.
URI Parameters
- businessId: required(string)
- payerId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "payer has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "payer not found" }
get
Get all payments in this business
get /businesses/{businessId}/payments
Get all payments in this business
URI Parameters
- businessId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "payment.Payment:1731@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/payment/payment/payment.Payment%3A1731%40demo.dxtera.org",
"displayName": "Display Name of this Payment",
"description": "The description of this Payment",
"genusType": "type.Type:defaultPaymentType@dxtera.org",
"payerId": "billing.payment.Payer:7031@demo.dxtera.org",
"customerId": "billing.Customer:6745@demo.dxtera.org",
"periodId": "billing.Period:5488@demo.dxtera.org",
"paymentDate": "2021-07-21T23:15:30.000Z",
"processDate": "2021-07-21T23:15:30.000Z",
"amount": "USD+42.00"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given payment to this business
delete
Remove the given payment from the business.
put /businesses/{businessId}/payments/{paymentId}
Add the given payment to this business
URI Parameters
- businessId: required(string)
- paymentId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "payment has been added to business" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "payment not found" }
delete /businesses/{businessId}/payments/{paymentId}
Remove the given payment from the business.
URI Parameters
- businessId: required(string)
- paymentId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "payment has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "payment not found" }