1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
//! Statement types for the Payrix API.
//!
//! Statements represent billing statements for entities.
//!
//! **OpenAPI schema:** `statementsResponse`
//!
//! This type is only available when the `financial` feature is enabled.
use serde::{Deserialize, Serialize};
use super::PayrixId;
// =============================================================================
// ENUMS
// =============================================================================
/// Statement status values per OpenAPI spec.
///
/// **OpenAPI schema:** `statementStatus`
///
/// Valid values:
/// - `pending` - Statement amount is owed and is pending payment
/// - `processing` - A payment is processing for this statement
/// - `partiallyPaid` - The statement was partially paid
/// - `paid` - The statement was paid in full
/// - `partiallyCancelled` - The statement was partially cancelled
/// - `cancelled` - The statement was completely cancelled
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum StatementStatus {
/// Statement amount is owed and is pending payment.
Pending,
/// A payment is processing for this statement, pending completion.
Processing,
/// The statement was partially paid, some amount is still outstanding.
PartiallyPaid,
/// The statement was paid in full.
Paid,
/// The statement was partially cancelled, some amount is still outstanding.
PartiallyCancelled,
/// The statement was completely cancelled and is no longer due for payment.
Cancelled,
}
// =============================================================================
// STATEMENT STRUCT
// =============================================================================
/// A Payrix statement.
///
/// Statements represent billing statements for entities.
///
/// **OpenAPI schema:** `statementsResponse`
///
/// See API_INCONSISTENCIES.md for known deviations from this spec.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "sqlx", derive(sqlx::FromRow))]
#[serde(rename_all = "camelCase")]
pub struct Statement {
/// The ID of this resource.
///
/// **OpenAPI type:** string
pub id: PayrixId,
/// The date and time at which this resource was created.
///
/// Format: `YYYY-MM-DD HH:MM:SS.SSSS`
///
/// **OpenAPI type:** string (pattern: `^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$`)
#[serde(default)]
pub created: Option<String>,
/// The date and time at which this resource was modified.
///
/// Format: `YYYY-MM-DD HH:MM:SS.SSSS`
///
/// **OpenAPI type:** string (pattern: `^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$`)
#[serde(default)]
pub modified: Option<String>,
/// The identifier of the Login that created this resource.
///
/// **OpenAPI type:** string (ref: creator)
#[serde(default)]
pub creator: Option<PayrixId>,
/// The identifier of the Login that last modified this resource.
///
/// **OpenAPI type:** string
#[serde(default)]
pub modifier: Option<PayrixId>,
/// The identifier of the Billing of this statement resource.
///
/// **OpenAPI type:** string (ref: statementsModelBilling)
#[serde(default)]
pub billing: Option<PayrixId>,
/// The paying entity for which this statement applies.
///
/// **OpenAPI type:** string (ref: statementsModelEntity)
#[serde(default)]
pub entity: Option<PayrixId>,
/// The date on which this Statement period should start.
///
/// Specified as an eight digit integer in YYYYMMDD format.
///
/// **OpenAPI type:** integer (int32)
#[serde(default)]
pub start: Option<i32>,
/// The date on which this Statement period should finish.
///
/// Specified as an eight digit integer in YYYYMMDD format.
///
/// **OpenAPI type:** integer (int32)
#[serde(default)]
pub finish: Option<i32>,
/// The current status of the statement.
///
/// **OpenAPI type:** string (ref: statementStatus)
#[serde(default)]
pub status: Option<StatementStatus>,
/// The total paid amount for this statement, specified as an integer in cents.
///
/// **OpenAPI type:** integer (int64)
#[serde(default)]
pub total_paid: Option<i64>,
/// The total amount for this statement, specified as an integer in cents.
///
/// **OpenAPI type:** integer (int64)
#[serde(default)]
pub total: Option<i64>,
/// The currency for this statement.
///
/// See ISO 4217 currency codes for valid values.
///
/// **OpenAPI type:** string (ref: Currency)
#[serde(default)]
pub currency: Option<String>,
/// The payee entity of the statement.
///
/// **OpenAPI type:** string (ref: statementsModelForentity)
#[serde(default)]
pub forentity: Option<PayrixId>,
}
// =============================================================================
// TESTS
// =============================================================================
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn statement_deserialize_full() {
let json = r#"{
"id": "t1_stm_12345678901234567890123",
"created": "2024-01-01 00:00:00.0000",
"modified": "2024-01-02 23:59:59.9999",
"creator": "t1_lgn_12345678901234567890123",
"modifier": "t1_lgn_12345678901234567890124",
"billing": "t1_bil_12345678901234567890123",
"entity": "t1_ent_12345678901234567890123",
"start": 20240101,
"finish": 20240131,
"status": "pending",
"totalPaid": 0,
"total": 50000,
"currency": "USD",
"forentity": "t1_ent_12345678901234567890124"
}"#;
let statement: Statement = serde_json::from_str(json).unwrap();
assert_eq!(statement.id.as_str(), "t1_stm_12345678901234567890123");
assert_eq!(statement.start, Some(20240101));
assert_eq!(statement.finish, Some(20240131));
assert_eq!(statement.status, Some(StatementStatus::Pending));
assert_eq!(statement.total_paid, Some(0));
assert_eq!(statement.total, Some(50000));
assert_eq!(statement.currency, Some("USD".to_string()));
}
#[test]
fn statement_deserialize_minimal() {
let json = r#"{"id": "t1_stm_12345678901234567890123"}"#;
let statement: Statement = serde_json::from_str(json).unwrap();
assert_eq!(statement.id.as_str(), "t1_stm_12345678901234567890123");
assert!(statement.status.is_none());
assert!(statement.total.is_none());
}
#[test]
fn statement_status_values() {
let test_cases = vec![
("pending", StatementStatus::Pending),
("processing", StatementStatus::Processing),
("partiallyPaid", StatementStatus::PartiallyPaid),
("paid", StatementStatus::Paid),
("partiallyCancelled", StatementStatus::PartiallyCancelled),
("cancelled", StatementStatus::Cancelled),
];
for (val, expected) in test_cases {
let json = format!(
r#"{{"id": "t1_stm_12345678901234567890123", "status": "{}"}}"#,
val
);
let statement: Statement = serde_json::from_str(&json).unwrap();
assert_eq!(statement.status, Some(expected));
}
}
#[test]
fn statement_serialize_roundtrip() {
let json = r#"{
"id": "t1_stm_12345678901234567890123",
"entity": "t1_ent_12345678901234567890123",
"status": "paid",
"total": 50000
}"#;
let statement: Statement = serde_json::from_str(json).unwrap();
let serialized = serde_json::to_string(&statement).unwrap();
let deserialized: Statement = serde_json::from_str(&serialized).unwrap();
assert_eq!(statement.id, deserialized.id);
assert_eq!(statement.status, deserialized.status);
assert_eq!(statement.total, deserialized.total);
}
}