org.osid.billing

Interface Summary
Interface	Description
BillingManager	The billing manager provides access to customer management sessions and provides interoperability tests for various aspects of this service.
BillingProfile	The billing profile describes the interoperability among billing management services.
BillingProxyManager	The customer manager provides access to customer management sessions and provides interoperability tests for various aspects of this service.
Business	A `Business` represents a collection of customers, categories, items, entries, and periods.
BusinessAdminSession	This session creates, updates, and deletes `Businesses.`
BusinessForm	This is the form for creating and updating businesses.
BusinessHierarchyDesignSession	This session defines methods for managing a hierarchy of `Business` objects.
BusinessHierarchySession	This session defines methods for traversing a hierarchy of `Business` objects.
BusinessList	Like all `OsidLists,` `BusinessList` provides a means for accessing `Business` elements sequentially either one at a time or many at a time.
BusinessLookupSession	This session provides methods for retrieving `Business` objects.
BusinessNode	This interface is a container for a partial hierarchy retrieval.
BusinessNodeList	Like all `OsidLists,` `BusinessNodeList` provides a means for accessing `BusinessNode` elements sequentially either one at a time or many at a time.
BusinessNotificationSession	This session defines methods to receive notifications on adds/changes to `Business` objects.
BusinessQuery	This is the query for searching businesses.
BusinessQueryInspector	The query inspectors provide a means of accessing the match terms of a query.
BusinessQuerySession	This session provides methods for searching among `Business` objects.
BusinessReceiver	The business receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Business objects.
BusinessSearch	The search interface for governing business searches.
BusinessSearchOrder	An interface for specifying the ordering of search results.
BusinessSearchResults	This interface provides a means to capture results of a search.
BusinessSearchSession	This session provides methods for searching among `Business` objects.
Category	A `Category` is a group of `Items.`
CategoryAdminSession	This session creates, updates, and deletes `Categories.`
CategoryBusinessAssignmentSession	This session provides methods to re-assign `Categories` to `Business` objects A `Category` may appear in multiple `Business` objects and removing the last reference to a `Category` is the equivalent of deleting it.
CategoryBusinessSession	This session provides methods to retrieve `Category` to `Business` mappings.
CategoryForm	This is the form for creating and updating `Categories.`
CategoryList	Like all `OsidLists,` `CategoryList` provides a means for accessing `Category` elements sequentially either one at a time or many at a time.
CategoryLookupSession	This session defines methods for retrieving categories.
CategoryNotificationSession	This session defines methods to receive notifications on adds/changes to `Category` objects in this `Business.`
CategoryQuery	This is the query for searching categories.
CategoryQueryInspector	The query inspectors provide a means of accessing the match terms of a query.
CategoryQuerySession	This session provides methods for searching among `Category` objects.
CategoryReceiver	The category receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted category objects.
CategorySearch	The search interface for governing category searches.
CategorySearchOrder	An interface for specifying the ordering of search results.
CategorySearchResults	This interface provides a means to capture results of a search.
CategorySearchSession	This session provides methods for searching among `Category` objects.
CategorySmartBusinessSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Customer	A `Customer` represents data associated to a resource representing a customer.
CustomerAdminSession	This session creates, updates, and deletes `Customers.`
CustomerBusinessAssignmentSession	This session provides methods to re-assign `Customers` to `Business` objects A `Customer` may appear in multiple `Business` objects and removing the last reference to a `Customer` is the equivalent of deleting it.
CustomerBusinessSession	This session provides methods to retrieve `Customer` to `Business` mappings.
CustomerForm	This is the form for creating and updating `Customers.`
CustomerList	Like all `OsidLists,` `CustomerList` provides a means for accessing `Customer` elements sequentially either one at a time or many at a time.
CustomerLookupSession	This session defines methods for retrieving customers.
CustomerNotificationSession	This session defines methods to receive notifications on adds/changes to `Customer` objects in this `Business.`
CustomerQuery	This is the query for searching customers.
CustomerQueryInspector	The query inspectors provide a means of accessing the match terms of a query.
CustomerQuerySession	This session provides methods for searching among `Customer` objects.
CustomerReceiver	The customer receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Customer` objects.
CustomerSearch	The search interface for governing customer searches.
CustomerSearchOrder	An interface for specifying the ordering of search results.
CustomerSearchResults	This interface provides a means to capture results of a search.
CustomerSearchSession	This session provides methods for searching among `Customer` objects.
CustomerSmartBusinessSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Entry	An `Entry` is a relationship between a customer and item in a billing period.
EntryAdminSession	This session creates, updates, and deletes `Entries.`
EntryBusinessAssignmentSession	This session provides methods to re-assign `Entries` to `Business` objects An `Entry` may appear in multiple `Business` objects and removing the last reference to an `Entry` is the equivalent of deleting it.
EntryBusinessSession	This session provides methods to retrieve `Entry` to `Business` mappings.
EntryForm	This is the form for creating and updating `Entries.`
EntryList	Like all `OsidLists,` `EntryList` provides a means for accessing `Entry` elements sequentially either one at a time or many at a time.
EntryLookupSession	This session provides methods for retrieving `Entry` objects.
EntryNotificationSession	This session defines methods to receive notifications on adds/changes to `Entry` objects in this `Business.`
EntryQuery	This is the query for searching entries.
EntryQueryInspector	The query inspectors provide a means of accessing the match terms of a query.
EntryQuerySession	This session provides methods for searching among `Entry` objects.
EntryReceiver	The entry receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Entry` objects.
EntrySearch	The search interface for governing entry searches.
EntrySearchOrder	An interface for specifying the ordering of search results.
EntrySearchResults	This interface provides a means to capture results of a search.
EntrySearchSession	This session provides methods for searching among `Entry` objects.
EntrySmartBusinessSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Item	An `Item` is a product or service.
ItemAdminSession	This session creates, updates, and deletes `Item.`
ItemBusinessAssignmentSession	This session provides methods to re-assign `Items` to `Business` objects An `Item` may appear in multiple `Business` objects and removing the last reference to an `Item` is the equivalent of deleting it.
ItemBusinessSession	This session provides methods to retrieve `Item` to `Business` mappings.
ItemForm	This is the form for creating and updating `Items.`
ItemList	Like all `OsidLists,` `ItemList` provides a means for accessing `Item` elements sequentially either one at a time or many at a time.
ItemLookupSession	This session defines methods for retrieving items.
ItemNotificationSession	This session defines methods to receive notifications on adds/changes to `Item` objects in this `Business.`
ItemQuery	This is the query for searching items.
ItemQueryInspector	The query inspectors provide a means of accessing the match terms of a query.
ItemQuerySession	This session provides methods for searching among `Item` objects.
ItemReceiver	The item receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Item` objects.
ItemSearch	The search interface for governing item searches.
ItemSearchOrder	An interface for specifying the ordering of search results.
ItemSearchResults	This interface provides a means to capture results of a search.
ItemSearchSession	This session provides methods for searching among `Item` objects.
ItemSmartBusinessSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Period	A `Period` represents a billing period.
PeriodAdminSession	This session creates, updates, and deletes `Periods.`
PeriodBusinessAssignmentSession	This session provides methods to re-assign `Periods` to `Business` objects A `Period` may appear in multiple `Business` objects and removing the last reference to a `Period` is the equivalent of deleting it.
PeriodBusinessSession	This session provides methods to retrieve `Period` to `Business` mappings.
PeriodForm	This is the form for creating and updating `Periods.`
PeriodList	Like all `OsidLists,` `PeriodList` provides a means for accessing `Period` elements sequentially either one at a time or many at a time.
PeriodLookupSession	This session provides methods for retrieving `Period` objects.
PeriodNotificationSession	This session defines methods to receive notifications on adds/changes to `Period` objects in this `Business.`
PeriodQuery	This is the query for searching periods.
PeriodQueryInspector	The query inspectors provide a means of accessing the match terms of a query.
PeriodQuerySession	This session provides methods for searching among `Period` objects.
PeriodReceiver	The period receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Period` objects.
PeriodSearch	The search interface for governing period searches.
PeriodSearchOrder	An interface for specifying the ordering of search results.
PeriodSearchResults	This interface provides a means to capture results of a search.
PeriodSearchSession	This session provides methods for searching among `Period` objects.
PeriodSmartBusinessSession	This session manages queries and sequencing to create "smart" dynamic catalogs.

