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": "fd21f514-fa95-4025-ab9f-588e3cec11be",
"TenantId": "0a207926-6fb5-47c4-9f80-fac14f07bb49",
"UserId": "8064538c-8d98-4099-9ea8-115d2f3989c7",
"IncludeCancelled": true,
"IncludeExpired": true,
"BudgetFromDate": "2026-03-16T13:52:53.3386676+00:00",
"BudgetToDate": "2026-03-16T13:52:53.3386676+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-03-16T13:52:53.3386676+00:00</BudgetFromDate> <BudgetToDate>2026-03-16T13:52:53.3386676+00:00</BudgetToDate> <Id>fd21f514-fa95-4025-ab9f-588e3cec11be</Id> <IncludeAllocations>true</IncludeAllocations> <IncludeCancelled>true</IncludeCancelled> <IncludeExpired>true</IncludeExpired> <TenantId>0a207926-6fb5-47c4-9f80-fac14f07bb49</TenantId> <UserId>8064538c-8d98-4099-9ea8-115d2f3989c7</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.