Type Alias: PostMembershipPaymentDto

[object Object]

Defined in: api/types.gen.ts:1442

Defines the DTO for posting a membership payment, containing the necessary information for creating a new membership payment, including the member ID and an optional flag indicating whether the payment was manually marked as paid. The PostMembershipPaymentDTO is used to transfer data from the client to the server when creating a new membership payment, ensuring that all required information is provided and validated appropriately for the creation process.

Properties

manuallyMarkedAsPaid?

optional manuallyMarkedAsPaid?: boolean

Defined in: api/types.gen.ts:1450

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.

---

memberId?

optional memberId?: string

Defined in: api/types.gen.ts:1446

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.