Appearance

List Budgets ​

Endpoint ​

http
GET /unified/accounting/budgets
Integrations supported
  • QuickBooks
  • Xero

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
created_at
string · date-time
This represents the date when the budget was created
Supported in
  • QuickBooks
  • Xero
updated_at
string · date-time
This represents the date when the budget was updated
Supported in
  • QuickBooks
status
string
The status of the budget
All possible enum values:
  • active
  • archived
Supported in
  • QuickBooks
start_date
string · date-time
The start date of the budget
Supported in
  • QuickBooks
end_date
string · date-time
The end date of the budget
Supported in
  • QuickBooks

Response Body ​

result
object[]
List of Budgets
id
string
REQUIRED · The unique identifier for budget
Supported in
  • QuickBooks
  • Xero
name
string
The name of the budget
Supported in
  • QuickBooks
  • Xero
tracking_categories
object[]
The tracking categories of the budget
Supported in
  • Xero
id
string
The ID of the tracking category
name
string
The name of the tracking category
option
string
The option of the tracking category
status
string
The status of the budget
All possible enum values:
  • active
  • archived
Supported in
  • QuickBooks
start_date
string · date-time
The start date of the budget
Supported in
  • QuickBooks
end_date
string · date-time
The end date of the budget
Supported in
  • QuickBooks
line_items
object[]
The line items of the budget
Supported in
  • QuickBooks
  • Xero
account
string
The ID of the account
amount
string
The amount of the line item
note
string
The note of the line item
date
string · date-time
The date of the line item
created_at
string · date-time
This represents the date when the budget was created
Supported in
  • QuickBooks
updated_at
string · date-time
This represents the date when the budget was updated
Supported in
  • QuickBooks
  • Xero
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.