paperless_api/metadata/
custom_field.rs

1//! Types related to custom fields.
2
3use serde::{Deserialize, Serialize};
4
5use paperless_api_macros::{CreateDto, Item, UpdateDto};
6
7use crate::id::{CustomFieldId, SelectableOptionId};
8
9/// Custom field definition.
10#[derive(Debug, Clone, Deserialize, Serialize, CreateDto, UpdateDto, Item)]
11#[api_info(endpoint = "custom_fields")]
12pub struct CustomField {
13    /// Unique identifier of the custom field.
14    #[dto(skip)]
15    pub id: CustomFieldId,
16
17    /// Name of the custom field.
18    pub name: String,
19
20    /// Data type of the custom field.
21    pub data_type: CustomFieldDataType,
22
23    /// Extra data for the custom field, such as currency or select options.
24    pub extra_data: Option<CustomFieldExtraData>,
25
26    /// Number of documents that have this custom field set.
27    #[dto(skip)]
28    #[serde(default)]
29    pub document_count: u32,
30}
31
32/// Custom field value of an existing document.
33#[derive(Debug, Clone, Deserialize, Serialize)]
34pub struct DocumentCustomField {
35    /// Unique identifier of the custom field.
36    pub field: CustomFieldId,
37
38    /// Value of the custom field.
39    pub value: String,
40}
41
42/// Extra data for a custom field.
43#[derive(Debug, Clone, Deserialize, Serialize)]
44pub struct CustomFieldExtraData {
45    /// Default currency for monetary fields.
46    pub default_currency: Option<String>,
47
48    /// Selectable options for select fields.
49    pub select_options: Option<Vec<SelectableOption>>,
50}
51
52/// A selectable option for a custom field.
53#[derive(Debug, Clone, Deserialize, Serialize)]
54pub struct SelectableOption {
55    /// Unique identifier of the option.
56    pub id: SelectableOptionId,
57
58    /// Label of the option.
59    pub label: String,
60}
61
62/// Data type of a custom field.
63#[derive(Debug, Default, Clone, Deserialize, Serialize)]
64#[serde(rename_all = "lowercase")]
65pub enum CustomFieldDataType {
66    #[default]
67    String,
68    Url,
69    Date,
70    Boolean,
71    Integer,
72    Float,
73    Monetary,
74    Documentlink,
75    Select,
76    Longtext,
77}
paperless_api/metadata/custom_field.rs

paperless_api/metadata/
custom_field.rs
