wflow-api 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,514 @@
1
+ """Generated from the wflow OpenAPI spec.
2
+
3
+ Regenerate with:
4
+
5
+ uv run scripts/wflow_spec.py --models Document DocumentBase DocumentTypeFull DocumentEvent DocumentFile Comment Property PropertyDefinition ApprovalProcess
6
+
7
+ then review the diff. That command's dependency closure emits 31 classes, not the 21
8
+ below: the other 10 are schemas this codebase already models elsewhere, so delete them
9
+ from the regenerated output and import them instead of duplicating them —
10
+
11
+ - from wflow_api.models.account: DocumentTypeBase, Identity, TeamBase
12
+ - from wflow_api.models.registers: AddressType, KindRegister, Location, PaymentMethods,
13
+ Register, Serie, VATReturnLine
14
+
15
+ Also delete `Property._value` from the regenerated output: the spec marks it
16
+ `writeOnly: true`, so wflow never sends it back and there is nothing here to read."""
17
+
18
+ from typing import Any
19
+
20
+ from pydantic import Field
21
+
22
+ from wflow_api.models.account import DocumentTypeBase, Identity, TeamBase
23
+ from wflow_api.models.common import WflowModel, WflowTimestamp
24
+ from wflow_api.models.registers import (
25
+ AddressType,
26
+ KindRegister,
27
+ Location,
28
+ PaymentMethods,
29
+ Register,
30
+ Serie,
31
+ VATReturnLine,
32
+ )
33
+
34
+
35
+ class DocumentPayment(WflowModel):
36
+ paidAmount: float | None = Field(default=None, description="Paid amount (decimal (18,2))")
37
+ paidDate: WflowTimestamp | None = Field(default=None, description="Paid date (yyyy-mm-ddThh:mm:ss.ffffff)")
38
+ paymentStatus: str | None = Field(default=None, description="One of: NotPaid, PartiallyPaid, Paid, OverPaid")
39
+ paymentOrderAmount: float | None = Field(default=None, description="Payment order amount (decimal (18,2))")
40
+ paymentOrderStatus: str | None = Field(default=None, description="One of: Requested, Created")
41
+ activePaymentRequestDate: WflowTimestamp | None = Field(
42
+ default=None, description="Active payment request date (yyyy-mm-ddThh:mm:ss.ffffff)"
43
+ )
44
+
45
+
46
+ class DocumentBase(WflowModel):
47
+ id: str | None = Field(default=None, description="Id")
48
+ serie: Serie | None = None
49
+ number: str | None = Field(default=None, description="Number")
50
+ internalCode: str | None = Field(default=None, description="Internal code")
51
+ vatDocumentCode: str | None = Field(default=None, description="VAT code")
52
+ variableSymbol: str | None = Field(default=None, description="Variable symbol")
53
+ constantSymbol: str | None = Field(default=None, description="Constant symbol")
54
+ specificSymbol: str | None = Field(default=None, description="Specific symbol")
55
+ issueDate: WflowTimestamp | None = Field(default=None, description="Issue date (yyyy-mm-ddThh:mm:ss.ffffff)")
56
+ dueDate: WflowTimestamp | None = Field(default=None, description="Due date (yyyy-mm-ddThh:mm:ss.ffffff)")
57
+ vatDate: WflowTimestamp | None = Field(default=None, description="VAT date (yyyy-mm-ddThh:mm:ss.ffffff)")
58
+ acceptDate: WflowTimestamp | None = Field(default=None, description="Accept date (yyyy-mm-ddThh:mm:ss.ffffff)")
59
+ caseDate: WflowTimestamp | None = Field(default=None, description="Case date (yyyy-mm-ddThh:mm:ss.ffffff)")
60
+ validFrom: WflowTimestamp | None = Field(default=None, description="Valid from (yyyy-mm-ddThh:mm:ss.ffffff)")
61
+ validTo: WflowTimestamp | None = Field(
62
+ default=None, description="Valid to (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
63
+ )
64
+ effectiveFrom: WflowTimestamp | None = Field(
65
+ default=None, description="Effective from (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
66
+ )
67
+ effectiveTo: WflowTimestamp | None = Field(
68
+ default=None, description="Effective to (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
69
+ )
70
+ signatureDate: WflowTimestamp | None = Field(
71
+ default=None, description="Signature date (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
72
+ )
73
+ reviewDate: WflowTimestamp | None = Field(
74
+ default=None, description="Review date (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
75
+ )
76
+ accountTerm: str | None = Field(default=None, description="Accounting period (yyyy/mm)")
77
+ vatTerm: str | None = Field(default=None, description="VAT period (yyyy/mm)")
78
+ taxExclusiveAmount: float | None = Field(default=None, description="Tax exclusive amount")
79
+ totalAmount: float | None = Field(default=None, description="Total amount (decimal (18,2))")
80
+ roundingAmount: float | None = Field(default=None, description="Rounding ammount (decimal (3,2))")
81
+ totalAmountFC: float | None = Field(default=None, description="Total amonut in foriegn currency (decimal (18,2))")
82
+ advanceAmount: float | None = Field(default=None, description="Advance amount (decimal (18,2))")
83
+ currency: str | None = Field(default=None, description="Currency ISO code (fixed length 3 chars)")
84
+ partnerIC: str | None = Field(default=None, description="Partner ID")
85
+ partnerVAT: str | None = Field(default=None, description="Partner VAT ID")
86
+ partnerLocalVAT: str | None = Field(default=None, description="Partner local VAT ID")
87
+ partnerName: str | None = Field(default=None, description="Partner name")
88
+ partnerAddress: str | None = Field(
89
+ default=None, description="Partner address (street, post code, town, country,...)"
90
+ )
91
+ partnerMainAddress: AddressType | None = None
92
+ partnerEmail: str | None = Field(default=None, description="Partner e-mail address")
93
+ accountNo: str | None = Field(default=None, description="Partner bank account No")
94
+ bankCode: str | None = Field(default=None, description="Partner bank code")
95
+ iban: str | None = Field(default=None, description="Partner IBAN")
96
+ bic: str | None = Field(default=None, description="Partner BIC code (SWIFT)")
97
+ meIC: str | None = Field(default=None, description="Recipient's ID")
98
+ meVAT: str | None = Field(default=None, description="Recipient's VAT")
99
+ myBankAccountNo: str | None = Field(
100
+ default=None, description="Recipient's bank account number (snapshot taken at document creation)"
101
+ )
102
+ myBankCode: str | None = Field(
103
+ default=None, description="Recipient's bank code (snapshot taken at document creation)"
104
+ )
105
+ myIBAN: str | None = Field(default=None, description="Recipient's IBAN (snapshot taken at document creation)")
106
+ myBIC: str | None = Field(default=None, description="Recipient's BIC/SWIFT (snapshot taken at document creation)")
107
+ myBankCurrency: str | None = Field(
108
+ default=None, description="Recipient's bank account currency (snapshot taken at document creation)"
109
+ )
110
+ exchangeRate: float | None = Field(default=None, description="Exchange rate")
111
+ exchangeRateUnits: int | None = Field(default=None, description="Exchange rate units")
112
+ tag: str | None = Field(default=None, description="Special document identification")
113
+ orderNo: str | None = Field(default=None, description="Linked order number")
114
+ description: str | None = Field(default=None, description="Document description")
115
+ contactPersonName: str | None = Field(default=None, description="Contact person name")
116
+ contactPersonEmail: str | None = Field(default=None, description="Contact person email")
117
+ remainsToDeliverAmount: float | None = Field(default=None, description="Remains to deliver amount.")
118
+ invoiceType: str | None = Field(
119
+ default=None, description="One of: TaxInvoice, CreditNote, DebitNote, Proforma, TaxInvoicePayment"
120
+ )
121
+ expectedDeliveryDate: WflowTimestamp | None = Field(
122
+ default=None, description="Expected delivery date - for orders only (yyyy-mm-ddThh:mm:ss.ffffff)"
123
+ )
124
+ accountCode: str | None = Field(default=None, description="Accounting account code")
125
+ doNotPay: bool | None = Field(default=None, description="Do not pay")
126
+ created: WflowTimestamp | None = Field(default=None, description="Creation date (yyyy-mm-ddThh:mm:ss.ffffff)")
127
+ updated: WflowTimestamp | None = Field(default=None, description="Last update date (yyyy-mm-ddThh:mm:ss.ffffff)")
128
+ lastAction: WflowTimestamp | None = Field(default=None, description="Last action date (yyyy-mm-ddThh:mm:ss.ffffff)")
129
+ removed: WflowTimestamp | None = Field(default=None, description="Remove date (yyyy-mm-ddThh:mm:ss.ffffff)")
130
+ locked: bool | None = Field(default=None, description="Locked attribute")
131
+ approvalStatus: str | None = Field(
132
+ default=None, description="One of: NotApproved, Approved, Rejected, Returned, None"
133
+ )
134
+ flowStatus: str | None = Field(
135
+ default=None,
136
+ description="One of: New, SendToExtractionWaiting, SendToExtractionError, SendToExtractionOK, Filled, Extracted, SentToReview, Reviewed, Sent, SendToERPWaiting, SendToERPError, SentToERP, PartlyDelivered, Delivered, NotConfirmed",
137
+ )
138
+ payment: DocumentPayment | None = None
139
+ dataSource: str | None = Field(default=None, description="One of: ISDOC, ROSSUM, EKASA, API, WFLOWAI, ZUGFERD, UBL")
140
+ source: str | None = Field(default=None, description="One of: Email, Api, MobileApp, WebApp, Rossum, Peppol")
141
+ createdBy: str | None = Field(default=None, description="Name or login of user, who created the document")
142
+ series: str | None = Field(default=None, description="Serie code - Deprecated")
143
+ type: DocumentTypeBase | None = None
144
+ tags: list[str] | None = Field(default=None, description="Array of tags added to the document")
145
+
146
+
147
+ class SequenceBase(WflowModel):
148
+ id: str | None = None
149
+ entity: str | None = None
150
+ description: str | None = None
151
+ fixedPart: str | None = None
152
+ counter: str | None = None
153
+
154
+
155
+ class DocumentType(WflowModel):
156
+ """Document type"""
157
+
158
+ id: str | None = Field(default=None, description="Id")
159
+ name: str | None = Field(default=None, description="Name")
160
+ kind: str | None = Field(
161
+ default=None,
162
+ description="One of: IncomingInvoice, OutgoingInvoice, ExpenditureCashSlip, SupplierOrder, CustomerOrder, Other, Contract, IncomeCashReceipt",
163
+ )
164
+ default: bool | None = Field(default=None, description="Use as default attribute")
165
+ erpExclude: bool | None = Field(default=None, description="Exclude from sending to ERP attribute")
166
+ filesExtendName: bool | None = Field(default=None, description="Uploaded files from e-mail name extension")
167
+ docCreatingMethod: str | None = Field(default=None, description="One of: Upload, Manually")
168
+ autoStamp: str | None = Field(default=None, description="One of: None, New, Approved")
169
+ serie: Serie | None = None
170
+ sequence: SequenceBase | None = None
171
+ invoiceType: str | None = Field(
172
+ default=None, description="One of: TaxInvoice, CreditNote, DebitNote, Proforma, TaxInvoicePayment"
173
+ )
174
+
175
+
176
+ class Partner(WflowModel):
177
+ """Partner"""
178
+
179
+ id: str | None = Field(default=None, description="Id")
180
+ externalId: str | None = Field(default=None, description="External Id")
181
+ ic: str | None = Field(default=None, description="Tax ID. (max 10 characters)")
182
+ vat: str | None = Field(default=None, description="VAT ID. (max 15 characters)")
183
+ name: str | None = Field(default=None, description="Name")
184
+ address: str | None = Field(default=None, description="Address (street, post code, town, country,...)")
185
+ mainAddress: AddressType | None = None
186
+ localVAT: str | None = Field(default=None, description="Local VAT ID")
187
+ note: str | None = Field(default=None, description="Notes")
188
+ phoneNo: str | None = Field(default=None, description="Phone No")
189
+ mailAddress: str | None = Field(default=None, description="E-mail address")
190
+ deliveryPeriod: int | None = Field(default=None, description="Standard delivery period in days")
191
+ minOrderTotal: float | None = Field(default=None, description="Minimal order amount (decimal (18,2))")
192
+ toleranceRate: int | None = Field(default=None, description="Automatic pairing tolerance threshold by total amount")
193
+ language: str | None = Field(
194
+ default=None, description="Primary language. ISO 639-1:2002 language code (2 characters)"
195
+ )
196
+ isValid: bool | None = Field(default=None, description="Validity attribute")
197
+ businessRegisterRegistration: str | None = Field(default=None, description="Business register registration text")
198
+ customer: bool | None = Field(default=None, description="Customer attribute")
199
+ supplier: bool | None = Field(default=None, description="Supplier attribute")
200
+
201
+
202
+ class Accounting(WflowModel):
203
+ """Accounting"""
204
+
205
+ businessItemCode: str | None = Field(default=None, description="Business item code")
206
+ accountingRule: KindRegister | None = None
207
+ activity: Register | None = None
208
+ businessCase: Register | None = None
209
+ cardDocumentType: Register | None = None
210
+ cashDocumentType: Register | None = None
211
+ cashRegister: Register | None = None
212
+ contraAccount: Register | None = None
213
+ contract: Register | None = None
214
+ costCenter: Register | None = None
215
+ employee: Register | None = None
216
+ paymentMethod: PaymentMethods | None = None
217
+ project: Register | None = None
218
+ vatControlStatementLine: Register | None = None
219
+ vatReturnLine: VATReturnLine | None = None
220
+ vatReverseChargeCode: Register | None = None
221
+ vehicle: Register | None = None
222
+ vatSupplyModeCode: str | None = Field(default=None, description="One of: Normal, TravelService, UsedGoods")
223
+ vatApplyReductionCoefficient: bool | None = Field(
224
+ default=None, description="VAT apply reduction coefficient indicator"
225
+ )
226
+ vatFixedAssets: bool | None = Field(default=None, description="VAT fixed assets indicator")
227
+ vatMode: str | None = Field(
228
+ default=None, description="One of: Standard, ReverseChargeDomestic, ReverseCharge, Excluded, InForeignCurrency"
229
+ )
230
+
231
+
232
+ class DocumentVAT(WflowModel):
233
+ """Document VAT"""
234
+
235
+ rate: float | None = Field(default=None, description="VAT percent rate (decimal (4,2))")
236
+ type: str | None = Field(default=None, description="One of: Exempt, FirstReduced, SecondReduced, Basic")
237
+ base: float | None = Field(default=None, description="VAT base amount (decimal (18,2))")
238
+ tax: float | None = Field(default=None, description="VAT tax amount (decimal (18,2))")
239
+
240
+
241
+ class IdentityBase(WflowModel):
242
+ """Identity base"""
243
+
244
+ login: str | None = Field(default=None, description="Login name.")
245
+ firstName: str | None = Field(default=None, description="First name.")
246
+ lastName: str | None = Field(default=None, description="Last name.")
247
+ fullName: str | None = Field(default=None, description="Full name.")
248
+
249
+
250
+ class ApprovalProcessItem(WflowModel):
251
+ """Approval process item"""
252
+
253
+ level: int | None = Field(default=None, description="Level in approval process")
254
+ team: TeamBase | None = None
255
+ identity: IdentityBase | None = None
256
+ date: WflowTimestamp | None = Field(default=None, description="Date of aproval result")
257
+ status: str | None = Field(default=None, description="One of: NotApproved, Approved, Rejected, Returned, None")
258
+
259
+
260
+ class DocumentLine(WflowModel):
261
+ """Document line"""
262
+
263
+ id: str | None = Field(default=None, description="Total amount (decimal (18,2))")
264
+ totalAmount: float | None = Field(default=None, description="Total amount (decimal (18,2))")
265
+ totalAmountFC: float | None = Field(default=None, description="Total amonut in foriegn currency (decimal (18,2))")
266
+ accountCode: str | None = Field(default=None, description="Accounting account code")
267
+ currency: str | None = Field(default=None, description="Currency ISO code (fixed length 3 chars)")
268
+ description: str | None = Field(default=None, description="Item description")
269
+ quantity: float | None = Field(default=None, description="Quantity (decimal (14,6))")
270
+ unitPrice: float | None = Field(default=None, description="Unit price (decimal (14,6))")
271
+ measureUnit: str | None = Field(default=None, description="Measure unit")
272
+ vatType: str | None = Field(default=None, description="One of: Exempt, FirstReduced, SecondReduced, Basic")
273
+ vatRate: float | None = Field(default=None, description="VAT percent rate (decimal (4,2))")
274
+ order: int | None = Field(default=None, description="Item order index in list")
275
+ approval: ApprovalProcessItem | None = None
276
+ changedAfterApprove: bool | None = Field(default=None, description="Changed after approve")
277
+ accounting: Accounting | None = None
278
+ code: str | None = Field(default=None, description="Item code (read only)")
279
+ costCenter: Register | None = None
280
+ contract: Register | None = None
281
+ activity: Register | None = None
282
+
283
+
284
+ class Document(WflowModel):
285
+ """Document"""
286
+
287
+ id: str | None = Field(default=None, description="Id")
288
+ serie: Serie | None = None
289
+ number: str | None = Field(default=None, description="Number")
290
+ internalCode: str | None = Field(default=None, description="Internal code")
291
+ vatDocumentCode: str | None = Field(default=None, description="VAT code")
292
+ variableSymbol: str | None = Field(default=None, description="Variable symbol")
293
+ constantSymbol: str | None = Field(default=None, description="Constant symbol")
294
+ specificSymbol: str | None = Field(default=None, description="Specific symbol")
295
+ issueDate: WflowTimestamp | None = Field(default=None, description="Issue date (yyyy-mm-ddThh:mm:ss.ffffff)")
296
+ dueDate: WflowTimestamp | None = Field(default=None, description="Due date (yyyy-mm-ddThh:mm:ss.ffffff)")
297
+ vatDate: WflowTimestamp | None = Field(default=None, description="VAT date (yyyy-mm-ddThh:mm:ss.ffffff)")
298
+ acceptDate: WflowTimestamp | None = Field(default=None, description="Accept date (yyyy-mm-ddThh:mm:ss.ffffff)")
299
+ caseDate: WflowTimestamp | None = Field(default=None, description="Case date (yyyy-mm-ddThh:mm:ss.ffffff)")
300
+ validFrom: WflowTimestamp | None = Field(default=None, description="Valid from (yyyy-mm-ddThh:mm:ss.ffffff)")
301
+ validTo: WflowTimestamp | None = Field(
302
+ default=None, description="Valid to (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
303
+ )
304
+ effectiveFrom: WflowTimestamp | None = Field(
305
+ default=None, description="Effective from (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
306
+ )
307
+ effectiveTo: WflowTimestamp | None = Field(
308
+ default=None, description="Effective to (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
309
+ )
310
+ signatureDate: WflowTimestamp | None = Field(
311
+ default=None, description="Signature date (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
312
+ )
313
+ reviewDate: WflowTimestamp | None = Field(
314
+ default=None, description="Review date (Contract kind) (yyyy-mm-ddThh:mm:ss.ffffff)"
315
+ )
316
+ accountTerm: str | None = Field(default=None, description="Accounting period (yyyy/mm)")
317
+ vatTerm: str | None = Field(default=None, description="VAT period (yyyy/mm)")
318
+ taxExclusiveAmount: float | None = Field(default=None, description="Tax exclusive amount")
319
+ totalAmount: float | None = Field(default=None, description="Total amount (decimal (18,2))")
320
+ roundingAmount: float | None = Field(default=None, description="Rounding ammount (decimal (3,2))")
321
+ totalAmountFC: float | None = Field(default=None, description="Total amonut in foriegn currency (decimal (18,2))")
322
+ advanceAmount: float | None = Field(default=None, description="Advance amount (decimal (18,2))")
323
+ currency: str | None = Field(default=None, description="Currency ISO code (fixed length 3 chars)")
324
+ partnerIC: str | None = Field(default=None, description="Partner ID")
325
+ partnerVAT: str | None = Field(default=None, description="Partner VAT ID")
326
+ partnerLocalVAT: str | None = Field(default=None, description="Partner local VAT ID")
327
+ partnerName: str | None = Field(default=None, description="Partner name")
328
+ partnerAddress: str | None = Field(
329
+ default=None, description="Partner address (street, post code, town, country,...)"
330
+ )
331
+ partnerMainAddress: AddressType | None = None
332
+ partnerEmail: str | None = Field(default=None, description="Partner e-mail address")
333
+ accountNo: str | None = Field(default=None, description="Partner bank account No")
334
+ bankCode: str | None = Field(default=None, description="Partner bank code")
335
+ iban: str | None = Field(default=None, description="Partner IBAN")
336
+ bic: str | None = Field(default=None, description="Partner BIC code (SWIFT)")
337
+ meIC: str | None = Field(default=None, description="Recipient's ID")
338
+ meVAT: str | None = Field(default=None, description="Recipient's VAT")
339
+ myBankAccountNo: str | None = Field(
340
+ default=None, description="Recipient's bank account number (snapshot taken at document creation)"
341
+ )
342
+ myBankCode: str | None = Field(
343
+ default=None, description="Recipient's bank code (snapshot taken at document creation)"
344
+ )
345
+ myIBAN: str | None = Field(default=None, description="Recipient's IBAN (snapshot taken at document creation)")
346
+ myBIC: str | None = Field(default=None, description="Recipient's BIC/SWIFT (snapshot taken at document creation)")
347
+ myBankCurrency: str | None = Field(
348
+ default=None, description="Recipient's bank account currency (snapshot taken at document creation)"
349
+ )
350
+ exchangeRate: float | None = Field(default=None, description="Exchange rate")
351
+ exchangeRateUnits: int | None = Field(default=None, description="Exchange rate units")
352
+ tag: str | None = Field(default=None, description="Special document identification")
353
+ orderNo: str | None = Field(default=None, description="Linked order number")
354
+ description: str | None = Field(default=None, description="Document description")
355
+ contactPersonName: str | None = Field(default=None, description="Contact person name")
356
+ contactPersonEmail: str | None = Field(default=None, description="Contact person email")
357
+ remainsToDeliverAmount: float | None = Field(default=None, description="Remains to deliver amount.")
358
+ invoiceType: str | None = Field(
359
+ default=None, description="One of: TaxInvoice, CreditNote, DebitNote, Proforma, TaxInvoicePayment"
360
+ )
361
+ expectedDeliveryDate: WflowTimestamp | None = Field(
362
+ default=None, description="Expected delivery date - for orders only (yyyy-mm-ddThh:mm:ss.ffffff)"
363
+ )
364
+ accountCode: str | None = Field(default=None, description="Accounting account code")
365
+ doNotPay: bool | None = Field(default=None, description="Do not pay")
366
+ created: WflowTimestamp | None = Field(default=None, description="Creation date (yyyy-mm-ddThh:mm:ss.ffffff)")
367
+ updated: WflowTimestamp | None = Field(default=None, description="Last update date (yyyy-mm-ddThh:mm:ss.ffffff)")
368
+ lastAction: WflowTimestamp | None = Field(default=None, description="Last action date (yyyy-mm-ddThh:mm:ss.ffffff)")
369
+ removed: WflowTimestamp | None = Field(default=None, description="Remove date (yyyy-mm-ddThh:mm:ss.ffffff)")
370
+ locked: bool | None = Field(default=None, description="Locked attribute")
371
+ approvalStatus: str | None = Field(
372
+ default=None, description="One of: NotApproved, Approved, Rejected, Returned, None"
373
+ )
374
+ flowStatus: str | None = Field(
375
+ default=None,
376
+ description="One of: New, SendToExtractionWaiting, SendToExtractionError, SendToExtractionOK, Filled, Extracted, SentToReview, Reviewed, Sent, SendToERPWaiting, SendToERPError, SentToERP, PartlyDelivered, Delivered, NotConfirmed",
377
+ )
378
+ payment: DocumentPayment | None = None
379
+ dataSource: str | None = Field(default=None, description="One of: ISDOC, ROSSUM, EKASA, API, WFLOWAI, ZUGFERD, UBL")
380
+ source: str | None = Field(default=None, description="One of: Email, Api, MobileApp, WebApp, Rossum, Peppol")
381
+ createdBy: str | None = Field(default=None, description="Name or login of user, who created the document")
382
+ series: str | None = Field(default=None, description="Serie code - Deprecated")
383
+ type: DocumentType | None = None
384
+ partner: Partner | None = None
385
+ deliveryLocation: Location | None = None
386
+ accounting: Accounting | None = None
387
+ vaTs: list[DocumentVAT] | None = Field(default=None, description="VAT subtotals")
388
+ lines: list[DocumentLine] | None = Field(default=None, description="Lines list")
389
+ transactionId: str | None = Field(default=None, description="Transaction id")
390
+ expenseCardId: str | None = Field(default=None, description="Card id")
391
+ peppolMessageId: str | None = Field(
392
+ default=None, description="Peppol message Id (PeppolIncomingEvent or PeppolOutgoingEvent Id)"
393
+ )
394
+
395
+
396
+ class UserBase(WflowModel):
397
+ """User base"""
398
+
399
+ id: str | None = Field(default=None, description="Id")
400
+ identity: Identity | None = None
401
+
402
+
403
+ class UserPermission(WflowModel):
404
+ user: UserBase | None = None
405
+ permission: str | None = Field(default=None, description="One of: All, OnlyAssigned, FullAccess")
406
+
407
+
408
+ class DocumentTypeFull(WflowModel):
409
+ """Document type full"""
410
+
411
+ id: str | None = Field(default=None, description="Id")
412
+ name: str | None = Field(default=None, description="Name")
413
+ kind: str | None = Field(
414
+ default=None,
415
+ description="One of: IncomingInvoice, OutgoingInvoice, ExpenditureCashSlip, SupplierOrder, CustomerOrder, Other, Contract, IncomeCashReceipt",
416
+ )
417
+ default: bool | None = Field(default=None, description="Use as default attribute")
418
+ erpExclude: bool | None = Field(default=None, description="Exclude from sending to ERP attribute")
419
+ filesExtendName: bool | None = Field(default=None, description="Uploaded files from e-mail name extension")
420
+ docCreatingMethod: str | None = Field(default=None, description="One of: Upload, Manually")
421
+ autoStamp: str | None = Field(default=None, description="One of: None, New, Approved")
422
+ serie: Serie | None = None
423
+ sequence: SequenceBase | None = None
424
+ invoiceType: str | None = Field(
425
+ default=None, description="One of: TaxInvoice, CreditNote, DebitNote, Proforma, TaxInvoicePayment"
426
+ )
427
+ users: list[UserPermission] | None = Field(default=None, description="Retrieves")
428
+
429
+
430
+ class DocumentEvent(WflowModel):
431
+ id: str | None = None
432
+ type: str | None = Field(
433
+ default=None,
434
+ description="One of: Create, Update, Delete, Restore, Approved, Unapproved, Locked, Unlocked, Rejected, Returned, FileAdded, FileDeleted, TaskAdded, TaskProcessed, SetDocumentRights, SetDocumentApprovals, DeleteDocumentApprovals, AddDocumentPayment, UpdateDocumentPayment, ChangeProperty, TimeStamped, Signed, AddDocumentPaymentRequest, Delivered, DeliverCanceled, SentByEmail, ReturnedBack, ChangedFlowStatus, ChangedKind, SentForSigning, Confirmed, Unconfirmed, SentFiles, AddDocumentPaymentOrder, DeleteDocumentPayment, DeleteDocumentPaymentRequest, MovedFromOrganization, Split, ChangeDocumentApprovals, Merged, Linked, SetAccess, ExpenseTransactionPaired, ExpenseTransactionUnpaired, SetMainFile, BudgetUpdated, MovedToOtherOrganization, MovedFromOtherOrganization",
435
+ )
436
+ identity: IdentityBase | None = None
437
+ info: str | None = None
438
+ created: WflowTimestamp | None = None
439
+
440
+
441
+ class DocumentFile(WflowModel):
442
+ """Document attachment file"""
443
+
444
+ id: str | None = Field(default=None, description="Id")
445
+ name: str | None = Field(default=None, description="Name")
446
+ main: bool | None = Field(default=None, description="Main attribute")
447
+ created: WflowTimestamp | None = Field(default=None, description="Creation date (yyyy-mm-ddThh:mm:ss.ffffff)")
448
+ signed: bool | None = Field(default=None, description="Whether the file is digitally signed")
449
+ stamped: bool | None = Field(default=None, description="Whether the file is time-stamped")
450
+
451
+
452
+ class CommentTeam(WflowModel):
453
+ id: str | None = Field(default=None, description="Id of CommentTeam")
454
+ team: TeamBase | None = None
455
+ isInTeam: bool | None = Field(default=None, description="Indicates whehter the user is in this Team")
456
+ resolved: WflowTimestamp | None = Field(default=None, description="Date and Time of resolvment of the comment")
457
+ resolver: IdentityBase | None = None
458
+
459
+
460
+ class Comment(WflowModel):
461
+ """Comment"""
462
+
463
+ id: str | None = Field(default=None, description="Id")
464
+ author: IdentityBase | None = None
465
+ text: str | None = Field(default=None, description="Text")
466
+ created: WflowTimestamp | None = Field(default=None, description="Date of creation")
467
+ updated: WflowTimestamp | None = Field(default=None, description="Last modified date")
468
+ removed: WflowTimestamp | None = Field(default=None, description="Date of removal")
469
+ nodes: str | None = Field(default=None, description="Nodes")
470
+ markdown: str | None = Field(default=None, description="Markdown")
471
+ teams: list[CommentTeam] | None = Field(default=None, description="List of teams")
472
+
473
+
474
+ class Property(WflowModel):
475
+ """Custom property"""
476
+
477
+ id: str | None = None
478
+ name: str | None = Field(default=None, description="Name")
479
+ order: int | None = Field(default=None, description="Order for presentation")
480
+ show: bool | None = Field(default=None, description="Visibility indicator")
481
+ type: str | None = None
482
+ editable: bool | None = Field(default=None, description="Read/write indicator")
483
+ kinds: list[str] | None = Field(
484
+ default=None,
485
+ description="Data One of: IncomingInvoice, OutgoingInvoice, ExpenditureCashSlip, SupplierOrder, CustomerOrder, Other, Contract, IncomeCashReceipt",
486
+ )
487
+ data: list[str] | None = None
488
+ value: Any | None = Field(default=None, description="Value")
489
+
490
+ def carries_definition(self) -> bool:
491
+ return self.name is not None and self.type is not None
492
+
493
+
494
+ class PropertyDefinition(WflowModel):
495
+ """Custom property definition"""
496
+
497
+ id: str | None = None
498
+ name: str | None = Field(default=None, description="Name")
499
+ order: int | None = Field(default=None, description="Order for presentation")
500
+ show: bool | None = Field(default=None, description="Visibility indicator")
501
+ type: str | None = None
502
+ editable: bool | None = Field(default=None, description="Read/write indicator")
503
+ kinds: list[str] | None = Field(
504
+ default=None,
505
+ description="Data One of: IncomingInvoice, OutgoingInvoice, ExpenditureCashSlip, SupplierOrder, CustomerOrder, Other, Contract, IncomeCashReceipt",
506
+ )
507
+ data: list[str] | None = None
508
+
509
+
510
+ class ApprovalProcess(WflowModel):
511
+ """Approval process"""
512
+
513
+ pathName: str | None = Field(default=None, description="Path name")
514
+ items: list[ApprovalProcessItem] | None = Field(default=None, description="Approval process item collection")