Customer
Osid Object
A Customer represents data associated
to a resource representing a customer. Contact
information for this object can be managed in the
Contact OSID.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
Item
Osid Object
An Item is a product or service.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Name | Syntax | Many | Description |
|---|---|---|---|
categoryId |
id | the category Id |
|
category |
Category | the category | |
hasAccount |
boolean | true if this item has an account, false
otherwise |
|
accountId |
id | the account Id |
|
account |
Account | the account | |
hasProduct |
boolean | true if this item has a product, false otherwise |
|
productId |
id | the product Id |
|
product |
Product | the product | |
amount |
Currency | the amount | |
isDebit |
boolean | true if this item amount is a debit, false if it
is a credit |
|
isRecurring |
boolean | true if this item is recurring, false if
one-time |
|
recurringInterval |
duration | the interval |
Category
Osid Object
A Category is a group of
Items.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
Entry
Osid Relationship
An Entry is a relationship between a
customer and item in a billing period.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
customerId |
id | the customer Id |
|
customer |
Customer | the customer | |
itemId |
id | the item Id |
|
item |
Item | the item | |
periodId |
id | the Period Id |
|
period |
Period | the period | |
quantity |
cardinal | the quantity | |
amount |
Currency | the amount | |
isDebit |
boolean | true if this item amount is a debit, false if it
is a credit |
Period
Osid Object
A Period represents a billing period.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Name | Syntax | Many | Description |
|---|---|---|---|
displayLabel |
displaytext | the period label | |
hasOpenDate |
boolean | true if there is an open date associated with this period,
false otherwise |
|
openDate |
datetime | the open date | |
hasCloseDate |
boolean | true if there is a close date associated with this period,
false otherwise |
|
closeDate |
datetime | the close date | |
hasBillingDate |
boolean | true if there is a billing date associated with this period,
false otherwise |
|
billingDate |
datetime | the billing date | |
hasDueDate |
boolean | true if there is a due date associated with this period,
false otherwise |
|
dueDate |
datetime | the due date |
Business
Osid Catalog
A Business represents a collection of
customers, categories, items, entries, and periods.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Sourceable | |||
providerId |
id | the provider Id |
|
provider |
Resource | the provider | |
brandingIds |
id | ⋆ | a list of asset Ids |
branding |
Asset | ⋆ | a list of assets |
license |
displaytext | the license | |