84 lines
3.7 KiB
Markdown
84 lines
3.7 KiB
Markdown
# {{classname}}
|
|
|
|
All URIs are relative to *https://demo.firefly-iii.org/api*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**GetAvailableBudget**](AvailableBudgetsApi.md#GetAvailableBudget) | **Get** /v1/available-budgets/{id} | Get a single available budget.
|
|
[**ListAvailableBudget**](AvailableBudgetsApi.md#ListAvailableBudget) | **Get** /v1/available-budgets | List all available budget amounts.
|
|
|
|
# **GetAvailableBudget**
|
|
> AvailableBudgetSingle GetAvailableBudget(ctx, id, optional)
|
|
Get a single available budget.
|
|
|
|
Get a single available budget, by ID.
|
|
|
|
### Required Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
|
**id** | **string**| The ID of the available budget. |
|
|
**optional** | ***AvailableBudgetsApiGetAvailableBudgetOpts** | optional parameters | nil if no parameters
|
|
|
|
### Optional Parameters
|
|
Optional parameters are passed through a pointer to a AvailableBudgetsApiGetAvailableBudgetOpts struct
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
|
|
|
### Return type
|
|
|
|
[**AvailableBudgetSingle**](AvailableBudgetSingle.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)
|
|
|
|
# **ListAvailableBudget**
|
|
> AvailableBudgetArray ListAvailableBudget(ctx, optional)
|
|
List all available budget amounts.
|
|
|
|
Firefly III allows users to set the amount that is available to be budgeted in so-called \"available budgets\". For example, the user could have 1200,- available to be divided during the coming month. This amount is used on the /budgets page. This endpoint returns all of these amounts and the periods for which they are set.
|
|
|
|
### Required Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
|
**optional** | ***AvailableBudgetsApiListAvailableBudgetOpts** | optional parameters | nil if no parameters
|
|
|
|
### Optional Parameters
|
|
Optional parameters are passed through a pointer to a AvailableBudgetsApiListAvailableBudgetOpts struct
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
|
**limit** | **optional.Int32**| Number of items per page. The default pagination is per 50 items. |
|
|
**page** | **optional.Int32**| Page number. The default pagination is per 50 items. |
|
|
**start** | **optional.String**| A date formatted YYYY-MM-DD. |
|
|
**end** | **optional.String**| A date formatted YYYY-MM-DD. |
|
|
|
|
### Return type
|
|
|
|
[**AvailableBudgetArray**](AvailableBudgetArray.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)
|
|
|