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

# \InvoiceApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_get_invoice**](InvoiceApi.md#get_get_invoice) | **GET** /api/invoices/{id} | Returns one invoice.
[**get_get_invoices**](InvoiceApi.md#get_get_invoices) | **GET** /api/invoices | Returns a paginated collection of invoices.



## get_get_invoice

> models::Invoice get_get_invoice(id)
Returns one invoice.

Needs permission: view_invoice

### Parameters


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

### Return type

[**models::Invoice**](Invoice.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_invoices

> Vec<models::InvoiceCollection> get_get_invoices(begin, end, customers_left_square_bracket_right_square_bracket, status_left_square_bracket_right_square_bracket, page, size)
Returns a paginated collection of invoices.

Needs permission: view_invoice

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**begin** | Option<**String**> | Only records after this date will be included (format: HTML5 datetime-local, e.g. YYYY-MM-DDThh:mm:ss) |  |
**end** | Option<**String**> | Only records before this date will be included (format: HTML5 datetime-local, e.g. YYYY-MM-DDThh:mm:ss) |  |
**customers_left_square_bracket_right_square_bracket** | Option<[**Vec<serde_json::Value>**](serde_json::Value.md)> | List of customer IDs to filter, e.g.: customers[]=1&customers[]=2 |  |[default to []]
**status_left_square_bracket_right_square_bracket** | Option<[**Vec<serde_json::Value>**](serde_json::Value.md)> | Invoice status: pending, paid, canceled, new. Default: all |  |[default to []]
**page** | Option<**String**> | The page to display, renders a 404 if not found (default: 1) |  |
**size** | Option<**String**> | The amount of entries for each page (default: 50) |  |

### Return type

[**Vec<models::InvoiceCollection>**](InvoiceCollection.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)