square_api_client/models/enums/invoice_payment_reminder_status.rs
1//! Model for InvoicePaymentReminderStatus enum.
2
3use serde::{Deserialize, Serialize};
4
5/// The status of a payment request reminder.
6#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
7#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
8pub enum InvoicePaymentReminderStatus {
9 /// The reminder will be sent on the `relative_scheduled_date` (if the invoice is published).
10 Pending,
11 /// The reminder is not applicable and is not sent. The following are examples of when reminders
12 /// are not applicable and are not sent:
13 ///
14 /// - You schedule a reminder to be sent before the invoice is published.
15 /// - The invoice is configured with multiple payment requests and a payment request reminder is
16 /// configured to be sent after the next payment request `due_date`.
17 /// - Two reminders (for different payment requests) are configured to be sent on the same date.
18 /// Therefore, only one reminder is sent.
19 /// - You configure a reminder to be sent on the date that the invoice is scheduled to be sent.
20 /// - The payment request is already paid.
21 /// - The invoice status is `CANCELED` or `FAILED`.
22 NotApplicable,
23 /// The reminder is sent.
24 Sent,
25}