Budgets

List budgets

Returns the budgets of a company, one row per budget period, ordered by target date (most recent first). Results are paginated: use limit to control page size and pass the returned nextPageToken to fetch the next page; nextPageToken is null once the last page has been reached. startDate is inclusive and endDate is exclusive; either bound can be used on its own to leave the other end of the range unbounded.

get/budgets/{companyId}

Path parameters

companyIdstring required

Query parameters

startDatestring date

Only return budget periods with a target date on or after this date (inclusive).

Only return budget periods with a target date on or after this date (inclusive).

endDatestring date

Only return budget periods with a target date before this date (exclusive).

Only return budget periods with a target date before this date (exclusive).

status'pending' | 'filled' | 'overdue' | 'carried' | 'discarded'

Filter by budget period status.

limitinteger

Maximum number of budget rows to return per page. Defaults to 50, maximum 200.

Maximum number of budget rows to return per page. Defaults to 50, maximum 200.

nextPageTokenstring

Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page. An invalid or malformed token is rejected with 404.

Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page. An invalid or malformed token is rejected with 404.

Response

Successful Response

nextPageTokenstring nullable

Token to fetch the next page. null once the last page has been reached.

Example response

{
  "data": [
    {
      "description": "Office rent"
    }
  ]
}

Changes