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": "648d823b-a9b3-4964-92cc-220b64c84bd8",
"TenantId": "4863c814-330c-4a18-ac95-d4f2ac8dace2",
"UserId": "2ee3c004-5c82-431f-81ca-c531f243576b",
"IncludeCancelled": true,
"IncludeExpired": true,
"BudgetFromDate": "2026-10-23T13:13:51.2227549+00:00",
"BudgetToDate": "2026-10-23T13:13:51.2227549+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-10-23T13:13:51.2227549+00:00</BudgetFromDate> <BudgetToDate>2026-10-23T13:13:51.2227549+00:00</BudgetToDate> <Id>648d823b-a9b3-4964-92cc-220b64c84bd8</Id> <IncludeAllocations>true</IncludeAllocations> <IncludeCancelled>true</IncludeCancelled> <IncludeExpired>true</IncludeExpired> <TenantId>4863c814-330c-4a18-ac95-d4f2ac8dace2</TenantId> <UserId>2ee3c004-5c82-431f-81ca-c531f243576b</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.