EnrollmentPayment
Type Alias: EnrollmentPayment
[object Object]
Defined in: app/api/types.gen.ts:240
Represents a payment made for an enrollment. This class inherits from the Payment base class and includes additional properties specific to enrollment payments, such as the associated activity. This entity is used to specifically represent payments that are made for enrollments within the system, allowing for better organization and management of different types of payments while still utilizing the common properties defined in the Payment base class. The ActivityId property is a foreign key referencing the Activity entity, and the Activity navigation property allows access to the related Activity entity, providing context for the enrollment payment and enabling better tracking and reporting of payments related to specific activities.
Properties
accountingToolEntryId?
optionalaccountingToolEntryId?:string|null
Defined in: app/api/types.gen.ts:269
The identifier of the corresponding entry in the accounting tool, if applicable. This is used to correlate the payment record in our system with the corresponding financial record in the accounting tool. This property is nullable because not all payments may have a corresponding entry in the accounting tool, especially if they are manually marked as paid or if there are issues with the payment processing that prevent it from being recorded in the accounting tool. In such cases, the AccountingToolEntryId would be set to null to indicate that there is no corresponding entry for this payment in the accounting tool.
activity?
optionalactivity?:Activity
Defined in: app/api/types.gen.ts:278
activityId?
optionalactivityId?:number|null
Defined in: app/api/types.gen.ts:277
The identifier of the activity associated with this enrollment payment. This is a foreign key referencing the Activity entity. This property is nullable because in some cases, an enrollment payment may not be directly associated with a specific activity, such as when a payment is made for a general enrollment or when the activity information is not available at the time of payment. In such cases, the ActivityId would be set to null to indicate that there is no specific activity associated with this enrollment payment.
id?
optionalid?:number
Defined in: app/api/types.gen.ts:244
The unique identifier of the payment, assigned incrementally.
manuallyMarkedAsPaid?
optionalmanuallyMarkedAsPaid?:boolean
Defined in: app/api/types.gen.ts:273
Indicates whether the payment was manually marked as paid by an administrator. This is used to differentiate between payments that were processed through the normal payment flow and those that were manually marked as paid, which may require different handling in terms of accounting and reporting. This property is set to false by default, and can be set to true by an administrator when they manually mark a payment as paid, allowing for better tracking and management of payments that may not have gone through the standard payment processing flow.
member?
optionalmember?:Member
Defined in: app/api/types.gen.ts:265
memberId?
optionalmemberId?:string|null
Defined in: app/api/types.gen.ts:264
The identifier of the member who made the payment. This is a foreign key referencing the Member entity. This property is nullable because even if the member is removed from the database, we may want to keep the payment record for historical and auditing purposes. In such cases, the MemberId would be set to null to indicate that the member associated with the payment has been deleted, while still retaining the payment information for reference.
mollieId
[object Object]
Defined in: app/api/types.gen.ts:252
The identifier provided by Mollie for this payment. This is used to track the payment in the Mollie system and to correlate it with the corresponding payment record in our system. This property is required for all payments, as it is essential for processing and verifying payments through the Mollie payment gateway.
paidAt?
optionalpaidAt?:string|null
Defined in: app/api/types.gen.ts:260
The timestamp indicating when the payment was paid. This is used to track when the payment was completed and can be useful for financial reporting, auditing, and determining the status of the payment. This property is nullable because a payment may be created before it is completed, and in such cases, the PaidAt timestamp would not be set until the payment is successfully processed.
paymentIntentUrl
[object Object]
Defined in: app/api/types.gen.ts:256
The URL provided by Mollie for the payment intent. This URL is used to redirect the member to the Mollie payment page where they can complete the payment process. This property is required for all payments, as it is essential for facilitating the payment process through the Mollie payment gateway and ensuring that members can easily access the payment page to complete their transactions.
price?
optionalprice?:number
Defined in: app/api/types.gen.ts:248
The price of the payment.