kimai_client_lib 1.0.0

JSON API for the Kimai time-tracking software. Read our [API documentation](https://www.kimai.org/documentation/rest-api.html) and download the [Open API definition](doc.json) to import into your API client.
Documentation 
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282

# \CustomerApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_delete_customer**](CustomerApi.md#delete_delete_customer) | **DELETE** /api/customers/{id} | Delete an existing customer
[**delete_delete_customer_rate**](CustomerApi.md#delete_delete_customer_rate) | **DELETE** /api/customers/{id}/rates/{rateId} | Deletes one rate for a customer
[**get_get_customer**](CustomerApi.md#get_get_customer) | **GET** /api/customers/{id} | Returns one customer
[**get_get_customer_rates**](CustomerApi.md#get_get_customer_rates) | **GET** /api/customers/{id}/rates | Returns a collection of all rates for one customer
[**get_get_customers**](CustomerApi.md#get_get_customers) | **GET** /api/customers | Returns a collection of customers (which are visible to the user)
[**patch_app_api_customer_meta**](CustomerApi.md#patch_app_api_customer_meta) | **PATCH** /api/customers/{id}/meta | Sets the value of a meta-field for an existing customer
[**patch_patch_customer**](CustomerApi.md#patch_patch_customer) | **PATCH** /api/customers/{id} | Update an existing customer
[**post_post_customer**](CustomerApi.md#post_post_customer) | **POST** /api/customers | Creates a new customer
[**post_post_customer_rate**](CustomerApi.md#post_post_customer_rate) | **POST** /api/customers/{id}/rates | Adds a new rate to a customer



## delete_delete_customer

> delete_delete_customer(id)
Delete an existing customer

[DANGER] This will also delete ALL linked projects, project activities and timesheets. Maybe use `PATCH` instead and mark it as inactive with `visible=false`?

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Customer ID to delete | [required] |

### Return type

 (empty response body)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_delete_customer_rate

> delete_delete_customer_rate(id, rate_id)
Deletes one rate for a customer

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The customer whose rate will be removed | [required] |
**rate_id** | **String** | The rate to remove | [required] |

### Return type

 (empty response body)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_get_customer

> models::CustomerEntity get_get_customer(id)
Returns one customer

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** |  | [required] |

### Return type

[**models::CustomerEntity**](CustomerEntity.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_get_customer_rates

> Vec<models::CustomerRate> get_get_customer_rates(id)
Returns a collection of all rates for one customer

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The customer whose rates will be returned | [required] |

### Return type

[**Vec<models::CustomerRate>**](CustomerRate.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_get_customers

> Vec<models::CustomerCollection> get_get_customers(visible, order, order_by, term)
Returns a collection of customers (which are visible to the user)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**visible** | Option<**String**> | Visibility status to filter customers: 1=visible, 2=hidden, 3=both |  |[default to 1]
**order** | Option<**String**> | The result order. Allowed values: ASC, DESC (default: ASC) |  |
**order_by** | Option<**String**> | The field by which results will be ordered. Allowed values: id, name (default: name) |  |
**term** | Option<**String**> | Free search term |  |

### Return type

[**Vec<models::CustomerCollection>**](CustomerCollection.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## patch_app_api_customer_meta

> models::CustomerEntity patch_app_api_customer_meta(id, patch_kimaiplugin_expenses_api_expense_meta_request)
Sets the value of a meta-field for an existing customer

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Customer record ID to set the meta-field value for | [required] |
**patch_kimaiplugin_expenses_api_expense_meta_request** | Option<[**PatchKimaipluginExpensesApiExpenseMetaRequest**](PatchKimaipluginExpensesApiExpenseMetaRequest.md)> |  |  |

### Return type

[**models::CustomerEntity**](CustomerEntity.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## patch_patch_customer

> models::CustomerEntity patch_patch_customer(id, customer_edit_form)
Update an existing customer

Update an existing customer, you can pass all or just a subset of all attributes

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Customer ID to update | [required] |
**customer_edit_form** | [**CustomerEditForm**](CustomerEditForm.md) |  | [required] |

### Return type

[**models::CustomerEntity**](CustomerEntity.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## post_post_customer

> models::CustomerEntity post_post_customer(customer_edit_form)
Creates a new customer

Creates a new customer and returns it afterwards

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**customer_edit_form** | [**CustomerEditForm**](CustomerEditForm.md) |  | [required] |

### Return type

[**models::CustomerEntity**](CustomerEntity.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## post_post_customer_rate

> models::CustomerRate post_post_customer_rate(id, customer_rate_form)
Adds a new rate to a customer

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The customer to add the rate for | [required] |
**customer_rate_form** | [**CustomerRateForm**](CustomerRateForm.md) |  | [required] |

### Return type

[**models::CustomerRate**](CustomerRate.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)