Package org.osid.billing Description

The Open Service Interface Definitions for the org.osid.billing service.

The Billing OSID manages billing for customers.

Customers

A Customer is a person known to the billing system. A Customer relates a Resource used to any business speciifc data defined in the Customer.

Customers are Temporal with effective dates indicating their association with the business.

Periods

A Period is a billing period in which billing entries applies. Periods have a set of milestone dates including start and end of the billing period.

Items

An Item is something that can be billed. Items represent a one-time or recurring charge for some product or service.

Items may relate to a Product in the Ordering OSID which manages the costs. Items may also relate to a general ledger Account in the Financials OSID.

Entries

An Entry is an OsidRelationship relating a Customer to an Item in a billing Period. An Entry captures the cost which may have been informed by the related Item.

Business Cataloging

Customers, Items, Categories, Entries, and Periods can be organized into federateble Businesses.

Orchestration

The Billing OSID can be orchestrated with an Ordering OSID to connect managed products and services to the billing system. Without the Ordering OSID, products and services may be managed directly using Items.

The Billing OSID can also be orchestrated with a Financials OSID. Customers can be associated with financial Activities that collect their costs. Items can also be associated with G/L accounts to organize different types of products and services.

The Billing OSID can also be orchestrated with the Commenting or Grading OSIDs for to indicate the Customer status and credit rating.

Sub Packages

The Billing OSID includes a Billing Payment OSID to track payments and a Billing Batch OSID to manage Entries, Items, Periods, Customers, and Businesses in bulk.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may modify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.