POST api/Budgets/select
Retrieves a list of budgets that match the given criteria.
Request Information
URI Parameters
None.
Body Parameters
The criteria model to filter budgets by.
BudgetFilterCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| TenantId | globally unique identifier |
None. |
|
| UserId | globally unique identifier |
None. |
|
| IncludeCancelled | boolean |
None. |
|
| IncludeExpired | boolean |
None. |
|
| BudgetFromDate | date |
None. |
|
| BudgetToDate | date |
None. |
|
| IncludeAllocations | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "b93c0051-1c26-4225-be11-ea89501a3218",
"TenantId": "5ae250b6-c134-4b30-a5e6-c936b10f3f46",
"UserId": "645dc7ac-5e3c-4ece-a6cb-0b01071b5f7f",
"IncludeCancelled": true,
"IncludeExpired": true,
"BudgetFromDate": "2026-08-29T17:34:11.7077467+00:00",
"BudgetToDate": "2026-08-29T17:34:11.7077467+00:00",
"IncludeAllocations": true
}
application/xml, text/xml
Sample:
<BudgetFilterCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Pay.Models.FilterCriteria"> <BudgetFromDate>2026-08-29T17:34:11.7077467+00:00</BudgetFromDate> <BudgetToDate>2026-08-29T17:34:11.7077467+00:00</BudgetToDate> <Id>b93c0051-1c26-4225-be11-ea89501a3218</Id> <IncludeAllocations>true</IncludeAllocations> <IncludeCancelled>true</IncludeCancelled> <IncludeExpired>true</IncludeExpired> <TenantId>5ae250b6-c134-4b30-a5e6-c936b10f3f46</TenantId> <UserId>645dc7ac-5e3c-4ece-a6cb-0b01071b5f7f</UserId> </BudgetFilterCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.