OSID Logo
OSID Specifications
billing payment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.Payment
Implementsosid.OsidObject
Description

A Payment.

MethodgetPayerId
Description

Gets the payer Id.

Returnosid.id.Idthe payer Id
CompliancemandatoryThis method must be implemented.
MethodgetPayer
Description

Gets the payer.

Returnosid.billing.payment.Payerthe payer
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetCustomerId
Description

Gets the customer Id for which this payment applies.

Returnosid.id.Idthe customer Id
CompliancemandatoryThis method must be implemented.
MethodgetCustomer
Description

Gets the customer for which this payment applies.

Returnosid.billing.Customerthe customer
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetPeriodId
Description

Gets the billing period Id to which this payment applies.

Returnosid.id.Idthe period Id
CompliancemandatoryThis method must be implemented.
MethodgetPeriod
Description

Gets the billing period to which this payment applied.

Returnosid.billing.Periodthe period
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetPaymentDate
Description

Gets the date the payment was made.

Returnosid.calendaring.DateTimethe payment date
CompliancemandatoryThis method must be implemented.
MethodgetProcessDate
Description

Gets the date the payment was or will be processed.

Returnosid.calendaring.DateTimethe process date
CompliancemandatoryThis method must be implemented.
MethodgetAmount
Description

Gets the amount of this payment.

Returnosid.financials.Currencythe amount
CompliancemandatoryThis method must be implemented.
MethodgetPaymentRecord
Description

Gets the payment record corresponding to the given Payment record Type. This method is used to retrieve an object implementing the requested record. The paymentRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(paymentRecordType) is true .

Parametersosid.type.TypepaymentRecordTypethe type of payment record to retrieve
Returnosid.billing.payment.records.PaymentRecordthe payment record
ErrorsNULL_ARGUMENT paymentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(paymentRecordType) is false
CompliancemandatoryThis method must be implemented.