POST api/Budgets

Creates a budget.

Request Information

URI Parameters

None.

Body Parameters

The budget to create with.

BudgetInputDto
NameDescriptionTypeAdditional information
Name

string

Required

Code

string

None.

StartDateUtc

date

Required

ExpiryDateUtc

date

None.

Amount

decimal number

Required

TenantId

globally unique identifier

None.

UserIds

Collection of string

None.

PoReference

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Code": "sample string 2",
  "StartDateUtc": "2025-12-06T02:25:05.240256+00:00",
  "ExpiryDateUtc": "2025-12-06T02:25:05.240256+00:00",
  "Amount": 4.0,
  "TenantId": "51782456-6874-4c80-ba57-58cadd31e2ba",
  "UserIds": [
    "sample string 1",
    "sample string 2"
  ],
  "PoReference": "sample string 6"
}

application/xml, text/xml

Sample:
<BudgetInputDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Pay.Models">
  <Amount>4</Amount>
  <Code>sample string 2</Code>
  <ExpiryDateUtc>2025-12-06T02:25:05.240256+00:00</ExpiryDateUtc>
  <Name>sample string 1</Name>
  <PoReference>sample string 6</PoReference>
  <StartDateUtc>2025-12-06T02:25:05.240256+00:00</StartDateUtc>
  <TenantId>51782456-6874-4c80-ba57-58cadd31e2ba</TenantId>
  <UserIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </UserIds>
</BudgetInputDto>

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.