Payment :: Refund Payment Allocation

Term URI: http://cloudinformationmodel.org/model/RefundPaymentAllocation

Description: Facilitates applying/unapplying refund balance to a payment.

Related entities

Scalar Properties

Name Details
allocatedAmount
  • Term URI: http://cloudinformationmodel.org/model/allocatedAmount
  • Range: integer
  • Description: The portion, in currency, of the Payment or Credit Memo that has been allocated to a Refund. This amount is used for both applying and un-applying amounts to a Refund Payment.
  • mandatory: true
appliedDate
  • Term URI: http://cloudinformationmodel.org/model/appliedDate
  • Range: date
  • Description: The date recorded in the system for the allocation of the funding source to the Refund Payment. This could differ from the effective date for the allocation.
  • mandatory: true
creditMemoBalanceAmount
  • Term URI: http://cloudinformationmodel.org/model/creditMemoBalanceAmount
  • Range: integer
  • Description: The unapplied portion of the Credit Memo that remains after application to this Refund Payment.
  • mandatory: true
effectiveDate
  • Term URI: http://cloudinformationmodel.org/model/effectiveDate
  • Range: date
  • Description: The date when the allocation is effective on the payment and available to the customer.
  • mandatory: true
externalCreatedDate
  • Term URI: http://cloudinformationmodel.org/model/externalCreatedDate
  • Range: date
  • Description: In cases where older data is migrated into a platform that defaults the standard CreatedDate with the system date, this field preserves the original created date value.
  • mandatory: true
hasBeenUnapplied
  • Term URI: http://cloudinformationmodel.org/model/hasBeenUnapplied
  • Range: boolean
  • Description: True if the application of a Capture Payment or Credit Memo to a Refund Payment has been reversed.
id
  • Term URI: http://cloudinformationmodel.org/model/id
  • Range: guid
  • Description: Primary Key
  • mandatory: true
paymentBalanceAmount
  • Term URI: http://cloudinformationmodel.org/model/paymentBalanceAmount
  • Range: integer
  • Description: The unapplied portion of the PaymentAmount that remains after application to this Refund Payment.
  • mandatory: true
refundAllocationCommentText
  • Term URI: http://cloudinformationmodel.org/model/refundAllocationCommentText
  • Range: string
  • Description: Description of the Refund Payment Allocation
refundAllocationCommentsDate
  • Term URI: http://cloudinformationmodel.org/model/refundAllocationCommentsDate
  • Range: date
  • Description: Date upon which the allocation to the refund payment is effective.
  • mandatory: true
refundAllocationName
  • Term URI: http://cloudinformationmodel.org/model/refundAllocationName
  • Range: string
  • Description: Short description of the Refund Allocation
refundAllocationType
  • Term URI: http://cloudinformationmodel.org/model/refundAllocationType
  • Range: string
  • Description: Identifies the Refund Allocation as either a Refund Payment Allocation or a Refund Credit Memo Allocation
  • mandatory: true
refundBalanceAmount
  • Term URI: http://cloudinformationmodel.org/model/refundBalanceAmount
  • Range: integer
  • Description: The unallocated portion of the overall Refund Payment Amount that exists after application to this Capture Payment or Credit Memo. This could be non-zero if a refund amount was determined before a decision to obtain the funding from either a capture payme
  • mandatory: true
refundPaymentAllocationName
  • Term URI: http://cloudinformationmodel.org/model/refundPaymentAllocationName
  • Range: string
  • Description: Short description of the Refund Payment Allocation
unappliedDate
  • Term URI: http://cloudinformationmodel.org/model/unappliedDate
  • Range: date
  • Description: The date when the allocation of the capture payment or credit memo to the refund payment was unapplied.
  • mandatory: true

Link Properties

Name Details