You've already forked go-firefly3
Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
21371e5c22
|
|||
|
04e92891e3
|
|||
|
250d72604e
|
|||
|
0b320a6637
|
|||
cd8d766abb
|
25953
api/swagger.yaml
Normal file
25953
api/swagger.yaml
Normal file
File diff suppressed because it is too large
Load Diff
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -345,7 +345,7 @@ func (a *AboutApiService) GetCurrentUser(ctx context.Context, localVarOptionals
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -189,7 +189,7 @@ func (a *AccountsApiService) GetAccount(ctx context.Context, id string, localVar
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -343,7 +343,7 @@ func (a *AccountsApiService) ListAccount(ctx context.Context, localVarOptionals
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -489,7 +489,7 @@ func (a *AccountsApiService) ListAttachmentByAccount(ctx context.Context, id str
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -635,7 +635,7 @@ func (a *AccountsApiService) ListPiggyBankByAccount(ctx context.Context, id stri
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -796,7 +796,7 @@ func (a *AccountsApiService) ListTransactionByAccount(ctx context.Context, id st
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -931,7 +931,7 @@ func (a *AccountsApiService) StoreAccount(ctx context.Context, body AccountStore
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1080,7 +1080,7 @@ func (a *AccountsApiService) UpdateAccount(ctx context.Context, body AccountUpda
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -321,7 +321,7 @@ func (a *AttachmentsApiService) GetAttachment(ctx context.Context, id string, lo
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -465,7 +465,7 @@ func (a *AttachmentsApiService) ListAttachment(ctx context.Context, localVarOpti
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -600,7 +600,7 @@ func (a *AttachmentsApiService) StoreAttachment(ctx context.Context, body Attach
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -749,7 +749,7 @@ func (a *AttachmentsApiService) UpdateAttachment(ctx context.Context, body Attac
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -67,7 +67,7 @@ func (a *AvailableBudgetsApiService) GetAvailableBudget(ctx context.Context, id
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -221,7 +221,7 @@ func (a *AvailableBudgetsApiService) ListAvailableBudget(ctx context.Context, lo
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
20
api_bills.go
20
api_bills.go
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -194,7 +194,7 @@ func (a *BillsApiService) GetBill(ctx context.Context, id string, localVarOption
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -340,7 +340,7 @@ func (a *BillsApiService) ListAttachmentByBill(ctx context.Context, id string, l
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -494,7 +494,7 @@ func (a *BillsApiService) ListBill(ctx context.Context, localVarOptionals *Bills
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -630,7 +630,7 @@ func (a *BillsApiService) ListRuleByBill(ctx context.Context, id string, localVa
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -781,7 +781,7 @@ func (a *BillsApiService) ListTransactionByBill(ctx context.Context, id string,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -916,7 +916,7 @@ func (a *BillsApiService) StoreBill(ctx context.Context, body BillStore, localVa
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1065,7 +1065,7 @@ func (a *BillsApiService) UpdateBill(ctx context.Context, body BillUpdate, id st
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -313,7 +313,7 @@ func (a *BudgetsApiService) GetBudget(ctx context.Context, id string, localVarOp
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -453,7 +453,7 @@ func (a *BudgetsApiService) GetBudgetLimit(ctx context.Context, id string, limit
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -599,7 +599,7 @@ func (a *BudgetsApiService) ListAttachmentByBudget(ctx context.Context, id strin
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -753,7 +753,7 @@ func (a *BudgetsApiService) ListBudget(ctx context.Context, localVarOptionals *B
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -891,7 +891,7 @@ func (a *BudgetsApiService) ListBudgetLimit(ctx context.Context, start string, e
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1037,7 +1037,7 @@ func (a *BudgetsApiService) ListBudgetLimitByBudget(ctx context.Context, id stri
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1198,7 +1198,7 @@ func (a *BudgetsApiService) ListTransactionByBudget(ctx context.Context, id stri
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1351,7 +1351,7 @@ func (a *BudgetsApiService) ListTransactionByBudgetLimit(ctx context.Context, id
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1486,7 +1486,7 @@ func (a *BudgetsApiService) StoreBudget(ctx context.Context, body BudgetStore, l
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1635,7 +1635,7 @@ func (a *BudgetsApiService) StoreBudgetLimit(ctx context.Context, body BudgetLim
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1784,7 +1784,7 @@ func (a *BudgetsApiService) UpdateBudget(ctx context.Context, body BudgetUpdate,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1935,7 +1935,7 @@ func (a *BudgetsApiService) UpdateBudgetLimit(ctx context.Context, body BudgetLi
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -194,7 +194,7 @@ func (a *CategoriesApiService) GetCategory(ctx context.Context, id string, local
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -340,7 +340,7 @@ func (a *CategoriesApiService) ListAttachmentByCategory(ctx context.Context, id
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -484,7 +484,7 @@ func (a *CategoriesApiService) ListCategory(ctx context.Context, localVarOptiona
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -645,7 +645,7 @@ func (a *CategoriesApiService) ListTransactionByCategory(ctx context.Context, id
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -780,7 +780,7 @@ func (a *CategoriesApiService) StoreCategory(ctx context.Context, body Category,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -929,7 +929,7 @@ func (a *CategoriesApiService) UpdateCategory(ctx context.Context, body Category
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -67,7 +67,7 @@ func (a *CurrenciesApiService) DefaultCurrency(ctx context.Context, code string,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -320,7 +320,7 @@ func (a *CurrenciesApiService) DisableCurrency(ctx context.Context, code string,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -456,7 +456,7 @@ func (a *CurrenciesApiService) EnableCurrency(ctx context.Context, code string,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -592,7 +592,7 @@ func (a *CurrenciesApiService) GetCurrency(ctx context.Context, code string, loc
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -882,7 +882,7 @@ func (a *CurrenciesApiService) ListAccountByCurrency(ctx context.Context, code s
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1028,7 +1028,7 @@ func (a *CurrenciesApiService) ListAvailableBudgetByCurrency(ctx context.Context
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1174,7 +1174,7 @@ func (a *CurrenciesApiService) ListBillByCurrency(ctx context.Context, code stri
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1330,7 +1330,7 @@ func (a *CurrenciesApiService) ListBudgetLimitByCurrency(ctx context.Context, co
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1474,7 +1474,7 @@ func (a *CurrenciesApiService) ListCurrency(ctx context.Context, localVarOptiona
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1620,7 +1620,7 @@ func (a *CurrenciesApiService) ListRecurrenceByCurrency(ctx context.Context, cod
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1766,7 +1766,7 @@ func (a *CurrenciesApiService) ListRuleByCurrency(ctx context.Context, code stri
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1927,7 +1927,7 @@ func (a *CurrenciesApiService) ListTransactionByCurrency(ctx context.Context, co
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -2062,7 +2062,7 @@ func (a *CurrenciesApiService) StoreCurrency(ctx context.Context, body CurrencyS
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -2202,7 +2202,7 @@ func (a *CurrenciesApiService) UpdateCurrency(ctx context.Context, body Currency
|
||||
localVarFormParams := url.Values{}
|
||||
|
||||
// to determine the Content-Type header
|
||||
localVarHttpContentTypes := []string{"application/vnd.firefly3+json", "application/x-www-form-urlencoded"}
|
||||
localVarHttpContentTypes := []string{"application/vnd.api+json", "application/x-www-form-urlencoded"}
|
||||
|
||||
// set Content-Type header
|
||||
localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes)
|
||||
|
||||
11
api_data.go
11
api_data.go
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -29,9 +29,8 @@ type DataApiService service
|
||||
/*
|
||||
DataApiService Bulk update transaction properties. For more information, see https://docs.firefly-iii.org/references/firefly-iii/api/specials/
|
||||
Allows you to update transactions in bulk.
|
||||
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
||||
* @param query The JSON query.
|
||||
|
||||
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
||||
- @param query The JSON query.
|
||||
*/
|
||||
func (a *DataApiService) BulkUpdateTransactions(ctx context.Context, query string) (*http.Response, error) {
|
||||
var (
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
|
||||
22
api_links.go
22
api_links.go
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -301,7 +301,7 @@ func (a *LinksApiService) GetLinkType(ctx context.Context, id string, localVarOp
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -437,7 +437,7 @@ func (a *LinksApiService) GetTransactionLink(ctx context.Context, id string, loc
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -581,7 +581,7 @@ func (a *LinksApiService) ListLinkType(ctx context.Context, localVarOptionals *L
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -886,7 +886,7 @@ func (a *LinksApiService) ListTransactionLink(ctx context.Context, localVarOptio
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1021,7 +1021,7 @@ func (a *LinksApiService) StoreLinkType(ctx context.Context, body LinkType, loca
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1168,7 +1168,7 @@ func (a *LinksApiService) StoreTransactionLink(ctx context.Context, body Transac
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1317,7 +1317,7 @@ func (a *LinksApiService) UpdateLinkType(ctx context.Context, body LinkTypeUpdat
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1466,7 +1466,7 @@ func (a *LinksApiService) UpdateTransactionLink(ctx context.Context, body Transa
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -184,7 +184,7 @@ func (a *ObjectGroupsApiService) GetObjectGroup(ctx context.Context, id string,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -330,7 +330,7 @@ func (a *ObjectGroupsApiService) ListBillByObjectGroup(ctx context.Context, id s
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -474,7 +474,7 @@ func (a *ObjectGroupsApiService) ListObjectGroups(ctx context.Context, localVarO
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -620,7 +620,7 @@ func (a *ObjectGroupsApiService) ListPiggyBankByObjectGroup(ctx context.Context,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -757,7 +757,7 @@ func (a *ObjectGroupsApiService) UpdateObjectGroup(ctx context.Context, body Obj
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -184,7 +184,7 @@ func (a *PiggyBanksApiService) GetPiggyBank(ctx context.Context, id string, loca
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -330,7 +330,7 @@ func (a *PiggyBanksApiService) ListAttachmentByPiggyBank(ctx context.Context, id
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -476,7 +476,7 @@ func (a *PiggyBanksApiService) ListEventByPiggyBank(ctx context.Context, id stri
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -620,7 +620,7 @@ func (a *PiggyBanksApiService) ListPiggyBank(ctx context.Context, localVarOption
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -755,7 +755,7 @@ func (a *PiggyBanksApiService) StorePiggyBank(ctx context.Context, body PiggyBan
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -904,7 +904,7 @@ func (a *PiggyBanksApiService) UpdatePiggyBank(ctx context.Context, body PiggyBa
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -67,7 +67,7 @@ func (a *PreferencesApiService) GetPreference(ctx context.Context, name string,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -211,7 +211,7 @@ func (a *PreferencesApiService) ListPreference(ctx context.Context, localVarOpti
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -346,7 +346,7 @@ func (a *PreferencesApiService) StorePreference(ctx context.Context, body Prefer
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -495,7 +495,7 @@ func (a *PreferencesApiService) UpdatePreference(ctx context.Context, body Prefe
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -184,7 +184,7 @@ func (a *RecurrencesApiService) GetRecurrence(ctx context.Context, id string, lo
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -328,7 +328,7 @@ func (a *RecurrencesApiService) ListRecurrence(ctx context.Context, localVarOpti
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -489,7 +489,7 @@ func (a *RecurrencesApiService) ListTransactionByRecurrence(ctx context.Context,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -624,7 +624,7 @@ func (a *RecurrencesApiService) StoreRecurrence(ctx context.Context, body Recurr
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -773,7 +773,7 @@ func (a *RecurrencesApiService) UpdateRecurrence(ctx context.Context, body Recur
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -316,7 +316,7 @@ func (a *RuleGroupsApiService) GetRuleGroup(ctx context.Context, id string, loca
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -462,7 +462,7 @@ func (a *RuleGroupsApiService) ListRuleByGroup(ctx context.Context, id string, l
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -606,7 +606,7 @@ func (a *RuleGroupsApiService) ListRuleGroup(ctx context.Context, localVarOption
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -741,7 +741,7 @@ func (a *RuleGroupsApiService) StoreRuleGroup(ctx context.Context, body RuleGrou
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -924,7 +924,7 @@ func (a *RuleGroupsApiService) TestRuleGroup(ctx context.Context, id string, loc
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1061,7 +1061,7 @@ func (a *RuleGroupsApiService) UpdateRuleGroup(ctx context.Context, body RuleGro
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
16
api_rules.go
16
api_rules.go
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -316,7 +316,7 @@ func (a *RulesApiService) GetRule(ctx context.Context, id string, localVarOption
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -460,7 +460,7 @@ func (a *RulesApiService) ListRule(ctx context.Context, localVarOptionals *Rules
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -595,7 +595,7 @@ func (a *RulesApiService) StoreRule(ctx context.Context, body RuleStore, localVa
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -758,7 +758,7 @@ func (a *RulesApiService) TestRule(ctx context.Context, id string, localVarOptio
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -895,7 +895,7 @@ func (a *RulesApiService) UpdateRule(ctx context.Context, body RuleUpdate, id st
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -83,7 +83,7 @@ func (a *SearchApiService) SearchAccounts(ctx context.Context, query string, fie
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -229,7 +229,7 @@ func (a *SearchApiService) SearchTransactions(ctx context.Context, query string,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -73,7 +73,7 @@ func (a *SummaryApiService) GetBasicSummary(ctx context.Context, start string, e
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
18
api_tags.go
18
api_tags.go
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -194,7 +194,7 @@ func (a *TagsApiService) GetTag(ctx context.Context, tag string, localVarOptiona
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -340,7 +340,7 @@ func (a *TagsApiService) ListAttachmentByTag(ctx context.Context, tag string, lo
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -484,7 +484,7 @@ func (a *TagsApiService) ListTag(ctx context.Context, localVarOptionals *TagsApi
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -645,7 +645,7 @@ func (a *TagsApiService) ListTransactionByTag(ctx context.Context, tag string, l
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -780,7 +780,7 @@ func (a *TagsApiService) StoreTag(ctx context.Context, body TagModelStore, local
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -929,7 +929,7 @@ func (a *TagsApiService) UpdateTag(ctx context.Context, body TagModelUpdate, tag
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -301,7 +301,7 @@ func (a *TransactionsApiService) GetTransaction(ctx context.Context, id string,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -437,7 +437,7 @@ func (a *TransactionsApiService) GetTransactionByJournal(ctx context.Context, id
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -583,7 +583,7 @@ func (a *TransactionsApiService) ListAttachmentByTransaction(ctx context.Context
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -729,7 +729,7 @@ func (a *TransactionsApiService) ListEventByTransaction(ctx context.Context, id
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -875,7 +875,7 @@ func (a *TransactionsApiService) ListLinksByJournal(ctx context.Context, id stri
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1034,7 +1034,7 @@ func (a *TransactionsApiService) ListTransaction(ctx context.Context, localVarOp
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1169,7 +1169,7 @@ func (a *TransactionsApiService) StoreTransaction(ctx context.Context, body Tran
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1318,7 +1318,7 @@ func (a *TransactionsApiService) UpdateTransaction(ctx context.Context, body Tra
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
14
api_users.go
14
api_users.go
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -184,7 +184,7 @@ func (a *UsersApiService) GetUser(ctx context.Context, id string, localVarOption
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -328,7 +328,7 @@ func (a *UsersApiService) ListUser(ctx context.Context, localVarOptionals *Users
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -463,7 +463,7 @@ func (a *UsersApiService) StoreUser(ctx context.Context, body User, localVarOpti
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.firefly3+json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/json", "application/vnd.api+json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -612,7 +612,7 @@ func (a *UsersApiService) UpdateUser(ctx context.Context, body User, id string,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -426,7 +426,7 @@ func (a *WebhooksApiService) GetSingleWebhookMessage(ctx context.Context, id str
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -566,7 +566,7 @@ func (a *WebhooksApiService) GetSingleWebhookMessageAttempt(ctx context.Context,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -702,7 +702,7 @@ func (a *WebhooksApiService) GetWebhook(ctx context.Context, id string, localVar
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -850,7 +850,7 @@ func (a *WebhooksApiService) GetWebhookMessageAttempts(ctx context.Context, id s
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -986,7 +986,7 @@ func (a *WebhooksApiService) GetWebhookMessages(ctx context.Context, id string,
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1130,7 +1130,7 @@ func (a *WebhooksApiService) ListWebhook(ctx context.Context, localVarOptionals
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1265,7 +1265,7 @@ func (a *WebhooksApiService) StoreWebhook(ctx context.Context, body WebhookStore
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
@ -1570,7 +1570,7 @@ func (a *WebhooksApiService) UpdateWebhook(ctx context.Context, body WebhookUpda
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.firefly3+json", "application/json"}
|
||||
localVarHttpHeaderAccepts := []string{"application/vnd.api+json", "application/json"}
|
||||
|
||||
// set Accept header
|
||||
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
|
||||
|
||||
10
client.go
10
client.go
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -37,7 +37,7 @@ var (
|
||||
xmlCheck = regexp.MustCompile("(?i:[application|text]/xml)")
|
||||
)
|
||||
|
||||
// APIClient manages communication with the Firefly III API v2.0.12 API v2.0.12
|
||||
// APIClient manages communication with the Firefly III API v2.0.14 API v2.0.14
|
||||
// In most cases there should be only one, shared, APIClient.
|
||||
type APIClient struct {
|
||||
cfg *Configuration
|
||||
@ -390,7 +390,7 @@ func (c *APIClient) decode(v interface{}, b []byte, contentType string) (err err
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
} else if strings.Contains(contentType, "application/json") || strings.Contains(contentType, "application/vnd.api+json") {
|
||||
} else if strings.Contains(contentType, "application/json") {
|
||||
if err = json.Unmarshal(b, v); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Firefly III API v2.0.12
|
||||
* Firefly III API v2.0.14
|
||||
*
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-03-16T05:34:43+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
|
||||
*
|
||||
* API version: 2.0.12
|
||||
* API version: 2.0.14
|
||||
* Contact: james@firefly-iii.org
|
||||
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
|
||||
*/
|
||||
@ -60,7 +60,7 @@ type Configuration struct {
|
||||
|
||||
func NewConfiguration() *Configuration {
|
||||
cfg := &Configuration{
|
||||
BasePath: "https://demo.firefly-iii.org/firefly3",
|
||||
BasePath: "https://demo.firefly-iii.org/api",
|
||||
DefaultHeader: make(map[string]string),
|
||||
UserAgent: "Swagger-Codegen/1.0.0/go",
|
||||
}
|
||||
|
||||
116
docs/AboutApi.md
Normal file
116
docs/AboutApi.md
Normal file
@ -0,0 +1,116 @@
|
||||
# {{classname}}
|
||||
|
||||
All URIs are relative to *https://demo.firefly-iii.org/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**GetAbout**](AboutApi.md#GetAbout) | **Get** /v1/about | System information end point.
|
||||
[**GetCron**](AboutApi.md#GetCron) | **Get** /v1/cron/{cliToken} | Cron job endpoint
|
||||
[**GetCurrentUser**](AboutApi.md#GetCurrentUser) | **Get** /v1/about/user | Currently authenticated user endpoint.
|
||||
|
||||
# **GetAbout**
|
||||
> SystemInfo GetAbout(ctx, optional)
|
||||
System information end point.
|
||||
|
||||
Returns general system information and versions of the (supporting) software.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AboutApiGetAboutOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AboutApiGetAboutOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**SystemInfo**](SystemInfo.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetCron**
|
||||
> CronResult GetCron(ctx, cliToken, optional)
|
||||
Cron job endpoint
|
||||
|
||||
Firefly III has one endpoint for its various cron related tasks. Send a GET to this endpoint to run the cron. The cron requires the CLI token to be present. The cron job will fire for all users.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**cliToken** | **string**| The CLI token of any user in Firefly III, required to run the cron job. |
|
||||
**optional** | ***AboutApiGetCronOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AboutApiGetCronOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**date** | **optional.String**| A date formatted YYYY-MM-DD. This can be used to make the cron job pretend it's running on another day. |
|
||||
**force** | **optional.Bool**| Forces the cron job to fire, regardless of whether it has fired before. This may result in double transactions or weird budgets, so be careful. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CronResult**](CronResult.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetCurrentUser**
|
||||
> UserSingle GetCurrentUser(ctx, optional)
|
||||
Currently authenticated user endpoint.
|
||||
|
||||
Returns the currently authenticated user.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AboutApiGetCurrentUserOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AboutApiGetCurrentUserOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**UserSingle**](UserSingle.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)
|
||||
|
||||
39
docs/Account.md
Normal file
39
docs/Account.md
Normal file
@ -0,0 +1,39 @@
|
||||
# Account
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CreatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**UpdatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**Active** | **bool** | If omitted, defaults to true. | [optional] [default to true]
|
||||
**Order** | **int32** | Order of the account. Is NULL if account is not asset or liability. | [optional] [default to null]
|
||||
**Name** | **string** | | [default to null]
|
||||
**Type_** | [***ShortAccountTypeProperty**](ShortAccountTypeProperty.md) | | [default to null]
|
||||
**AccountRole** | [***AccountRoleProperty**](AccountRoleProperty.md) | | [optional] [default to null]
|
||||
**CurrencyId** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**CurrencyCode** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**CurrencySymbol** | **string** | | [optional] [default to null]
|
||||
**CurrencyDecimalPlaces** | **int32** | | [optional] [default to null]
|
||||
**CurrentBalance** | **string** | | [optional] [default to null]
|
||||
**CurrentBalanceDate** | [**time.Time**](time.Time.md) | The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. | [optional] [default to null]
|
||||
**Iban** | **string** | | [optional] [default to null]
|
||||
**Bic** | **string** | | [optional] [default to null]
|
||||
**AccountNumber** | **string** | | [optional] [default to null]
|
||||
**OpeningBalance** | **string** | Represents the opening balance, the initial amount this account holds. | [optional] [default to null]
|
||||
**CurrentDebt** | **string** | Represents the current debt for liabilities. | [optional] [default to null]
|
||||
**OpeningBalanceDate** | [**time.Time**](time.Time.md) | Represents the date of the opening balance. | [optional] [default to null]
|
||||
**VirtualBalance** | **string** | | [optional] [default to null]
|
||||
**IncludeNetWorth** | **bool** | If omitted, defaults to true. | [optional] [default to true]
|
||||
**CreditCardType** | [***CreditCardTypeProperty**](CreditCardTypeProperty.md) | | [optional] [default to null]
|
||||
**MonthlyPaymentDate** | [**time.Time**](time.Time.md) | Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. | [optional] [default to null]
|
||||
**LiabilityType** | [***LiabilityTypeProperty**](LiabilityTypeProperty.md) | | [optional] [default to null]
|
||||
**LiabilityDirection** | [***LiabilityDirectionProperty**](LiabilityDirectionProperty.md) | | [optional] [default to null]
|
||||
**Interest** | **string** | Mandatory when type is liability. Interest percentage. | [optional] [default to null]
|
||||
**InterestPeriod** | [***InterestPeriodProperty**](InterestPeriodProperty.md) | | [optional] [default to null]
|
||||
**Notes** | **string** | | [optional] [default to null]
|
||||
**Latitude** | **float64** | Latitude of the accounts's location, if applicable. Can be used to draw a map. | [optional] [default to null]
|
||||
**Longitude** | **float64** | Latitude of the accounts's location, if applicable. Can be used to draw a map. | [optional] [default to null]
|
||||
**ZoomLevel** | **int32** | Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
10
docs/AccountArray.md
Normal file
10
docs/AccountArray.md
Normal file
@ -0,0 +1,10 @@
|
||||
# AccountArray
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Data** | [**[]AccountRead**](AccountRead.md) | | [default to null]
|
||||
**Meta** | [***Meta**](Meta.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
11
docs/AccountRead.md
Normal file
11
docs/AccountRead.md
Normal file
@ -0,0 +1,11 @@
|
||||
# AccountRead
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type_** | **string** | Immutable value | [default to null]
|
||||
**Id** | **string** | | [default to null]
|
||||
**Attributes** | [***Account**](Account.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
8
docs/AccountRoleProperty.md
Normal file
8
docs/AccountRoleProperty.md
Normal file
@ -0,0 +1,8 @@
|
||||
# AccountRoleProperty
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
8
docs/AccountSearchFieldFilter.md
Normal file
8
docs/AccountSearchFieldFilter.md
Normal file
@ -0,0 +1,8 @@
|
||||
# AccountSearchFieldFilter
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
9
docs/AccountSingle.md
Normal file
9
docs/AccountSingle.md
Normal file
@ -0,0 +1,9 @@
|
||||
# AccountSingle
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Data** | [***AccountRead**](AccountRead.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
32
docs/AccountStore.md
Normal file
32
docs/AccountStore.md
Normal file
@ -0,0 +1,32 @@
|
||||
# AccountStore
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **string** | | [default to null]
|
||||
**Type_** | [***ShortAccountTypeProperty**](ShortAccountTypeProperty.md) | | [default to null]
|
||||
**Iban** | **string** | | [optional] [default to null]
|
||||
**Bic** | **string** | | [optional] [default to null]
|
||||
**AccountNumber** | **string** | | [optional] [default to null]
|
||||
**OpeningBalance** | **string** | Represents the opening balance, the initial amount this account holds. | [optional] [default to null]
|
||||
**OpeningBalanceDate** | [**time.Time**](time.Time.md) | Represents the date of the opening balance. | [optional] [default to null]
|
||||
**VirtualBalance** | **string** | | [optional] [default to null]
|
||||
**CurrencyId** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**CurrencyCode** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**Active** | **bool** | If omitted, defaults to true. | [optional] [default to true]
|
||||
**Order** | **int32** | Order of the account | [optional] [default to null]
|
||||
**IncludeNetWorth** | **bool** | If omitted, defaults to true. | [optional] [default to true]
|
||||
**AccountRole** | [***AccountRoleProperty**](AccountRoleProperty.md) | | [optional] [default to null]
|
||||
**CreditCardType** | [***CreditCardTypeProperty**](CreditCardTypeProperty.md) | | [optional] [default to null]
|
||||
**MonthlyPaymentDate** | [**time.Time**](time.Time.md) | Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. | [optional] [default to null]
|
||||
**LiabilityType** | [***LiabilityTypeProperty**](LiabilityTypeProperty.md) | | [optional] [default to null]
|
||||
**LiabilityDirection** | [***LiabilityDirectionProperty**](LiabilityDirectionProperty.md) | | [optional] [default to null]
|
||||
**Interest** | **string** | Mandatory when type is liability. Interest percentage. | [optional] [default to 0]
|
||||
**InterestPeriod** | [***InterestPeriodProperty**](InterestPeriodProperty.md) | | [optional] [default to null]
|
||||
**Notes** | **string** | | [optional] [default to null]
|
||||
**Latitude** | **float64** | Latitude of the accounts's location, if applicable. Can be used to draw a map. | [optional] [default to null]
|
||||
**Longitude** | **float64** | Latitude of the accounts's location, if applicable. Can be used to draw a map. | [optional] [default to null]
|
||||
**ZoomLevel** | **int32** | Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
8
docs/AccountTypeFilter.md
Normal file
8
docs/AccountTypeFilter.md
Normal file
@ -0,0 +1,8 @@
|
||||
# AccountTypeFilter
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
8
docs/AccountTypeProperty.md
Normal file
8
docs/AccountTypeProperty.md
Normal file
@ -0,0 +1,8 @@
|
||||
# AccountTypeProperty
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
30
docs/AccountUpdate.md
Normal file
30
docs/AccountUpdate.md
Normal file
@ -0,0 +1,30 @@
|
||||
# AccountUpdate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **string** | | [default to null]
|
||||
**Iban** | **string** | | [optional] [default to null]
|
||||
**Bic** | **string** | | [optional] [default to null]
|
||||
**AccountNumber** | **string** | | [optional] [default to null]
|
||||
**OpeningBalance** | **string** | | [optional] [default to null]
|
||||
**OpeningBalanceDate** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**VirtualBalance** | **string** | | [optional] [default to null]
|
||||
**CurrencyId** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**CurrencyCode** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**Active** | **bool** | If omitted, defaults to true. | [optional] [default to true]
|
||||
**Order** | **int32** | Order of the account | [optional] [default to null]
|
||||
**IncludeNetWorth** | **bool** | If omitted, defaults to true. | [optional] [default to true]
|
||||
**AccountRole** | [***AccountRoleProperty**](AccountRoleProperty.md) | | [optional] [default to null]
|
||||
**CreditCardType** | [***CreditCardTypeProperty**](CreditCardTypeProperty.md) | | [optional] [default to null]
|
||||
**MonthlyPaymentDate** | [**time.Time**](time.Time.md) | Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. | [optional] [default to null]
|
||||
**LiabilityType** | [***LiabilityTypeProperty**](LiabilityTypeProperty.md) | | [optional] [default to null]
|
||||
**Interest** | **string** | Mandatory when type is liability. Interest percentage. | [optional] [default to null]
|
||||
**InterestPeriod** | [***InterestPeriodProperty**](InterestPeriodProperty.md) | | [optional] [default to null]
|
||||
**Notes** | **string** | | [optional] [default to null]
|
||||
**Latitude** | **float64** | Latitude of the account's location, if applicable. Can be used to draw a map. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed. | [optional] [default to null]
|
||||
**Longitude** | **float64** | Latitude of the account's location, if applicable. Can be used to draw a map. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed. | [optional] [default to null]
|
||||
**ZoomLevel** | **int32** | Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
409
docs/AccountsApi.md
Normal file
409
docs/AccountsApi.md
Normal file
@ -0,0 +1,409 @@
|
||||
# {{classname}}
|
||||
|
||||
All URIs are relative to *https://demo.firefly-iii.org/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**DeleteAccount**](AccountsApi.md#DeleteAccount) | **Delete** /v1/accounts/{id} | Permanently delete account.
|
||||
[**GetAccount**](AccountsApi.md#GetAccount) | **Get** /v1/accounts/{id} | Get single account.
|
||||
[**ListAccount**](AccountsApi.md#ListAccount) | **Get** /v1/accounts | List all accounts.
|
||||
[**ListAttachmentByAccount**](AccountsApi.md#ListAttachmentByAccount) | **Get** /v1/accounts/{id}/attachments | Lists all attachments.
|
||||
[**ListPiggyBankByAccount**](AccountsApi.md#ListPiggyBankByAccount) | **Get** /v1/accounts/{id}/piggy-banks | List all piggy banks related to the account.
|
||||
[**ListTransactionByAccount**](AccountsApi.md#ListTransactionByAccount) | **Get** /v1/accounts/{id}/transactions | List all transactions related to the account.
|
||||
[**StoreAccount**](AccountsApi.md#StoreAccount) | **Post** /v1/accounts | Create new account.
|
||||
[**UpdateAccount**](AccountsApi.md#UpdateAccount) | **Put** /v1/accounts/{id} | Update existing account.
|
||||
|
||||
# **DeleteAccount**
|
||||
> DeleteAccount(ctx, id, optional)
|
||||
Permanently delete account.
|
||||
|
||||
Will permanently delete an account. Any associated transactions and piggy banks are ALSO deleted. Cannot be recovered from.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the account. |
|
||||
**optional** | ***AccountsApiDeleteAccountOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AccountsApiDeleteAccountOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| 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)
|
||||
|
||||
# **GetAccount**
|
||||
> AccountSingle GetAccount(ctx, id, optional)
|
||||
Get single account.
|
||||
|
||||
Returns a single account by its ID.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the account. |
|
||||
**optional** | ***AccountsApiGetAccountOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AccountsApiGetAccountOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**date** | **optional.String**| A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account's balance on that day. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccountSingle**](AccountSingle.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)
|
||||
|
||||
# **ListAccount**
|
||||
> AccountArray ListAccount(ctx, optional)
|
||||
List all accounts.
|
||||
|
||||
This endpoint returns a list of all the accounts owned by the authenticated user.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AccountsApiListAccountOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AccountsApiListAccountOpts 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. |
|
||||
**date** | **optional.String**| A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account's balance on that day. |
|
||||
**type_** | [**optional.Interface of AccountTypeFilter**](.md)| Optional filter on the account type(s) returned |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccountArray**](AccountArray.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)
|
||||
|
||||
# **ListAttachmentByAccount**
|
||||
> AttachmentArray ListAttachmentByAccount(ctx, id, optional)
|
||||
Lists all attachments.
|
||||
|
||||
Lists all attachments.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the account. |
|
||||
**optional** | ***AccountsApiListAttachmentByAccountOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AccountsApiListAttachmentByAccountOpts 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. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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)
|
||||
|
||||
# **ListPiggyBankByAccount**
|
||||
> PiggyBankArray ListPiggyBankByAccount(ctx, id, optional)
|
||||
List all piggy banks related to the account.
|
||||
|
||||
This endpoint returns a list of all the piggy banks connected to the account.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the account. |
|
||||
**optional** | ***AccountsApiListPiggyBankByAccountOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AccountsApiListPiggyBankByAccountOpts 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. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PiggyBankArray**](PiggyBankArray.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)
|
||||
|
||||
# **ListTransactionByAccount**
|
||||
> TransactionArray ListTransactionByAccount(ctx, id, optional)
|
||||
List all transactions related to the account.
|
||||
|
||||
This endpoint returns a list of all the transactions connected to the account.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the account. |
|
||||
**optional** | ***AccountsApiListTransactionByAccountOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AccountsApiListTransactionByAccountOpts 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. |
|
||||
**type_** | [**optional.Interface of TransactionTypeFilter**](.md)| Optional filter on the transaction type(s) returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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)
|
||||
|
||||
# **StoreAccount**
|
||||
> AccountSingle StoreAccount(ctx, body, name, type_, iban, bic, accountNumber, openingBalance, openingBalanceDate, virtualBalance, currencyId, currencyCode, active, order, includeNetWorth, accountRole, creditCardType, monthlyPaymentDate, liabilityType, liabilityDirection, interest, interestPeriod, notes, latitude, longitude, zoomLevel, optional)
|
||||
Create new account.
|
||||
|
||||
Creates a new account. The data required can be submitted as a JSON body or as a list of parameters (in key=value pairs, like a webform).
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**AccountStore**](AccountStore.md)| JSON array with the necessary account information or key=value pairs. See the model for the exact specifications. |
|
||||
**name** | **string**| |
|
||||
**type_** | [**ShortAccountTypeProperty**](.md)| |
|
||||
**iban** | **string**| |
|
||||
**bic** | **string**| |
|
||||
**accountNumber** | **string**| |
|
||||
**openingBalance** | **string**| |
|
||||
**openingBalanceDate** | **time.Time**| |
|
||||
**virtualBalance** | **string**| |
|
||||
**currencyId** | **string**| |
|
||||
**currencyCode** | **string**| |
|
||||
**active** | **bool**| |
|
||||
**order** | **int32**| |
|
||||
**includeNetWorth** | **bool**| |
|
||||
**accountRole** | [**AccountRoleProperty**](.md)| |
|
||||
**creditCardType** | [**CreditCardTypeProperty**](.md)| |
|
||||
**monthlyPaymentDate** | **time.Time**| |
|
||||
**liabilityType** | [**LiabilityTypeProperty**](.md)| |
|
||||
**liabilityDirection** | [**LiabilityDirectionProperty**](.md)| |
|
||||
**interest** | **string**| |
|
||||
**interestPeriod** | [**InterestPeriodProperty**](.md)| |
|
||||
**notes** | **string**| |
|
||||
**latitude** | **float64**| |
|
||||
**longitude** | **float64**| |
|
||||
**zoomLevel** | **int32**| |
|
||||
**optional** | ***AccountsApiStoreAccountOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AccountsApiStoreAccountOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccountSingle**](AccountSingle.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)
|
||||
|
||||
# **UpdateAccount**
|
||||
> AccountSingle UpdateAccount(ctx, body, name, iban, bic, accountNumber, openingBalance, openingBalanceDate, virtualBalance, currencyId, currencyCode, active, order, includeNetWorth, accountRole, creditCardType, monthlyPaymentDate, liabilityType, interest, interestPeriod, notes, latitude, longitude, zoomLevel, id, optional)
|
||||
Update existing account.
|
||||
|
||||
Used to update a single account. All fields that are not submitted will be cleared (set to NULL). The model will tell you which fields are mandatory.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**AccountUpdate**](AccountUpdate.md)| JSON array or formdata with updated account information. See the model for the exact specifications. |
|
||||
**name** | **string**| |
|
||||
**iban** | **string**| |
|
||||
**bic** | **string**| |
|
||||
**accountNumber** | **string**| |
|
||||
**openingBalance** | **string**| |
|
||||
**openingBalanceDate** | **time.Time**| |
|
||||
**virtualBalance** | **string**| |
|
||||
**currencyId** | **string**| |
|
||||
**currencyCode** | **string**| |
|
||||
**active** | **bool**| |
|
||||
**order** | **int32**| |
|
||||
**includeNetWorth** | **bool**| |
|
||||
**accountRole** | [**AccountRoleProperty**](.md)| |
|
||||
**creditCardType** | [**CreditCardTypeProperty**](.md)| |
|
||||
**monthlyPaymentDate** | **time.Time**| |
|
||||
**liabilityType** | [**LiabilityTypeProperty**](.md)| |
|
||||
**interest** | **string**| |
|
||||
**interestPeriod** | [**InterestPeriodProperty**](.md)| |
|
||||
**notes** | **string**| |
|
||||
**latitude** | **float64**| |
|
||||
**longitude** | **float64**| |
|
||||
**zoomLevel** | **int32**| |
|
||||
**id** | **string**| The ID of the account. |
|
||||
**optional** | ***AccountsApiUpdateAccountOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AccountsApiUpdateAccountOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccountSingle**](AccountSingle.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)
|
||||
|
||||
8
docs/AttachableType.md
Normal file
8
docs/AttachableType.md
Normal file
@ -0,0 +1,8 @@
|
||||
# AttachableType
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
20
docs/Attachment.md
Normal file
20
docs/Attachment.md
Normal file
@ -0,0 +1,20 @@
|
||||
# Attachment
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CreatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**UpdatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**AttachableType** | [***AttachableType**](AttachableType.md) | | [default to null]
|
||||
**AttachableId** | **string** | ID of the model this attachment is linked to. | [default to null]
|
||||
**Md5** | **string** | MD5 hash of the file for basic duplicate detection. | [optional] [default to null]
|
||||
**Filename** | **string** | | [default to null]
|
||||
**DownloadUrl** | **string** | | [optional] [default to null]
|
||||
**UploadUrl** | **string** | | [optional] [default to null]
|
||||
**Title** | **string** | | [optional] [default to null]
|
||||
**Notes** | **string** | | [optional] [default to null]
|
||||
**Mime** | **string** | | [optional] [default to null]
|
||||
**Size** | **int32** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
10
docs/AttachmentArray.md
Normal file
10
docs/AttachmentArray.md
Normal file
@ -0,0 +1,10 @@
|
||||
# AttachmentArray
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Data** | [**[]AttachmentRead**](AttachmentRead.md) | | [default to null]
|
||||
**Meta** | [***Meta**](Meta.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
12
docs/AttachmentRead.md
Normal file
12
docs/AttachmentRead.md
Normal file
@ -0,0 +1,12 @@
|
||||
# AttachmentRead
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type_** | **string** | Immutable value | [default to null]
|
||||
**Id** | **string** | | [default to null]
|
||||
**Attributes** | [***Attachment**](Attachment.md) | | [default to null]
|
||||
**Links** | [***ObjectLink**](ObjectLink.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
9
docs/AttachmentSingle.md
Normal file
9
docs/AttachmentSingle.md
Normal file
@ -0,0 +1,9 @@
|
||||
# AttachmentSingle
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Data** | [***AttachmentRead**](AttachmentRead.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
13
docs/AttachmentStore.md
Normal file
13
docs/AttachmentStore.md
Normal file
@ -0,0 +1,13 @@
|
||||
# AttachmentStore
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Filename** | **string** | | [default to null]
|
||||
**AttachableType** | [***AttachableType**](AttachableType.md) | | [default to null]
|
||||
**AttachableId** | **string** | ID of the model this attachment is linked to. | [default to null]
|
||||
**Title** | **string** | | [optional] [default to null]
|
||||
**Notes** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
11
docs/AttachmentUpdate.md
Normal file
11
docs/AttachmentUpdate.md
Normal file
@ -0,0 +1,11 @@
|
||||
# AttachmentUpdate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Filename** | **string** | | [optional] [default to null]
|
||||
**Title** | **string** | | [optional] [default to null]
|
||||
**Notes** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
285
docs/AttachmentsApi.md
Normal file
285
docs/AttachmentsApi.md
Normal file
@ -0,0 +1,285 @@
|
||||
# {{classname}}
|
||||
|
||||
All URIs are relative to *https://demo.firefly-iii.org/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**DeleteAttachment**](AttachmentsApi.md#DeleteAttachment) | **Delete** /v1/attachments/{id} | Delete an attachment.
|
||||
[**DownloadAttachment**](AttachmentsApi.md#DownloadAttachment) | **Get** /v1/attachments/{id}/download | Download a single attachment.
|
||||
[**GetAttachment**](AttachmentsApi.md#GetAttachment) | **Get** /v1/attachments/{id} | Get a single attachment.
|
||||
[**ListAttachment**](AttachmentsApi.md#ListAttachment) | **Get** /v1/attachments | List all attachments.
|
||||
[**StoreAttachment**](AttachmentsApi.md#StoreAttachment) | **Post** /v1/attachments | Store a new attachment.
|
||||
[**UpdateAttachment**](AttachmentsApi.md#UpdateAttachment) | **Put** /v1/attachments/{id} | Update existing attachment.
|
||||
[**UploadAttachment**](AttachmentsApi.md#UploadAttachment) | **Post** /v1/attachments/{id}/upload | Upload an attachment.
|
||||
|
||||
# **DeleteAttachment**
|
||||
> DeleteAttachment(ctx, id, optional)
|
||||
Delete an attachment.
|
||||
|
||||
With this endpoint you delete an attachment, including any stored file data.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the single attachment. |
|
||||
**optional** | ***AttachmentsApiDeleteAttachmentOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AttachmentsApiDeleteAttachmentOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| 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)
|
||||
|
||||
# **DownloadAttachment**
|
||||
> *os.File DownloadAttachment(ctx, id, optional)
|
||||
Download a single attachment.
|
||||
|
||||
This endpoint allows you to download the binary content of a transaction. It will be sent to you as a download, using the content type \"application/octet-stream\" and content disposition \"attachment; filename=example.pdf\".
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the attachment. |
|
||||
**optional** | ***AttachmentsApiDownloadAttachmentOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AttachmentsApiDownloadAttachmentOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[***os.File**](*os.File.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/octet-stream, 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)
|
||||
|
||||
# **GetAttachment**
|
||||
> AttachmentSingle GetAttachment(ctx, id, optional)
|
||||
Get a single attachment.
|
||||
|
||||
Get a single attachment. This endpoint only returns the available metadata for the attachment. Actual file data is handled in two other endpoints (see below).
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the attachment. |
|
||||
**optional** | ***AttachmentsApiGetAttachmentOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AttachmentsApiGetAttachmentOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AttachmentSingle**](AttachmentSingle.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)
|
||||
|
||||
# **ListAttachment**
|
||||
> AttachmentArray ListAttachment(ctx, optional)
|
||||
List all attachments.
|
||||
|
||||
This endpoint lists all attachments.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AttachmentsApiListAttachmentOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AttachmentsApiListAttachmentOpts 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. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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)
|
||||
|
||||
# **StoreAttachment**
|
||||
> AttachmentSingle StoreAttachment(ctx, body, filename, attachableType, attachableId, title, notes, optional)
|
||||
Store a new attachment.
|
||||
|
||||
Creates a new attachment. The data required can be submitted as a JSON body or as a list of parameters. You cannot use this endpoint to upload the actual file data (see below). This endpoint only creates the attachment object.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**AttachmentStore**](AttachmentStore.md)| JSON array or key=value pairs with the necessary attachment information. See the model for the exact specifications. |
|
||||
**filename** | **string**| |
|
||||
**attachableType** | [**AttachableType**](.md)| |
|
||||
**attachableId** | **string**| |
|
||||
**title** | **string**| |
|
||||
**notes** | **string**| |
|
||||
**optional** | ***AttachmentsApiStoreAttachmentOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AttachmentsApiStoreAttachmentOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AttachmentSingle**](AttachmentSingle.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)
|
||||
|
||||
# **UpdateAttachment**
|
||||
> AttachmentSingle UpdateAttachment(ctx, body, filename, title, notes, id, optional)
|
||||
Update existing attachment.
|
||||
|
||||
Update the meta data for an existing attachment. This endpoint does not allow you to upload or download data. For that, see below.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**AttachmentUpdate**](AttachmentUpdate.md)| JSON array with updated attachment information. See the model for the exact specifications. |
|
||||
**filename** | **string**| |
|
||||
**title** | **string**| |
|
||||
**notes** | **string**| |
|
||||
**id** | **string**| The ID of the attachment. |
|
||||
**optional** | ***AttachmentsApiUpdateAttachmentOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AttachmentsApiUpdateAttachmentOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AttachmentSingle**](AttachmentSingle.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)
|
||||
|
||||
# **UploadAttachment**
|
||||
> UploadAttachment(ctx, id, optional)
|
||||
Upload an attachment.
|
||||
|
||||
Use this endpoint to upload (and possible overwrite) the file contents of an attachment. Simply put the entire file in the body as binary data.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the attachment. |
|
||||
**optional** | ***AttachmentsApiUploadAttachmentOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AttachmentsApiUploadAttachmentOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**body** | [**optional.Interface of Object**](Object.md)| |
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| 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**: application/octet-stream
|
||||
- **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)
|
||||
|
||||
8
docs/AutoBudgetPeriod.md
Normal file
8
docs/AutoBudgetPeriod.md
Normal file
@ -0,0 +1,8 @@
|
||||
# AutoBudgetPeriod
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
8
docs/AutoBudgetType.md
Normal file
8
docs/AutoBudgetType.md
Normal file
@ -0,0 +1,8 @@
|
||||
# AutoBudgetType
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
17
docs/AutocompleteAccount.md
Normal file
17
docs/AutocompleteAccount.md
Normal file
@ -0,0 +1,17 @@
|
||||
# AutocompleteAccount
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Name** | **string** | Name of the account found by an auto-complete search. | [default to null]
|
||||
**NameWithBalance** | **string** | Asset accounts and liabilities have a second field with the given date's account balance. | [default to null]
|
||||
**Type_** | **string** | Account type of the account found by the auto-complete search. | [default to null]
|
||||
**CurrencyId** | **string** | ID for the currency used by this account. | [default to null]
|
||||
**CurrencyName** | **string** | Currency name for the currency used by this account. | [default to null]
|
||||
**CurrencyCode** | **string** | Currency code for the currency used by this account. | [default to null]
|
||||
**CurrencySymbol** | **string** | Currency symbol for the currency used by this account. | [default to null]
|
||||
**CurrencyDecimalPlaces** | **int32** | Number of decimal places for the currency used by this account. | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
569
docs/AutocompleteApi.md
Normal file
569
docs/AutocompleteApi.md
Normal file
@ -0,0 +1,569 @@
|
||||
# {{classname}}
|
||||
|
||||
All URIs are relative to *https://demo.firefly-iii.org/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**GetAccountsAC**](AutocompleteApi.md#GetAccountsAC) | **Get** /v1/autocomplete/accounts | Returns all accounts of the user returned in a basic auto-complete array.
|
||||
[**GetBillsAC**](AutocompleteApi.md#GetBillsAC) | **Get** /v1/autocomplete/bills | Returns all bills of the user returned in a basic auto-complete array.
|
||||
[**GetBudgetsAC**](AutocompleteApi.md#GetBudgetsAC) | **Get** /v1/autocomplete/budgets | Returns all budgets of the user returned in a basic auto-complete array.
|
||||
[**GetCategoriesAC**](AutocompleteApi.md#GetCategoriesAC) | **Get** /v1/autocomplete/categories | Returns all categories of the user returned in a basic auto-complete array.
|
||||
[**GetCurrenciesAC**](AutocompleteApi.md#GetCurrenciesAC) | **Get** /v1/autocomplete/currencies | Returns all currencies of the user returned in a basic auto-complete array.
|
||||
[**GetCurrenciesCodeAC**](AutocompleteApi.md#GetCurrenciesCodeAC) | **Get** /v1/autocomplete/currencies-with-code | Returns all currencies of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
|
||||
[**GetObjectGroupsAC**](AutocompleteApi.md#GetObjectGroupsAC) | **Get** /v1/autocomplete/object-groups | Returns all object groups of the user returned in a basic auto-complete array.
|
||||
[**GetPiggiesAC**](AutocompleteApi.md#GetPiggiesAC) | **Get** /v1/autocomplete/piggy-banks | Returns all piggy banks of the user returned in a basic auto-complete array.
|
||||
[**GetPiggiesBalanceAC**](AutocompleteApi.md#GetPiggiesBalanceAC) | **Get** /v1/autocomplete/piggy-banks-with-balance | Returns all piggy banks of the user returned in a basic auto-complete array complemented with balance information.
|
||||
[**GetRecurringAC**](AutocompleteApi.md#GetRecurringAC) | **Get** /v1/autocomplete/recurring | Returns all recurring transactions of the user returned in a basic auto-complete array.
|
||||
[**GetRuleGroupsAC**](AutocompleteApi.md#GetRuleGroupsAC) | **Get** /v1/autocomplete/rule-groups | Returns all rule groups of the user returned in a basic auto-complete array.
|
||||
[**GetRulesAC**](AutocompleteApi.md#GetRulesAC) | **Get** /v1/autocomplete/rules | Returns all rules of the user returned in a basic auto-complete array.
|
||||
[**GetTagAC**](AutocompleteApi.md#GetTagAC) | **Get** /v1/autocomplete/tags | Returns all tags of the user returned in a basic auto-complete array.
|
||||
[**GetTransactionTypesAC**](AutocompleteApi.md#GetTransactionTypesAC) | **Get** /v1/autocomplete/transaction-types | Returns all transaction types returned in a basic auto-complete array. English only.
|
||||
[**GetTransactionsAC**](AutocompleteApi.md#GetTransactionsAC) | **Get** /v1/autocomplete/transactions | Returns all transaction descriptions of the user returned in a basic auto-complete array.
|
||||
[**GetTransactionsIDAC**](AutocompleteApi.md#GetTransactionsIDAC) | **Get** /v1/autocomplete/transactions-with-id | Returns all transactions, complemented with their ID, of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
|
||||
|
||||
# **GetAccountsAC**
|
||||
> []AutocompleteAccount GetAccountsAC(ctx, optional)
|
||||
Returns all accounts of the user returned in a basic auto-complete array.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetAccountsACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetAccountsACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
**date** | **optional.String**| If the account is an asset account or a liability, the autocomplete will also return the balance of the account on this date. |
|
||||
**types** | [**optional.Interface of []AccountTypeFilter**](AccountTypeFilter.md)| Optional filter on the account type(s) used in the autocomplete. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteAccount**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetBillsAC**
|
||||
> []AutocompleteBill GetBillsAC(ctx, optional)
|
||||
Returns all bills of the user returned in a basic auto-complete array.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetBillsACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetBillsACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteBill**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetBudgetsAC**
|
||||
> []AutocompleteBudget GetBudgetsAC(ctx, optional)
|
||||
Returns all budgets of the user returned in a basic auto-complete array.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetBudgetsACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetBudgetsACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteBudget**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetCategoriesAC**
|
||||
> []AutocompleteCategory GetCategoriesAC(ctx, optional)
|
||||
Returns all categories of the user returned in a basic auto-complete array.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetCategoriesACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetCategoriesACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteCategory**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetCurrenciesAC**
|
||||
> []AutocompleteCurrency GetCurrenciesAC(ctx, optional)
|
||||
Returns all currencies of the user returned in a basic auto-complete array.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetCurrenciesACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetCurrenciesACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteCurrency**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetCurrenciesCodeAC**
|
||||
> []AutocompleteCurrencyCode GetCurrenciesCodeAC(ctx, optional)
|
||||
Returns all currencies of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetCurrenciesCodeACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetCurrenciesCodeACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteCurrencyCode**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetObjectGroupsAC**
|
||||
> []AutocompleteObjectGroup GetObjectGroupsAC(ctx, optional)
|
||||
Returns all object groups of the user returned in a basic auto-complete array.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetObjectGroupsACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetObjectGroupsACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteObjectGroup**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetPiggiesAC**
|
||||
> []AutocompletePiggy GetPiggiesAC(ctx, optional)
|
||||
Returns all piggy banks of the user returned in a basic auto-complete array.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetPiggiesACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetPiggiesACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompletePiggy**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetPiggiesBalanceAC**
|
||||
> []AutocompletePiggyBalance GetPiggiesBalanceAC(ctx, optional)
|
||||
Returns all piggy banks of the user returned in a basic auto-complete array complemented with balance information.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetPiggiesBalanceACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetPiggiesBalanceACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompletePiggyBalance**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetRecurringAC**
|
||||
> []AutocompleteRecurrence GetRecurringAC(ctx, optional)
|
||||
Returns all recurring transactions of the user returned in a basic auto-complete array.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetRecurringACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetRecurringACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteRecurrence**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetRuleGroupsAC**
|
||||
> []AutocompleteRuleGroup GetRuleGroupsAC(ctx, optional)
|
||||
Returns all rule groups of the user returned in a basic auto-complete array.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetRuleGroupsACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetRuleGroupsACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteRuleGroup**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetRulesAC**
|
||||
> []AutocompleteRule GetRulesAC(ctx, optional)
|
||||
Returns all rules of the user returned in a basic auto-complete array.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetRulesACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetRulesACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteRule**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetTagAC**
|
||||
> []AutocompleteTag GetTagAC(ctx, optional)
|
||||
Returns all tags of the user returned in a basic auto-complete array.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetTagACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetTagACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteTag**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetTransactionTypesAC**
|
||||
> []AutocompleteTransactionType GetTransactionTypesAC(ctx, optional)
|
||||
Returns all transaction types returned in a basic auto-complete array. English only.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetTransactionTypesACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetTransactionTypesACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteTransactionType**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetTransactionsAC**
|
||||
> []AutocompleteTransaction GetTransactionsAC(ctx, optional)
|
||||
Returns all transaction descriptions of the user returned in a basic auto-complete array.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetTransactionsACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetTransactionsACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteTransaction**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
# **GetTransactionsIDAC**
|
||||
> []AutocompleteTransactionId GetTransactionsIDAC(ctx, optional)
|
||||
Returns all transactions, complemented with their ID, of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***AutocompleteApiGetTransactionsIDACOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a AutocompleteApiGetTransactionsIDACOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**query** | **optional.String**| The autocomplete search query. |
|
||||
**limit** | **optional.Int32**| The number of items returned. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]AutocompleteTransactionId**](array.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
|
||||
|
||||
[[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)
|
||||
|
||||
11
docs/AutocompleteBill.md
Normal file
11
docs/AutocompleteBill.md
Normal file
@ -0,0 +1,11 @@
|
||||
# AutocompleteBill
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Name** | **string** | Name of the bill found by an auto-complete search. | [default to null]
|
||||
**Active** | **bool** | Is the bill active or not? | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
10
docs/AutocompleteBudget.md
Normal file
10
docs/AutocompleteBudget.md
Normal file
@ -0,0 +1,10 @@
|
||||
# AutocompleteBudget
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Name** | **string** | Name of the budget found by an auto-complete search. | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
10
docs/AutocompleteCategory.md
Normal file
10
docs/AutocompleteCategory.md
Normal file
@ -0,0 +1,10 @@
|
||||
# AutocompleteCategory
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Name** | **string** | Name of the category found by an auto-complete search. | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
13
docs/AutocompleteCurrency.md
Normal file
13
docs/AutocompleteCurrency.md
Normal file
@ -0,0 +1,13 @@
|
||||
# AutocompleteCurrency
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Name** | **string** | Currency name. | [default to null]
|
||||
**Code** | **string** | Currency code. | [default to null]
|
||||
**Symbol** | **string** | | [default to null]
|
||||
**DecimalPlaces** | **int32** | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
13
docs/AutocompleteCurrencyCode.md
Normal file
13
docs/AutocompleteCurrencyCode.md
Normal file
@ -0,0 +1,13 @@
|
||||
# AutocompleteCurrencyCode
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Name** | **string** | Currency name with the code between brackets. | [default to null]
|
||||
**Code** | **string** | Currency code. | [default to null]
|
||||
**Symbol** | **string** | | [default to null]
|
||||
**DecimalPlaces** | **int32** | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
11
docs/AutocompleteObjectGroup.md
Normal file
11
docs/AutocompleteObjectGroup.md
Normal file
@ -0,0 +1,11 @@
|
||||
# AutocompleteObjectGroup
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Title** | **string** | Title of the object group found by an auto-complete search. | [default to null]
|
||||
**Name** | **string** | Title of the object group found by an auto-complete search. | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
17
docs/AutocompletePiggy.md
Normal file
17
docs/AutocompletePiggy.md
Normal file
@ -0,0 +1,17 @@
|
||||
# AutocompletePiggy
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Name** | **string** | Name of the piggy bank found by an auto-complete search. | [default to null]
|
||||
**CurrencyId** | **string** | Currency ID for this piggy bank. | [optional] [default to null]
|
||||
**CurrencyCode** | **string** | Currency code for this piggy bank. | [optional] [default to null]
|
||||
**CurrencySymbol** | **string** | | [optional] [default to null]
|
||||
**CurrencyName** | **string** | Currency name for the currency used by this account. | [optional] [default to null]
|
||||
**CurrencyDecimalPlaces** | **int32** | | [optional] [default to null]
|
||||
**ObjectGroupId** | **string** | The group ID of the group this object is part of. NULL if no group. | [optional] [default to null]
|
||||
**ObjectGroupTitle** | **string** | The name of the group. NULL if no group. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
17
docs/AutocompletePiggyBalance.md
Normal file
17
docs/AutocompletePiggyBalance.md
Normal file
@ -0,0 +1,17 @@
|
||||
# AutocompletePiggyBalance
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Name** | **string** | Name of the piggy bank found by an auto-complete search. | [default to null]
|
||||
**NameWithBalance** | **string** | Name of the piggy bank found by an auto-complete search with the current balance formatted nicely. | [optional] [default to null]
|
||||
**CurrencyId** | **string** | Currency ID for this piggy bank. | [optional] [default to null]
|
||||
**CurrencyCode** | **string** | Currency code for this piggy bank. | [optional] [default to null]
|
||||
**CurrencySymbol** | **string** | | [optional] [default to null]
|
||||
**CurrencyDecimalPlaces** | **int32** | | [optional] [default to null]
|
||||
**ObjectGroupId** | **string** | The group ID of the group this object is part of. NULL if no group. | [optional] [default to null]
|
||||
**ObjectGroupTitle** | **string** | The name of the group. NULL if no group. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
11
docs/AutocompleteRecurrence.md
Normal file
11
docs/AutocompleteRecurrence.md
Normal file
@ -0,0 +1,11 @@
|
||||
# AutocompleteRecurrence
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Name** | **string** | Name of the recurrence found by an auto-complete search. | [default to null]
|
||||
**Description** | **string** | Description of the recurrence found by auto-complete. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
11
docs/AutocompleteRule.md
Normal file
11
docs/AutocompleteRule.md
Normal file
@ -0,0 +1,11 @@
|
||||
# AutocompleteRule
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Name** | **string** | Name of the rule found by an auto-complete search. | [default to null]
|
||||
**Description** | **string** | Description of the rule found by auto-complete. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
11
docs/AutocompleteRuleGroup.md
Normal file
11
docs/AutocompleteRuleGroup.md
Normal file
@ -0,0 +1,11 @@
|
||||
# AutocompleteRuleGroup
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Name** | **string** | Name of the rule group found by an auto-complete search. | [default to null]
|
||||
**Description** | **string** | Description of the rule group found by auto-complete. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
11
docs/AutocompleteTag.md
Normal file
11
docs/AutocompleteTag.md
Normal file
@ -0,0 +1,11 @@
|
||||
# AutocompleteTag
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Name** | **string** | Name of the tag found by an auto-complete search. | [default to null]
|
||||
**Tag** | **string** | Name of the tag found by an auto-complete search. | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
12
docs/AutocompleteTransaction.md
Normal file
12
docs/AutocompleteTransaction.md
Normal file
@ -0,0 +1,12 @@
|
||||
# AutocompleteTransaction
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | The ID of a transaction journal (basically a single split). | [default to null]
|
||||
**TransactionGroupId** | **string** | The ID of the underlying transaction group. | [optional] [default to null]
|
||||
**Name** | **string** | Transaction description | [default to null]
|
||||
**Description** | **string** | Transaction description | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
12
docs/AutocompleteTransactionId.md
Normal file
12
docs/AutocompleteTransactionId.md
Normal file
@ -0,0 +1,12 @@
|
||||
# AutocompleteTransactionId
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | The ID of a transaction journal (basically a single split). | [default to null]
|
||||
**TransactionGroupId** | **string** | The ID of the underlying transaction group. | [optional] [default to null]
|
||||
**Name** | **string** | Transaction description with ID in the name. | [default to null]
|
||||
**Description** | **string** | Transaction description with ID in the name. | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
11
docs/AutocompleteTransactionType.md
Normal file
11
docs/AutocompleteTransactionType.md
Normal file
@ -0,0 +1,11 @@
|
||||
# AutocompleteTransactionType
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [default to null]
|
||||
**Name** | **string** | Type of the object found by an auto-complete search. | [default to null]
|
||||
**Type_** | **string** | Name of the object found by an auto-complete search. | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
19
docs/AvailableBudget.md
Normal file
19
docs/AvailableBudget.md
Normal file
@ -0,0 +1,19 @@
|
||||
# AvailableBudget
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CreatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**UpdatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**CurrencyId** | **string** | Use either currency_id or currency_code. | [optional] [default to null]
|
||||
**CurrencyCode** | **string** | Use either currency_id or currency_code. | [optional] [default to null]
|
||||
**CurrencySymbol** | **string** | | [optional] [default to null]
|
||||
**CurrencyDecimalPlaces** | **int32** | | [optional] [default to null]
|
||||
**Amount** | **string** | | [default to null]
|
||||
**Start** | [**time.Time**](time.Time.md) | Start date of the available budget. | [default to null]
|
||||
**End** | [**time.Time**](time.Time.md) | End date of the available budget. | [default to null]
|
||||
**SpentInBudgets** | [**[]BudgetSpent**](BudgetSpent.md) | | [optional] [default to null]
|
||||
**SpentOutsideBudget** | [**[]BudgetSpent**](BudgetSpent.md) | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
10
docs/AvailableBudgetArray.md
Normal file
10
docs/AvailableBudgetArray.md
Normal file
@ -0,0 +1,10 @@
|
||||
# AvailableBudgetArray
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Data** | [**[]AvailableBudgetRead**](AvailableBudgetRead.md) | | [default to null]
|
||||
**Meta** | [***Meta**](Meta.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
11
docs/AvailableBudgetRead.md
Normal file
11
docs/AvailableBudgetRead.md
Normal file
@ -0,0 +1,11 @@
|
||||
# AvailableBudgetRead
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type_** | **string** | Immutable value | [default to null]
|
||||
**Id** | **string** | | [default to null]
|
||||
**Attributes** | [***AvailableBudget**](AvailableBudget.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
9
docs/AvailableBudgetSingle.md
Normal file
9
docs/AvailableBudgetSingle.md
Normal file
@ -0,0 +1,9 @@
|
||||
# AvailableBudgetSingle
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Data** | [***AvailableBudgetRead**](AvailableBudgetRead.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
83
docs/AvailableBudgetsApi.md
Normal file
83
docs/AvailableBudgetsApi.md
Normal file
@ -0,0 +1,83 @@
|
||||
# {{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)
|
||||
|
||||
10
docs/BadRequestResponse.md
Normal file
10
docs/BadRequestResponse.md
Normal file
@ -0,0 +1,10 @@
|
||||
# BadRequestResponse
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Message** | **string** | | [optional] [default to null]
|
||||
**Exception** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
18
docs/BasicSummaryEntry.md
Normal file
18
docs/BasicSummaryEntry.md
Normal file
@ -0,0 +1,18 @@
|
||||
# BasicSummaryEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Key** | **string** | This is a reference to the type of info shared, not influenced by translations or user preferences. The EUR value is a reference to the currency code. Possibilities are: balance-in-ABC, spent-in-ABC, earned-in-ABC, bills-paid-in-ABC, bills-unpaid-in-ABC, left-to-spend-in-ABC and net-worth-in-ABC. | [optional] [default to null]
|
||||
**Title** | **string** | A translated title for the information shared. | [optional] [default to null]
|
||||
**MonetaryValue** | **float64** | The amount as a float. | [optional] [default to null]
|
||||
**CurrencyId** | **string** | The currency ID of the associated currency. | [optional] [default to null]
|
||||
**CurrencyCode** | **string** | | [optional] [default to null]
|
||||
**CurrencySymbol** | **string** | | [optional] [default to null]
|
||||
**CurrencyDecimalPlaces** | **int32** | Number of decimals for the associated currency. | [optional] [default to null]
|
||||
**ValueParsed** | **string** | The amount formatted according to the users locale | [optional] [default to null]
|
||||
**LocalIcon** | **string** | Reference to a font-awesome icon without the fa- part. | [optional] [default to null]
|
||||
**SubTitle** | **string** | A short explanation of the amounts origin. Already formatted according to the locale of the user or translated, if relevant. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
32
docs/Bill.md
Normal file
32
docs/Bill.md
Normal file
@ -0,0 +1,32 @@
|
||||
# Bill
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CreatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**UpdatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**CurrencyId** | **string** | Use either currency_id or currency_code | [optional] [default to null]
|
||||
**CurrencyCode** | **string** | Use either currency_id or currency_code | [optional] [default to null]
|
||||
**CurrencySymbol** | **string** | | [optional] [default to null]
|
||||
**CurrencyDecimalPlaces** | **int32** | | [optional] [default to null]
|
||||
**Name** | **string** | | [default to null]
|
||||
**AmountMin** | **string** | | [default to null]
|
||||
**AmountMax** | **string** | | [default to null]
|
||||
**Date** | [**time.Time**](time.Time.md) | | [default to null]
|
||||
**EndDate** | [**time.Time**](time.Time.md) | The date after which this bill is no longer valid or applicable | [optional] [default to null]
|
||||
**ExtensionDate** | [**time.Time**](time.Time.md) | The date before which the bill must be renewed (or cancelled) | [optional] [default to null]
|
||||
**RepeatFreq** | [***BillRepeatFrequency**](BillRepeatFrequency.md) | | [default to null]
|
||||
**Skip** | **int32** | How often the bill must be skipped. 1 means a bi-monthly bill. | [optional] [default to null]
|
||||
**Active** | **bool** | If the bill is active. | [optional] [default to null]
|
||||
**Order** | **int32** | Order of the bill. | [optional] [default to null]
|
||||
**Notes** | **string** | | [optional] [default to null]
|
||||
**NextExpectedMatch** | [**time.Time**](time.Time.md) | When the bill is expected to be due. | [optional] [default to null]
|
||||
**NextExpectedMatchDiff** | **string** | Formatted (locally) when the bill is due. | [optional] [default to null]
|
||||
**ObjectGroupId** | **string** | The group ID of the group this object is part of. NULL if no group. | [optional] [default to null]
|
||||
**ObjectGroupOrder** | **int32** | The order of the group. At least 1, for the highest sorting. | [optional] [default to null]
|
||||
**ObjectGroupTitle** | **string** | The name of the group. NULL if no group. | [optional] [default to null]
|
||||
**PayDates** | [**[]time.Time**](time.Time.md) | Array of future dates when the bill is expected to be paid. Autogenerated. | [optional] [default to null]
|
||||
**PaidDates** | [**[]BillPaidDates**](Bill_paid_dates.md) | Array of past transactions when the bill was paid. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
10
docs/BillArray.md
Normal file
10
docs/BillArray.md
Normal file
@ -0,0 +1,10 @@
|
||||
# BillArray
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Data** | [**[]BillRead**](BillRead.md) | | [default to null]
|
||||
**Meta** | [***Meta**](Meta.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
11
docs/BillPaidDates.md
Normal file
11
docs/BillPaidDates.md
Normal file
@ -0,0 +1,11 @@
|
||||
# BillPaidDates
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**TransactionGroupId** | **string** | Transaction group ID of the paid bill. | [optional] [default to null]
|
||||
**TransactionJournalId** | **string** | Transaction journal ID of the paid bill. | [optional] [default to null]
|
||||
**Date** | [**time.Time**](time.Time.md) | Date the bill was paid. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
11
docs/BillRead.md
Normal file
11
docs/BillRead.md
Normal file
@ -0,0 +1,11 @@
|
||||
# BillRead
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type_** | **string** | Immutable value | [default to null]
|
||||
**Id** | **string** | | [default to null]
|
||||
**Attributes** | [***Bill**](Bill.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
8
docs/BillRepeatFrequency.md
Normal file
8
docs/BillRepeatFrequency.md
Normal file
@ -0,0 +1,8 @@
|
||||
# BillRepeatFrequency
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
9
docs/BillSingle.md
Normal file
9
docs/BillSingle.md
Normal file
@ -0,0 +1,9 @@
|
||||
# BillSingle
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Data** | [***BillRead**](BillRead.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
22
docs/BillStore.md
Normal file
22
docs/BillStore.md
Normal file
@ -0,0 +1,22 @@
|
||||
# BillStore
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CurrencyId** | **string** | Use either currency_id or currency_code | [optional] [default to null]
|
||||
**CurrencyCode** | **string** | Use either currency_id or currency_code | [optional] [default to null]
|
||||
**Name** | **string** | | [default to null]
|
||||
**AmountMin** | **string** | | [default to null]
|
||||
**AmountMax** | **string** | | [default to null]
|
||||
**Date** | [**time.Time**](time.Time.md) | | [default to null]
|
||||
**EndDate** | [**time.Time**](time.Time.md) | The date after which this bill is no longer valid or applicable | [optional] [default to null]
|
||||
**ExtensionDate** | [**time.Time**](time.Time.md) | The date before which the bill must be renewed (or cancelled) | [optional] [default to null]
|
||||
**RepeatFreq** | [***BillRepeatFrequency**](BillRepeatFrequency.md) | | [default to null]
|
||||
**Skip** | **int32** | How often the bill must be skipped. 1 means a bi-monthly bill. | [optional] [default to null]
|
||||
**Active** | **bool** | If the bill is active. | [optional] [default to null]
|
||||
**Notes** | **string** | | [optional] [default to null]
|
||||
**ObjectGroupId** | **string** | The group ID of the group this object is part of. NULL if no group. | [optional] [default to null]
|
||||
**ObjectGroupTitle** | **string** | The name of the group. NULL if no group. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
22
docs/BillUpdate.md
Normal file
22
docs/BillUpdate.md
Normal file
@ -0,0 +1,22 @@
|
||||
# BillUpdate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CurrencyId** | **string** | Use either currency_id or currency_code | [optional] [default to null]
|
||||
**CurrencyCode** | **string** | Use either currency_id or currency_code | [optional] [default to null]
|
||||
**Name** | **string** | | [default to null]
|
||||
**AmountMin** | **string** | | [optional] [default to null]
|
||||
**AmountMax** | **string** | | [optional] [default to null]
|
||||
**Date** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**EndDate** | [**time.Time**](time.Time.md) | The date after which this bill is no longer valid or applicable | [optional] [default to null]
|
||||
**ExtensionDate** | [**time.Time**](time.Time.md) | The date before which the bill must be renewed (or cancelled) | [optional] [default to null]
|
||||
**RepeatFreq** | [***BillRepeatFrequency**](BillRepeatFrequency.md) | | [optional] [default to null]
|
||||
**Skip** | **int32** | How often the bill must be skipped. 1 means a bi-monthly bill. | [optional] [default to null]
|
||||
**Active** | **bool** | If the bill is active. | [optional] [default to null]
|
||||
**Notes** | **string** | | [optional] [default to null]
|
||||
**ObjectGroupId** | **string** | The group ID of the group this object is part of. NULL if no group. | [optional] [default to null]
|
||||
**ObjectGroupTitle** | **string** | The name of the group. NULL if no group. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
370
docs/BillsApi.md
Normal file
370
docs/BillsApi.md
Normal file
@ -0,0 +1,370 @@
|
||||
# {{classname}}
|
||||
|
||||
All URIs are relative to *https://demo.firefly-iii.org/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**DeleteBill**](BillsApi.md#DeleteBill) | **Delete** /v1/bills/{id} | Delete a bill.
|
||||
[**GetBill**](BillsApi.md#GetBill) | **Get** /v1/bills/{id} | Get a single bill.
|
||||
[**ListAttachmentByBill**](BillsApi.md#ListAttachmentByBill) | **Get** /v1/bills/{id}/attachments | List all attachments uploaded to the bill.
|
||||
[**ListBill**](BillsApi.md#ListBill) | **Get** /v1/bills | List all bills.
|
||||
[**ListRuleByBill**](BillsApi.md#ListRuleByBill) | **Get** /v1/bills/{id}/rules | List all rules associated with the bill.
|
||||
[**ListTransactionByBill**](BillsApi.md#ListTransactionByBill) | **Get** /v1/bills/{id}/transactions | List all transactions associated with the bill.
|
||||
[**StoreBill**](BillsApi.md#StoreBill) | **Post** /v1/bills | Store a new bill
|
||||
[**UpdateBill**](BillsApi.md#UpdateBill) | **Put** /v1/bills/{id} | Update existing bill.
|
||||
|
||||
# **DeleteBill**
|
||||
> DeleteBill(ctx, id, optional)
|
||||
Delete a bill.
|
||||
|
||||
Delete a bill. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the bill. |
|
||||
**optional** | ***BillsApiDeleteBillOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BillsApiDeleteBillOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| 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)
|
||||
|
||||
# **GetBill**
|
||||
> BillSingle GetBill(ctx, id, optional)
|
||||
Get a single bill.
|
||||
|
||||
Get a single bill.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the bill. |
|
||||
**optional** | ***BillsApiGetBillOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BillsApiGetBillOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**start** | **optional.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** | **optional.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
|
||||
|
||||
[**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)
|
||||
|
||||
# **ListAttachmentByBill**
|
||||
> AttachmentArray ListAttachmentByBill(ctx, id, optional)
|
||||
List all attachments uploaded to the bill.
|
||||
|
||||
This endpoint will list all attachments linked to the bill.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the bill. |
|
||||
**optional** | ***BillsApiListAttachmentByBillOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BillsApiListAttachmentByBillOpts 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. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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)
|
||||
|
||||
# **ListBill**
|
||||
> BillArray ListBill(ctx, optional)
|
||||
List all bills.
|
||||
|
||||
This endpoint will list all the user's bills.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***BillsApiListBillOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BillsApiListBillOpts 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. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates. |
|
||||
**end** | **optional.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
|
||||
|
||||
[**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)
|
||||
|
||||
# **ListRuleByBill**
|
||||
> RuleArray ListRuleByBill(ctx, id, optional)
|
||||
List all rules associated with the bill.
|
||||
|
||||
This endpoint will list all rules that have an action to set the bill to this bill.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the bill. |
|
||||
**optional** | ***BillsApiListRuleByBillOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BillsApiListRuleByBillOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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)
|
||||
|
||||
# **ListTransactionByBill**
|
||||
> TransactionArray ListTransactionByBill(ctx, id, optional)
|
||||
List all transactions associated with the bill.
|
||||
|
||||
This endpoint will list all transactions linked to this bill.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the bill. |
|
||||
**optional** | ***BillsApiListTransactionByBillOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BillsApiListTransactionByBillOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**start** | **optional.String**| A date formatted YYYY-MM-DD. |
|
||||
**end** | **optional.String**| A date formatted YYYY-MM-DD. |
|
||||
**type_** | [**optional.Interface of TransactionTypeFilter**](.md)| Optional filter on the transaction type(s) returned |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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)
|
||||
|
||||
# **StoreBill**
|
||||
> BillSingle StoreBill(ctx, body, currencyId, currencyCode, name, amountMin, amountMax, date, endDate, extensionDate, repeatFreq, skip, active, notes, objectGroupId, objectGroupTitle, optional)
|
||||
Store a new bill
|
||||
|
||||
Creates a new bill. The data required can be submitted as a JSON body or as a list of parameters.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**BillStore**](BillStore.md)| JSON array or key=value pairs with the necessary bill information. See the model for the exact specifications. |
|
||||
**currencyId** | **string**| |
|
||||
**currencyCode** | **string**| |
|
||||
**name** | **string**| |
|
||||
**amountMin** | **string**| |
|
||||
**amountMax** | **string**| |
|
||||
**date** | **time.Time**| |
|
||||
**endDate** | **time.Time**| |
|
||||
**extensionDate** | **time.Time**| |
|
||||
**repeatFreq** | [**BillRepeatFrequency**](.md)| |
|
||||
**skip** | **int32**| |
|
||||
**active** | **bool**| |
|
||||
**notes** | **string**| |
|
||||
**objectGroupId** | **string**| |
|
||||
**objectGroupTitle** | **string**| |
|
||||
**optional** | ***BillsApiStoreBillOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BillsApiStoreBillOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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)
|
||||
|
||||
# **UpdateBill**
|
||||
> BillSingle UpdateBill(ctx, body, currencyId, currencyCode, name, amountMin, amountMax, date, endDate, extensionDate, repeatFreq, skip, active, notes, objectGroupId, objectGroupTitle, id, optional)
|
||||
Update existing bill.
|
||||
|
||||
Update existing bill.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**BillUpdate**](BillUpdate.md)| JSON array or key=value pairs with updated bill information. See the model for the exact specifications. |
|
||||
**currencyId** | **string**| |
|
||||
**currencyCode** | **string**| |
|
||||
**name** | **string**| |
|
||||
**amountMin** | **string**| |
|
||||
**amountMax** | **string**| |
|
||||
**date** | **time.Time**| |
|
||||
**endDate** | **time.Time**| |
|
||||
**extensionDate** | **time.Time**| |
|
||||
**repeatFreq** | [**BillRepeatFrequency**](.md)| |
|
||||
**skip** | **int32**| |
|
||||
**active** | **bool**| |
|
||||
**notes** | **string**| |
|
||||
**objectGroupId** | **string**| |
|
||||
**objectGroupTitle** | **string**| |
|
||||
**id** | **string**| The ID of the bill. |
|
||||
**optional** | ***BillsApiUpdateBillOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BillsApiUpdateBillOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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)
|
||||
|
||||
20
docs/Budget.md
Normal file
20
docs/Budget.md
Normal file
@ -0,0 +1,20 @@
|
||||
# Budget
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CreatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**UpdatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**Name** | **string** | | [default to null]
|
||||
**Active** | **bool** | | [optional] [default to null]
|
||||
**Notes** | **string** | | [optional] [default to null]
|
||||
**Order** | **int32** | | [optional] [default to null]
|
||||
**AutoBudgetType** | [***AutoBudgetType**](AutoBudgetType.md) | | [optional] [default to null]
|
||||
**AutoBudgetCurrencyId** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**AutoBudgetCurrencyCode** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**AutoBudgetAmount** | **string** | | [optional] [default to null]
|
||||
**AutoBudgetPeriod** | [***AutoBudgetPeriod**](AutoBudgetPeriod.md) | | [optional] [default to null]
|
||||
**Spent** | [**[]BudgetSpent**](BudgetSpent.md) | Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
10
docs/BudgetArray.md
Normal file
10
docs/BudgetArray.md
Normal file
@ -0,0 +1,10 @@
|
||||
# BudgetArray
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Data** | [**[]BudgetRead**](BudgetRead.md) | | [default to null]
|
||||
**Meta** | [***Meta**](Meta.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
21
docs/BudgetLimit.md
Normal file
21
docs/BudgetLimit.md
Normal file
@ -0,0 +1,21 @@
|
||||
# BudgetLimit
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CreatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**UpdatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**Start** | [**time.Time**](time.Time.md) | Start date of the budget limit. | [default to null]
|
||||
**End** | [**time.Time**](time.Time.md) | End date of the budget limit. | [default to null]
|
||||
**CurrencyId** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**CurrencyCode** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**CurrencyName** | **string** | | [optional] [default to null]
|
||||
**CurrencySymbol** | **string** | | [optional] [default to null]
|
||||
**CurrencyDecimalPlaces** | **int32** | | [optional] [default to null]
|
||||
**BudgetId** | **string** | The budget ID of the associated budget. | [default to null]
|
||||
**Period** | **string** | Period of the budget limit. Only used when auto-generated by auto-budget. | [optional] [default to null]
|
||||
**Amount** | **string** | | [default to null]
|
||||
**Spent** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
10
docs/BudgetLimitArray.md
Normal file
10
docs/BudgetLimitArray.md
Normal file
@ -0,0 +1,10 @@
|
||||
# BudgetLimitArray
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Data** | [**[]BudgetLimitRead**](BudgetLimitRead.md) | | [default to null]
|
||||
**Meta** | [***Meta**](Meta.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
11
docs/BudgetLimitRead.md
Normal file
11
docs/BudgetLimitRead.md
Normal file
@ -0,0 +1,11 @@
|
||||
# BudgetLimitRead
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type_** | **string** | Immutable value | [default to null]
|
||||
**Id** | **string** | | [default to null]
|
||||
**Attributes** | [***BudgetLimit**](BudgetLimit.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
9
docs/BudgetLimitSingle.md
Normal file
9
docs/BudgetLimitSingle.md
Normal file
@ -0,0 +1,9 @@
|
||||
# BudgetLimitSingle
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Data** | [***BudgetLimitRead**](BudgetLimitRead.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
15
docs/BudgetLimitStore.md
Normal file
15
docs/BudgetLimitStore.md
Normal file
@ -0,0 +1,15 @@
|
||||
# BudgetLimitStore
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CurrencyId** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**CurrencyCode** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**BudgetId** | **string** | The budget ID of the associated budget. | [default to null]
|
||||
**Start** | **string** | Start date of the budget limit. | [default to null]
|
||||
**Period** | **string** | Period of the budget limit. Only used when auto-generated by auto-budget. | [optional] [default to null]
|
||||
**End** | **string** | End date of the budget limit. | [default to null]
|
||||
**Amount** | **string** | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
11
docs/BudgetRead.md
Normal file
11
docs/BudgetRead.md
Normal file
@ -0,0 +1,11 @@
|
||||
# BudgetRead
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type_** | **string** | Immutable value | [default to null]
|
||||
**Id** | **string** | | [default to null]
|
||||
**Attributes** | [***Budget**](Budget.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
9
docs/BudgetSingle.md
Normal file
9
docs/BudgetSingle.md
Normal file
@ -0,0 +1,9 @@
|
||||
# BudgetSingle
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Data** | [***BudgetRead**](BudgetRead.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
13
docs/BudgetSpent.md
Normal file
13
docs/BudgetSpent.md
Normal file
@ -0,0 +1,13 @@
|
||||
# BudgetSpent
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Sum** | **string** | The amount spent. | [optional] [default to null]
|
||||
**CurrencyId** | **string** | | [optional] [default to null]
|
||||
**CurrencyCode** | **string** | | [optional] [default to null]
|
||||
**CurrencySymbol** | **string** | | [optional] [default to null]
|
||||
**CurrencyDecimalPlaces** | **int32** | Number of decimals supported by the currency | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
17
docs/BudgetStore.md
Normal file
17
docs/BudgetStore.md
Normal file
@ -0,0 +1,17 @@
|
||||
# BudgetStore
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **string** | | [default to null]
|
||||
**Active** | **bool** | | [optional] [default to null]
|
||||
**Order** | **int32** | | [optional] [default to null]
|
||||
**Notes** | **string** | | [optional] [default to null]
|
||||
**AutoBudgetType** | [***AutoBudgetType**](AutoBudgetType.md) | | [optional] [default to null]
|
||||
**AutoBudgetCurrencyId** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**AutoBudgetCurrencyCode** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**AutoBudgetAmount** | **string** | | [optional] [default to null]
|
||||
**AutoBudgetPeriod** | [***AutoBudgetPeriod**](AutoBudgetPeriod.md) | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
17
docs/BudgetUpdate.md
Normal file
17
docs/BudgetUpdate.md
Normal file
@ -0,0 +1,17 @@
|
||||
# BudgetUpdate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **string** | | [default to null]
|
||||
**Active** | **bool** | | [optional] [default to null]
|
||||
**Order** | **int32** | | [optional] [default to null]
|
||||
**Notes** | **string** | | [optional] [default to null]
|
||||
**AutoBudgetType** | [***AutoBudgetType**](AutoBudgetType.md) | | [optional] [default to null]
|
||||
**AutoBudgetCurrencyId** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**AutoBudgetCurrencyCode** | **string** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional] [default to null]
|
||||
**AutoBudgetAmount** | **string** | | [optional] [default to null]
|
||||
**AutoBudgetPeriod** | [***AutoBudgetPeriod**](AutoBudgetPeriod.md) | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
631
docs/BudgetsApi.md
Normal file
631
docs/BudgetsApi.md
Normal file
@ -0,0 +1,631 @@
|
||||
# {{classname}}
|
||||
|
||||
All URIs are relative to *https://demo.firefly-iii.org/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**DeleteBudget**](BudgetsApi.md#DeleteBudget) | **Delete** /v1/budgets/{id} | Delete a budget.
|
||||
[**DeleteBudgetLimit**](BudgetsApi.md#DeleteBudgetLimit) | **Delete** /v1/budgets/{id}/limits/{limitId} | Delete a budget limit.
|
||||
[**GetBudget**](BudgetsApi.md#GetBudget) | **Get** /v1/budgets/{id} | Get a single budget.
|
||||
[**GetBudgetLimit**](BudgetsApi.md#GetBudgetLimit) | **Get** /v1/budgets/{id}/limits/{limitId} | Get single budget limit.
|
||||
[**ListAttachmentByBudget**](BudgetsApi.md#ListAttachmentByBudget) | **Get** /v1/budgets/{id}/attachments | Lists all attachments of a budget.
|
||||
[**ListBudget**](BudgetsApi.md#ListBudget) | **Get** /v1/budgets | List all budgets.
|
||||
[**ListBudgetLimit**](BudgetsApi.md#ListBudgetLimit) | **Get** /v1/budget-limits | Get list of budget limits by date
|
||||
[**ListBudgetLimitByBudget**](BudgetsApi.md#ListBudgetLimitByBudget) | **Get** /v1/budgets/{id}/limits | Get all limits for a budget.
|
||||
[**ListTransactionByBudget**](BudgetsApi.md#ListTransactionByBudget) | **Get** /v1/budgets/{id}/transactions | All transactions to a budget.
|
||||
[**ListTransactionByBudgetLimit**](BudgetsApi.md#ListTransactionByBudgetLimit) | **Get** /v1/budgets/{id}/limits/{limitId}/transactions | List all transactions by a budget limit ID.
|
||||
[**StoreBudget**](BudgetsApi.md#StoreBudget) | **Post** /v1/budgets | Store a new budget
|
||||
[**StoreBudgetLimit**](BudgetsApi.md#StoreBudgetLimit) | **Post** /v1/budgets/{id}/limits | Store new budget limit.
|
||||
[**UpdateBudget**](BudgetsApi.md#UpdateBudget) | **Put** /v1/budgets/{id} | Update existing budget.
|
||||
[**UpdateBudgetLimit**](BudgetsApi.md#UpdateBudgetLimit) | **Put** /v1/budgets/{id}/limits/{limitId} | Update existing budget limit.
|
||||
|
||||
# **DeleteBudget**
|
||||
> DeleteBudget(ctx, id, optional)
|
||||
Delete a budget.
|
||||
|
||||
Delete a budget. Transactions will not be deleted.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the budget. |
|
||||
**optional** | ***BudgetsApiDeleteBudgetOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiDeleteBudgetOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| 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)
|
||||
|
||||
# **DeleteBudgetLimit**
|
||||
> DeleteBudgetLimit(ctx, id, limitId, optional)
|
||||
Delete a budget limit.
|
||||
|
||||
Delete a budget limit.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the budget. The budget limit MUST be associated to the budget ID. |
|
||||
**limitId** | **string**| The ID of the budget limit. The budget limit MUST be associated to the budget ID. |
|
||||
**optional** | ***BudgetsApiDeleteBudgetLimitOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiDeleteBudgetLimitOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| 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)
|
||||
|
||||
# **GetBudget**
|
||||
> BudgetSingle GetBudget(ctx, id, optional)
|
||||
Get a single budget.
|
||||
|
||||
Get a single budget. If the start date and end date are submitted as well, the \"spent\" array will be updated accordingly.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the requested budget. |
|
||||
**optional** | ***BudgetsApiGetBudgetOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiGetBudgetOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**start** | **optional.String**| A date formatted YYYY-MM-DD, to get info on how much the user has spent. |
|
||||
**end** | **optional.String**| A date formatted YYYY-MM-DD, to get info on how much the user has spent. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BudgetSingle**](BudgetSingle.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/vnd.api+json, 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)
|
||||
|
||||
# **GetBudgetLimit**
|
||||
> BudgetLimitSingle GetBudgetLimit(ctx, id, limitId, optional)
|
||||
Get single budget limit.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the budget. The budget limit MUST be associated to the budget ID. |
|
||||
**limitId** | **int32**| The ID of the budget limit. The budget limit MUST be associated to the budget ID. |
|
||||
**optional** | ***BudgetsApiGetBudgetLimitOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiGetBudgetLimitOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BudgetLimitSingle**](BudgetLimitSingle.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/vnd.api+json, 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)
|
||||
|
||||
# **ListAttachmentByBudget**
|
||||
> AttachmentArray ListAttachmentByBudget(ctx, id, optional)
|
||||
Lists all attachments of a budget.
|
||||
|
||||
Lists all attachments.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the budget. |
|
||||
**optional** | ***BudgetsApiListAttachmentByBudgetOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiListAttachmentByBudgetOpts 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. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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/vnd.api+json, 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)
|
||||
|
||||
# **ListBudget**
|
||||
> BudgetArray ListBudget(ctx, optional)
|
||||
List all budgets.
|
||||
|
||||
List all the budgets the user has made. If the start date and end date are submitted as well, the \"spent\" array will be updated accordingly.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***BudgetsApiListBudgetOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiListBudgetOpts 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, to get info on how much the user has spent. You must submit both start and end. |
|
||||
**end** | **optional.String**| A date formatted YYYY-MM-DD, to get info on how much the user has spent. You must submit both start and end. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BudgetArray**](BudgetArray.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/vnd.api+json, 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)
|
||||
|
||||
# **ListBudgetLimit**
|
||||
> BudgetLimitArray ListBudgetLimit(ctx, start, end, optional)
|
||||
Get list of budget limits by date
|
||||
|
||||
Get all budget limits for for this date range.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**start** | **string**| A date formatted YYYY-MM-DD. |
|
||||
**end** | **string**| A date formatted YYYY-MM-DD. |
|
||||
**optional** | ***BudgetsApiListBudgetLimitOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiListBudgetLimitOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BudgetLimitArray**](BudgetLimitArray.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/vnd.api+json, 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)
|
||||
|
||||
# **ListBudgetLimitByBudget**
|
||||
> BudgetLimitArray ListBudgetLimitByBudget(ctx, id, optional)
|
||||
Get all limits for a budget.
|
||||
|
||||
Get all budget limits for this budget and the money spent, and money left. You can limit the list by submitting a date range as well. The \"spent\" array for each budget limit is NOT influenced by the start and end date of your query, but by the start and end date of the budget limit itself.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the requested budget. |
|
||||
**optional** | ***BudgetsApiListBudgetLimitByBudgetOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiListBudgetLimitByBudgetOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**start** | **optional.String**| A date formatted YYYY-MM-DD. |
|
||||
**end** | **optional.String**| A date formatted YYYY-MM-DD. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BudgetLimitArray**](BudgetLimitArray.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/vnd.api+json, 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)
|
||||
|
||||
# **ListTransactionByBudget**
|
||||
> TransactionArray ListTransactionByBudget(ctx, id, optional)
|
||||
All transactions to a budget.
|
||||
|
||||
Get all transactions linked to a budget, possibly limited by start and end
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the budget. |
|
||||
**optional** | ***BudgetsApiListTransactionByBudgetOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiListTransactionByBudgetOpts 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. |
|
||||
**type_** | [**optional.Interface of TransactionTypeFilter**](.md)| Optional filter on the transaction type(s) returned |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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/vnd.api+json, 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)
|
||||
|
||||
# **ListTransactionByBudgetLimit**
|
||||
> TransactionArray ListTransactionByBudgetLimit(ctx, id, limitId, optional)
|
||||
List all transactions by a budget limit ID.
|
||||
|
||||
List all the transactions within one budget limit. The start and end date are dictated by the budget limit.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the budget. The budget limit MUST be associated to the budget ID. |
|
||||
**limitId** | **string**| The ID of the budget limit. The budget limit MUST be associated to the budget ID. |
|
||||
**optional** | ***BudgetsApiListTransactionByBudgetLimitOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiListTransactionByBudgetLimitOpts 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. |
|
||||
**type_** | [**optional.Interface of TransactionTypeFilter**](.md)| Optional filter on the transaction type(s) returned |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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/vnd.api+json, 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)
|
||||
|
||||
# **StoreBudget**
|
||||
> BudgetSingle StoreBudget(ctx, body, name, active, order, notes, autoBudgetType, autoBudgetCurrencyId, autoBudgetCurrencyCode, autoBudgetAmount, autoBudgetPeriod, optional)
|
||||
Store a new budget
|
||||
|
||||
Creates a new budget. The data required can be submitted as a JSON body or as a list of parameters.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**BudgetStore**](BudgetStore.md)| JSON array or key=value pairs with the necessary budget information. See the model for the exact specifications. |
|
||||
**name** | **string**| |
|
||||
**active** | **bool**| |
|
||||
**order** | **int32**| |
|
||||
**notes** | **string**| |
|
||||
**autoBudgetType** | [**AutoBudgetType**](.md)| |
|
||||
**autoBudgetCurrencyId** | **string**| |
|
||||
**autoBudgetCurrencyCode** | **string**| |
|
||||
**autoBudgetAmount** | **string**| |
|
||||
**autoBudgetPeriod** | [**AutoBudgetPeriod**](.md)| |
|
||||
**optional** | ***BudgetsApiStoreBudgetOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiStoreBudgetOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BudgetSingle**](BudgetSingle.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/vnd.api+json, 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)
|
||||
|
||||
# **StoreBudgetLimit**
|
||||
> BudgetLimitSingle StoreBudgetLimit(ctx, body, currencyId, currencyCode, budgetId, start, period, end, amount, id, optional)
|
||||
Store new budget limit.
|
||||
|
||||
Store a new budget limit under this budget.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**BudgetLimitStore**](BudgetLimitStore.md)| JSON array or key=value pairs with the necessary budget information. See the model for the exact specifications. |
|
||||
**currencyId** | **string**| |
|
||||
**currencyCode** | **string**| |
|
||||
**budgetId** | **string**| |
|
||||
**start** | **string**| |
|
||||
**period** | **string**| |
|
||||
**end** | **string**| |
|
||||
**amount** | **string**| |
|
||||
**id** | **string**| The ID of the budget. |
|
||||
**optional** | ***BudgetsApiStoreBudgetLimitOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiStoreBudgetLimitOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BudgetLimitSingle**](BudgetLimitSingle.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/vnd.api+json, 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)
|
||||
|
||||
# **UpdateBudget**
|
||||
> BudgetSingle UpdateBudget(ctx, body, name, active, order, notes, autoBudgetType, autoBudgetCurrencyId, autoBudgetCurrencyCode, autoBudgetAmount, autoBudgetPeriod, id, optional)
|
||||
Update existing budget.
|
||||
|
||||
Update existing budget. This endpoint cannot be used to set budget amount limits.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**BudgetUpdate**](BudgetUpdate.md)| JSON array with updated budget information. See the model for the exact specifications. |
|
||||
**name** | **string**| |
|
||||
**active** | **bool**| |
|
||||
**order** | **int32**| |
|
||||
**notes** | **string**| |
|
||||
**autoBudgetType** | [**AutoBudgetType**](.md)| |
|
||||
**autoBudgetCurrencyId** | **string**| |
|
||||
**autoBudgetCurrencyCode** | **string**| |
|
||||
**autoBudgetAmount** | **string**| |
|
||||
**autoBudgetPeriod** | [**AutoBudgetPeriod**](.md)| |
|
||||
**id** | **string**| The ID of the budget. |
|
||||
**optional** | ***BudgetsApiUpdateBudgetOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiUpdateBudgetOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BudgetSingle**](BudgetSingle.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/vnd.api+json, 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)
|
||||
|
||||
# **UpdateBudgetLimit**
|
||||
> BudgetLimitSingle UpdateBudgetLimit(ctx, body, createdAt, updatedAt, start, end, currencyId, currencyCode, currencyName, currencySymbol, currencyDecimalPlaces, budgetId, period, amount, spent, id, limitId, optional)
|
||||
Update existing budget limit.
|
||||
|
||||
Update existing budget limit.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**BudgetLimit**](BudgetLimit.md)| JSON array with updated budget limit information. See the model for the exact specifications. |
|
||||
**createdAt** | **time.Time**| |
|
||||
**updatedAt** | **time.Time**| |
|
||||
**start** | **time.Time**| |
|
||||
**end** | **time.Time**| |
|
||||
**currencyId** | **string**| |
|
||||
**currencyCode** | **string**| |
|
||||
**currencyName** | **string**| |
|
||||
**currencySymbol** | **string**| |
|
||||
**currencyDecimalPlaces** | **int32**| |
|
||||
**budgetId** | **string**| |
|
||||
**period** | **string**| |
|
||||
**amount** | **string**| |
|
||||
**spent** | **string**| |
|
||||
**id** | **string**| The ID of the budget. The budget limit MUST be associated to the budget ID. |
|
||||
**limitId** | **string**| The ID of the budget limit. The budget limit MUST be associated to the budget ID. |
|
||||
**optional** | ***BudgetsApiUpdateBudgetLimitOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a BudgetsApiUpdateBudgetLimitOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BudgetLimitSingle**](BudgetLimitSingle.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/vnd.api+json, 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)
|
||||
|
||||
293
docs/CategoriesApi.md
Normal file
293
docs/CategoriesApi.md
Normal file
@ -0,0 +1,293 @@
|
||||
# {{classname}}
|
||||
|
||||
All URIs are relative to *https://demo.firefly-iii.org/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**DeleteCategory**](CategoriesApi.md#DeleteCategory) | **Delete** /v1/categories/{id} | Delete a category.
|
||||
[**GetCategory**](CategoriesApi.md#GetCategory) | **Get** /v1/categories/{id} | Get a single category.
|
||||
[**ListAttachmentByCategory**](CategoriesApi.md#ListAttachmentByCategory) | **Get** /v1/categories/{id}/attachments | Lists all attachments.
|
||||
[**ListCategory**](CategoriesApi.md#ListCategory) | **Get** /v1/categories | List all categories.
|
||||
[**ListTransactionByCategory**](CategoriesApi.md#ListTransactionByCategory) | **Get** /v1/categories/{id}/transactions | List all transactions in a category.
|
||||
[**StoreCategory**](CategoriesApi.md#StoreCategory) | **Post** /v1/categories | Store a new category
|
||||
[**UpdateCategory**](CategoriesApi.md#UpdateCategory) | **Put** /v1/categories/{id} | Update existing category.
|
||||
|
||||
# **DeleteCategory**
|
||||
> DeleteCategory(ctx, id, optional)
|
||||
Delete a category.
|
||||
|
||||
Delete a category. Transactions will not be removed.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the category. |
|
||||
**optional** | ***CategoriesApiDeleteCategoryOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a CategoriesApiDeleteCategoryOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| 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)
|
||||
|
||||
# **GetCategory**
|
||||
> CategorySingle GetCategory(ctx, id, optional)
|
||||
Get a single category.
|
||||
|
||||
Get a single category.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the category. |
|
||||
**optional** | ***CategoriesApiGetCategoryOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a CategoriesApiGetCategoryOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
**start** | **optional.String**| A date formatted YYYY-MM-DD, to show spent and earned info. |
|
||||
**end** | **optional.String**| A date formatted YYYY-MM-DD, to show spent and earned info. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CategorySingle**](CategorySingle.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/vnd.api+json, 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)
|
||||
|
||||
# **ListAttachmentByCategory**
|
||||
> AttachmentArray ListAttachmentByCategory(ctx, id, optional)
|
||||
Lists all attachments.
|
||||
|
||||
Lists all attachments.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the category. |
|
||||
**optional** | ***CategoriesApiListAttachmentByCategoryOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a CategoriesApiListAttachmentByCategoryOpts 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. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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/vnd.api+json, 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)
|
||||
|
||||
# **ListCategory**
|
||||
> CategoryArray ListCategory(ctx, optional)
|
||||
List all categories.
|
||||
|
||||
List all categories.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**optional** | ***CategoriesApiListCategoryOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a CategoriesApiListCategoryOpts 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. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CategoryArray**](CategoryArray.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/vnd.api+json, 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)
|
||||
|
||||
# **ListTransactionByCategory**
|
||||
> TransactionArray ListTransactionByCategory(ctx, id, optional)
|
||||
List all transactions in a category.
|
||||
|
||||
List all transactions in a category, optionally limited to the date ranges specified.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| The ID of the category. |
|
||||
**optional** | ***CategoriesApiListTransactionByCategoryOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a CategoriesApiListTransactionByCategoryOpts 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, to limit the result list. |
|
||||
**end** | **optional.String**| A date formatted YYYY-MM-DD, to limit the result list. |
|
||||
**type_** | [**optional.Interface of TransactionTypeFilter**](.md)| Optional filter on the transaction type(s) returned |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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/vnd.api+json, 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)
|
||||
|
||||
# **StoreCategory**
|
||||
> CategorySingle StoreCategory(ctx, body, createdAt, updatedAt, name, notes, spent, earned, optional)
|
||||
Store a new category
|
||||
|
||||
Creates a new category. The data required can be submitted as a JSON body or as a list of parameters.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**Category**](Category.md)| JSON array or key=value pairs with the necessary category information. See the model for the exact specifications. |
|
||||
**createdAt** | **time.Time**| |
|
||||
**updatedAt** | **time.Time**| |
|
||||
**name** | **string**| |
|
||||
**notes** | **string**| |
|
||||
**spent** | [**[]CategorySpent**](CategorySpent.md)| |
|
||||
**earned** | [**[]CategoryEarned**](CategoryEarned.md)| |
|
||||
**optional** | ***CategoriesApiStoreCategoryOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a CategoriesApiStoreCategoryOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CategorySingle**](CategorySingle.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/vnd.api+json, 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)
|
||||
|
||||
# **UpdateCategory**
|
||||
> CategorySingle UpdateCategory(ctx, body, name, notes, id, optional)
|
||||
Update existing category.
|
||||
|
||||
Update existing category.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**CategoryUpdate**](CategoryUpdate.md)| JSON array with updated category information. See the model for the exact specifications. |
|
||||
**name** | **string**| |
|
||||
**notes** | **string**| |
|
||||
**id** | **string**| The ID of the category. |
|
||||
**optional** | ***CategoriesApiUpdateCategoryOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a CategoriesApiUpdateCategoryOpts struct
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
|
||||
|
||||
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CategorySingle**](CategorySingle.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/vnd.api+json, 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)
|
||||
|
||||
14
docs/Category.md
Normal file
14
docs/Category.md
Normal file
@ -0,0 +1,14 @@
|
||||
# Category
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CreatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**UpdatedAt** | [**time.Time**](time.Time.md) | | [optional] [default to null]
|
||||
**Name** | **string** | | [default to null]
|
||||
**Notes** | **string** | | [optional] [default to null]
|
||||
**Spent** | [**[]CategorySpent**](CategorySpent.md) | | [optional] [default to null]
|
||||
**Earned** | [**[]CategoryEarned**](CategoryEarned.md) | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user