PaymentStatusResponse
Type Alias: PaymentStatusResponse
[object Object]
Defined in: api/types.gen.ts:1170
Defines the response DTO for payment status, containing the necessary information about a member's payment status, including whether they have ever paid for membership, whether they currently have an active membership payment, whether they have paid for all activities, and a list of any unpaid enrollments. The PaymentStatusResponse is used to transfer data from the server to the client when retrieving a member's payment status, providing a comprehensive overview of their payment history and current payment status for both membership and activities within the application.
Properties
canPayMembership
[object Object]
Defined in: api/types.gen.ts:1194
A boolean value indicating whether the member is eligible to pay for membership at all, i.e. whether they are a begunstiger or have ever been enrolled in a study. Members who are neither must not be offered a membership payment.
hasEverPaidMembership
[object Object]
Defined in: api/types.gen.ts:1178
A boolean value indicating whether the member has ever paid for membership. This field provides insight into the member's payment history, allowing for the identification of members who have previously made membership payments, regardless of their current payment status. The PaymentStatusResponse includes this information to offer a comprehensive overview of the member's payment history and status within the application, enabling effective management and tracking of membership payments over time.
hasPaidAllActivities
[object Object]
Defined in: api/types.gen.ts:1186
A boolean value indicating whether the member has paid for all activities. This field provides insight into the member's payment status for activities, allowing for the identification of members who have fulfilled their payment obligations for all enrolled activities. The PaymentStatusResponse includes this information to offer a comprehensive overview of the member's payment status for activities within the application, enabling effective management and tracking of activity payments and ensuring that members are aware of any outstanding payments for their enrolled activities.
hasPaidMembershipBeforeExpirationTime
[object Object]
Defined in: api/types.gen.ts:1182
A boolean value indicating whether the member has paid for membership before its expiration time. This field provides insight into the member's payment history, allowing for the identification of members who have made timely membership payments. The PaymentStatusResponse includes this information to offer a comprehensive overview of the member's payment status for membership within the application, enabling effective management and tracking of membership payments over time.
isBegunstiger
[object Object]
Defined in: api/types.gen.ts:1190
A boolean value indicating whether the member is currently flagged as a "Begunstiger" (benefactor). When true, Backend.Controllers.DTOs.PaymentStatusResponse.HasPaidMembershipBeforeExpirationTime reflects the begunstiger fee status (paid since the last board rotation) instead of the regular membership expiration window, and payments for this member must go through the begunstiger payment endpoint rather than the membership one.
memberId
[object Object]
Defined in: api/types.gen.ts:1174
The unique identifier of the member for whom the payment status is being retrieved. This field is essential for associating the payment status information with the correct member within the system, allowing for accurate tracking and management of payment statuses based on the provided member ID in the request. The PaymentStatusResponse ensures that the payment status information is correctly linked to the specified member, providing a structured and informative response for payment status retrieval in the application.
unpaidEnrollments
[object Object]
Defined in: api/types.gen.ts:1198
A list of unpaid enrollments for the member. This field provides detailed information about any enrollments for which the member has not yet made a payment, allowing for the identification of specific activities or memberships that require attention. The PaymentStatusResponse includes this information to offer a comprehensive overview of the member's outstanding payments, enabling effective management and tracking of unpaid enrollments and ensuring that members are aware of any pending payments for their enrolled activities or memberships within the application.