Get Budget by Id

Use this method to retrieve one or many budgets. See our HTTP GET documentation for complete queries method.

The following elements are returned in the budgets response :

Body Response

Element Description
id Unique code for identifier budgets. String 36 characters.
type Type of budget, the type must be one of the following types: profit_loss, balance_sheet, cash_flow.
start Budget period started.
start.month Start month. String 1 for January, 2 for February, 3 for march etc.
start.year Start year. String ex: 2018, 2019, 2020 etc.
end Budget period finished.
end.month End month. Number 1 for January, 2 for February, 3 for march etc.
end.year End year. Number ex: 2018, 2019, 2020 etc.
description Description of budgets. String maximum 75 characters.
department* Element department of budgets.
department.id Unique code for identifier department. String 36 characters.
department.code Departement code String maximum 15 characters.
department.name Departement name String maximum 35 characters.
project* Element project of budgets.
project.id Unique code for identifier project. String 36 characters.
project.code Project code String maximum 15 characters.
project.name Project name String maximum 35 characters.
line_items.id line_items id String
line_items.is_annual line_items is_annual Boolean true if you want to fill the annual budget, false if you want to fill your monthly budget.
line_items.month month. Number 1 for January, 2 for February, 3 for march etc.
line_items.year year. Number ex: 2018, 2019, 2020 etc.
line_items.account Element for line_items account.
line_items.account.id Account id String
line_items.account.code Account code String maximum 255 characters.
line_items.account.name Account name String maximum 255 characters.
line_items.account.alias_name Account alias name String maximum 255 characters.
line_items.currency Element for line_items currency.
line_items.currency.id Currency id String
line_items.currency.code Currency code String
line_items.currency.name Currency name String
line_items.currency.symbol Currency symbol String
line_items.exchange_rate Exchange rate Number
line_items.amount_origin amount origin Number
line_items.amount amount Number
created* Element for created.
created.user* Created User name.
created.user.id User id String Automaticaly.
created.user.name User name String.
created.user.email User email String.
created.time Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format). Automaticaly.
update* Update.
update.user* Update user.
update.user.id User id String Automaticaly.
update.user.name User name String.
update.user.email User email String.
update.time Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format). Automaticaly.