Billing Payment

The Billing Payment OSID manages billing payments.

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.

Payers may have credit cards or bank account numbers on file for recurring payments. A Payer may also use the financial Activity referenced through the related Customer.

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.

Sub Packages

The Billing Payment OSID contains a Billing Payment Batch OSID for making payments in bulk.

Package List Model

Payer

Osid Object

A Payer represents the payer of the bills. A Payer links a payment type to a paying contact Resource.

Inherited elements

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

Name	Syntax	Many	Description
`resourceId`	id		the resource `Id`
`resource`	Resource		the resource
`hasCustomer`	boolean		`true` if this payer is linked to a customer, `false` otherwise
`customerId`	id		the customer `Id`
`customer`	Customer		the customer
`usesActivity`	boolean		`true` if this payer uses the customer activity, `false` otherwise
`usesCash`	boolean		`true` if this payer uses the cash, `false` otherwise
`hasCreditCard`	boolean		`true` if this payer pays by credit card, `false` otherwise
`creditCardNumber`	string		the credit card number
`creditCardExpiration`	datetime		the expiration date
`creditCardCode`	string		the credit card security code
`hasBankAccount`	boolean		`true` if this payer pays by bank account, `false` otherwise
`bankRoutingNumber`	string		the bank routing number number
`bankAccountNumber`	string		the bank account number

Payment

Osid Object

A Payment.

Inherited elements

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
`payerId`	id		the payer `Id`
`payer`	Payer		the payer
`customerId`	id		the customer `Id`
`customer`	Customer		the customer
`periodId`	id		the period `Id`
`period`	Period		the period
`paymentDate`	datetime		the payment date
`processDate`	datetime		the process date
`amount`	Currency		the amount

Summary

Osid Compendium

A Payment.

Inherited elements

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
OsidCompendium
`startDate`	datetime		the date
`endDate`	datetime		the date
`isInterpolated`	boolean		`true` if this report is interpolated, `false` otherwise
`isExtrapolated`	boolean		`true` if this report is extrapolated, `false` otherwise

Name	Syntax	Many	Description
`customerId`	id		the customer `Id`
`customer`	Customer		the customer
`periodId`	id		the period `Id`
`period`	Period		the period
`isCreditBalance`	boolean		`true` if a credit, `false` if a debit
`balance`	Currency		the balance
`hasLastPayment`	boolean		`true` if there is a last payment, `false` otehrwise
`lastPaymentDate`	datetime		the last payment date
`lastPayment`	Currency		the payment
`paymentDueDate`	datetime		the payment due date