Bug 23843: Add mapping to Koha::Acquisition::Fund
[koha.git] / api / v1 / swagger / definitions / fund.json
1 {
2   "type": "object",
3   "properties": {
4     "fund_id": {
5       "$ref": "../x-primitives.json#/fund_id"
6     },
7     "code": {
8       "type": [
9         "string",
10         "null"
11       ],
12       "description": "Code assigned to the fund by the user"
13     },
14     "name": {
15       "type": [
16         "string",
17         "null"
18       ],
19       "description": "Name assigned to the fund by the user"
20     },
21     "library_id": {
22       "type": [
23         "string",
24         "null"
25       ],
26       "description": "Internal identifier for the library that this fund belongs to"
27     },
28     "total_amount": {
29       "type": [
30         "number",
31         "null"
32       ],
33       "description": "Total amount for this fund"
34     },
35     "warn_at_percentage": {
36       "type": [
37         "number",
38         "null"
39       ],
40       "description": "Warning at percentage"
41     },
42     "warn_at_amount": {
43       "type": [
44         "number",
45         "null"
46       ],
47       "description": "Warning at amount"
48     },
49     "notes": {
50       "type": [
51         "string",
52         "null"
53       ],
54       "description": "Notes related to this fund"
55     },
56     "budget_id": {
57       "type": [
58         "number",
59         "null"
60       ],
61       "description": "Internal identifier for the budget"
62     },
63     "timestamp": {
64       "type": [
65         "string"
66       ],
67       "format": "date-time",
68       "description": "Timestamp"
69     },
70     "fund_owner_id": {
71       "type": [
72         "number",
73         "null"
74       ],
75       "description": "Internal identifier for the fund owner"
76     },
77     "fund_access": {
78       "type": [
79         "number",
80         "null"
81       ],
82       "description": "Level of permission for this fund (1: owner, 2: owner, users and library, 3: owner and users)"
83     },
84     "parent_fund_id": {
85         "type": [ "integer", "null" ],
86         "description": "Internal identifier for parent fund"
87     },
88     "statistic1_auth_value_category": {
89       "type": [
90         "string",
91         "null"
92       ],
93       "description": "Statistical category for this fund"
94     },
95     "statistic2_auth_value_category": {
96       "type": [
97         "string",
98         "null"
99       ],
100       "description": "Second statistical category for this fund"
101     }
102   },
103   "additionalProperties": false,
104   "required": ["name"]
105 }