Post
/api/v1/finance/budgets/filter
Get a paged list of existing budgets, optionally filtered to the given parameters.
Description
This endpoint retrieves a paged list of existing budgets, filtered to the given parameters.
Use Case
The user wants to use the GET operation in order to obtain specific details regarding the budget, however does not know which reference/externalIdentifier to use for the specific budget. By using the filter operation and leaving 'reference' and/or 'externalIdentifier' empty the user can retrieve the list of available budgets.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| pageSize | The maximum number of pages to be returned per request. The default number is 100 and the maximum is 1.000. If more results are returned than specified in the PageSize, the remaining pages are dropped based on the reference (number). |
| pageNumber | This allows the requesting party to specify which of the pages they want to receive. |
| columnName | The data field based on which sorting is applied. For example, if the results are sorted based on compaction code, columnName will contain the value 'compaction code'. |
| order | Based on this value, the property defined in 'columnName' is either sorted ascending (a-z) or descending (z-a). |
| reference | The unique identifier for this specific budget, created by Bloxs. |
| externalIdentifier | The unique identifier for this specific budget, not created by Bloxs. |
| budgetType | Refers to the budget type: 1 = Operating Budget, 2 = Investment Budget. |
| calendarYear | The calendar year to which the budget applies. |
| lastModified.from | The last modified date. This defines the lower border of the range. |
| lastModified.to | The last modified date. This defines the upper border of the range. |
Response fields
In addition to the request, the 200 response contains the fields in the table below.
| Field | Description |
|---|---|
| ownerReference | The reference of the relation that owns the budget. This refers to the reference created by Bloxs, not to be confused with the externalIdentifier. |
Security
HTTP
Type Bearer
Please enter a valid token
Body parameters
object
paging
object (PagingInfo)
pageSize
integer (int32) | null
Minimum1
Maximum1000
pageNumber
integer (int32) | null
Minimum1
Maximum9999
sorting
object (SortingInfo)
columnName
string | null
order
integer (int32)
Valid values[
0,
1
]
filter
object (BudgetSearchRequestFilter)
reference
string | null
externalIdentifier
string | null
budgetType
integer (int32) | null
Valid values[
1,
2
]
calendarYear
integer (int32) | null
lastModified
object (CompareFilterModelDateTime)
from
string (date-time) | null
to
string (date-time) | null
Responses
200
OK
object
paging
object (PagingInfo)
pageSize
integer (int32) | null
Minimum1
Maximum1000
pageNumber
integer (int32) | null
Minimum1
Maximum9999
sorting
object (SortingInfo)
columnName
string | null
order
integer (int32)
Valid values[
0,
1
]
budgets
Array of object (BudgetSearchResultFilter) | null
object
reference
string | null
externalIdentifier
string | null
ownerReference
string | null
budgetType
integer (int32)
Valid values[
1,
2
]
calendarYear
integer (int32)
lastModified
string (date-time)