Jacob Kiers
f0b8df90b9
This is definitely not functional yet. Signed-off-by: Jacob Kiers <code@kiers.eu>
278 lines
10 KiB
Markdown
278 lines
10 KiB
Markdown
# \BillsApi
|
|
|
|
All URIs are relative to *https://demo.firefly-iii.org/api*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**delete_bill**](BillsApi.md#delete_bill) | **DELETE** /v1/bills/{id} | Delete a bill.
|
|
[**get_bill**](BillsApi.md#get_bill) | **GET** /v1/bills/{id} | Get a single bill.
|
|
[**list_attachment_by_bill**](BillsApi.md#list_attachment_by_bill) | **GET** /v1/bills/{id}/attachments | List all attachments uploaded to the bill.
|
|
[**list_bill**](BillsApi.md#list_bill) | **GET** /v1/bills | List all bills.
|
|
[**list_rule_by_bill**](BillsApi.md#list_rule_by_bill) | **GET** /v1/bills/{id}/rules | List all rules associated with the bill.
|
|
[**list_transaction_by_bill**](BillsApi.md#list_transaction_by_bill) | **GET** /v1/bills/{id}/transactions | List all transactions associated with the bill.
|
|
[**store_bill**](BillsApi.md#store_bill) | **POST** /v1/bills | Store a new bill
|
|
[**update_bill**](BillsApi.md#update_bill) | **PUT** /v1/bills/{id} | Update existing bill.
|
|
|
|
|
|
|
|
## delete_bill
|
|
|
|
> delete_bill(id, x_trace_id)
|
|
Delete a bill.
|
|
|
|
Delete a bill. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**id** | **String** | The ID of the bill. | [required] |
|
|
**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. | |
|
|
|
|
### Return type
|
|
|
|
(empty response body)
|
|
|
|
### Authorization
|
|
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
|
|
|
### 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_bill
|
|
|
|
> models::BillSingle get_bill(id, x_trace_id, start, end)
|
|
Get a single bill.
|
|
|
|
Get a single bill.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**id** | **String** | The ID of the bill. | [required] |
|
|
**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. | |
|
|
**start** | Option<**String**> | A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates. | |
|
|
**end** | Option<**String**> | A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates. | |
|
|
|
|
### Return type
|
|
|
|
[**models::BillSingle**](BillSingle.md)
|
|
|
|
### Authorization
|
|
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json, application/vnd.api+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)
|
|
|
|
|
|
## list_attachment_by_bill
|
|
|
|
> models::AttachmentArray list_attachment_by_bill(id, x_trace_id, limit, page)
|
|
List all attachments uploaded to the bill.
|
|
|
|
This endpoint will list all attachments linked to the bill.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**id** | **String** | The ID of the bill. | [required] |
|
|
**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. | |
|
|
**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. | |
|
|
**page** | Option<**i32**> | Page number. The default pagination is per 50 items. | |
|
|
|
|
### Return type
|
|
|
|
[**models::AttachmentArray**](AttachmentArray.md)
|
|
|
|
### Authorization
|
|
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json, application/vnd.api+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)
|
|
|
|
|
|
## list_bill
|
|
|
|
> models::BillArray list_bill(x_trace_id, limit, page, start, end)
|
|
List all bills.
|
|
|
|
This endpoint will list all the user's bills.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. | |
|
|
**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. | |
|
|
**page** | Option<**i32**> | Page number. The default pagination is per 50 items. | |
|
|
**start** | Option<**String**> | A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates. | |
|
|
**end** | Option<**String**> | A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates. | |
|
|
|
|
### Return type
|
|
|
|
[**models::BillArray**](BillArray.md)
|
|
|
|
### Authorization
|
|
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json, application/vnd.api+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)
|
|
|
|
|
|
## list_rule_by_bill
|
|
|
|
> models::RuleArray list_rule_by_bill(id, x_trace_id)
|
|
List all rules associated with the bill.
|
|
|
|
This endpoint will list all rules that have an action to set the bill to this bill.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**id** | **String** | The ID of the bill. | [required] |
|
|
**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. | |
|
|
|
|
### Return type
|
|
|
|
[**models::RuleArray**](RuleArray.md)
|
|
|
|
### Authorization
|
|
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json, application/vnd.api+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)
|
|
|
|
|
|
## list_transaction_by_bill
|
|
|
|
> models::TransactionArray list_transaction_by_bill(id, x_trace_id, limit, page, start, end, r#type)
|
|
List all transactions associated with the bill.
|
|
|
|
This endpoint will list all transactions linked to this bill.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**id** | **String** | The ID of the bill. | [required] |
|
|
**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. | |
|
|
**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. | |
|
|
**page** | Option<**i32**> | Page number. The default pagination is per 50 items. | |
|
|
**start** | Option<**String**> | A date formatted YYYY-MM-DD. | |
|
|
**end** | Option<**String**> | A date formatted YYYY-MM-DD. | |
|
|
**r#type** | Option<[**TransactionTypeFilter**](.md)> | Optional filter on the transaction type(s) returned | |
|
|
|
|
### Return type
|
|
|
|
[**models::TransactionArray**](TransactionArray.md)
|
|
|
|
### Authorization
|
|
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json, application/vnd.api+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)
|
|
|
|
|
|
## store_bill
|
|
|
|
> models::BillSingle store_bill(bill_store, x_trace_id)
|
|
Store a new bill
|
|
|
|
Creates a new bill. The data required can be submitted as a JSON body or as a list of parameters.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**bill_store** | [**BillStore**](BillStore.md) | JSON array or key=value pairs with the necessary bill information. See the model for the exact specifications. | [required] |
|
|
**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. | |
|
|
|
|
### Return type
|
|
|
|
[**models::BillSingle**](BillSingle.md)
|
|
|
|
### Authorization
|
|
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json, application/x-www-form-urlencoded
|
|
- **Accept**: application/json, application/vnd.api+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)
|
|
|
|
|
|
## update_bill
|
|
|
|
> models::BillSingle update_bill(id, bill_update, x_trace_id)
|
|
Update existing bill.
|
|
|
|
Update existing bill.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**id** | **String** | The ID of the bill. | [required] |
|
|
**bill_update** | [**BillUpdate**](BillUpdate.md) | JSON array or key=value pairs with updated bill information. See the model for the exact specifications. | [required] |
|
|
**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. | |
|
|
|
|
### Return type
|
|
|
|
[**models::BillSingle**](BillSingle.md)
|
|
|
|
### Authorization
|
|
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json, application/x-www-form-urlencoded
|
|
- **Accept**: application/json, application/vnd.api+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)
|
|
|