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.

Name	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": "c3a84a1d-ad6e-43d6-84a7-3fd60b170354",
  "TenantId": "e2700b3d-1378-4c1b-a58b-128dc1ba7d2c",
  "UserId": "01f1cbed-9ba9-4292-8144-ab41f2acf6ac",
  "IncludeCancelled": true,
  "IncludeExpired": true,
  "BudgetFromDate": "2026-01-21T09:49:20.4647097+00:00",
  "BudgetToDate": "2026-01-21T09:49:20.4647097+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-01-21T09:49:20.4647097+00:00</BudgetFromDate>
  <BudgetToDate>2026-01-21T09:49:20.4647097+00:00</BudgetToDate>
  <Id>c3a84a1d-ad6e-43d6-84a7-3fd60b170354</Id>
  <IncludeAllocations>true</IncludeAllocations>
  <IncludeCancelled>true</IncludeCancelled>
  <IncludeExpired>true</IncludeExpired>
  <TenantId>e2700b3d-1378-4c1b-a58b-128dc1ba7d2c</TenantId>
  <UserId>01f1cbed-9ba9-4292-8144-ab41f2acf6ac</UserId>
</BudgetFilterCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.