GET /api/budgets
Show list of the budgets user- and company-specific

Returns list of the budgets of the user in the specific company

Supported Formats

json

Examples

[
  {
    "id": 1,
    "user_id": 1,
    "approver_id": 1,
    "name": "Travel Budget",
    "start_date": "28-11-2022",
    "end_date": "28-12-2022",
    "amount": "20.00",
    "amount_currency": "EUR",
    "used_amount": "15.00",
    "state": "approved",
    "lines": [
      {
        "id": 1,
        "amount": "10.00",
        "amount_currency": "EUR",
        "expense_account_id": 1
      },
      {
        "id": 2,
        "amount": "10.00",
        "amount_currency": "EUR",
        "expense_account_id": 1
      }
    ]
    "cost_centers": [
      {
        "id": 1,
        "dimension_name": "Project",
        "name": "Some project 1",
        "deactivated": false
      }
    ],
    "documents": [
      {
        "id": 1,
        "name": "agenda.pdf",
        "file": "https://example.com/agenda.pdf"
      }
    ]
  }
]

Params

Param name Description
page
optional

Page number

Validations:

  • Must be a Integer
per_page
optional

Number of records per page. Default: 30

Validations:

  • Must be a Integer
q
optional

Pass query to filter budgets by total amount or name.

Validations:

  • Must be a String
user_id
optional

Pass user_id to get budgets of that user.

Validations:

  • Must be a Integer
state
optional

Pass state to get budgets with that state.

Validations:

  • Must be one of: pending, approved, disapproved.
date_range
optional

Show all budgets that have either star_date or end_date within the date range. Date range format: “DD/MM/YYYY - DD/MM/YYYY” (example: 01/12/2023 - 12/12/2023)

Validations:

  • Must be a String
sort_by
optional

Return budgets sorted by following fields: user_name, state, start_date, end_date, approver_name. Default: approver_id.

Validations:

  • Must be a String
order
optional

Order budgets ascending or descending based on sort param. Default: asc

Validations:

  • Must be one of: asc, desc.