Skip to content

Latest commit

 

History

History
72 lines (40 loc) · 2.38 KB

PayeesApi.md

File metadata and controls

72 lines (40 loc) · 2.38 KB

\PayeesApi

All URIs are relative to https://api.youneedabudget.com/v1

Method HTTP request Description
get_payee_by_id get /budgets/{budget_id}/payees/{payee_id} Single payee
get_payees get /budgets/{budget_id}/payees List payees

get_payee_by_id

crate::models::PayeeResponse get_payee_by_id(budget_id, payee_id) Single payee

Returns single payee

Parameters

Name Type Description Required Notes
budget_id String The id of the budget ("last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) [required]
payee_id String The id of the payee [required]

Return type

crate::models::PayeeResponse

Authorization

bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_payees

crate::models::PayeesResponse get_payees(budget_id, last_knowledge_of_server) List payees

Returns all payees

Parameters

Name Type Description Required Notes
budget_id String The id of the budget ("last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) [required]
last_knowledge_of_server Option<i64> The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.

Return type

crate::models::PayeesResponse

Authorization

bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]