XaitCPQ API

POST ai/budget

Adds a new budget.

Request Information

URI

https://ofd-api.blueprintcpq.net/ai/budget

URI Parameters

None.

Body Parameters

The budget to add.

UpdateBudget
NameDescriptionTypeAdditional information
Start

date

None.
End

date

None.
PeriodType

string

None.
Amount

decimal number

None.
Currency

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Start": "2026-10-02T23:36:56.0064674Z",
  "End": "2026-10-02T23:36:56.0064674Z",
  "PeriodType": "sample string 3",
  "Amount": 4.0,
  "Currency": "sample string 5"
}

text/html

Sample: 
{"Start":"2026-10-02T23:36:56.0064674Z","End":"2026-10-02T23:36:56.0064674Z","PeriodType":"sample string 3","Amount":4.0,"Currency":"sample string 5"}

application/xml, text/xml

Sample: 
<UpdateBudget xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.ConfigurationModels">
  <Amount>4</Amount>
  <Currency>sample string 5</Currency>
  <End>2026-10-02T23:36:56.0064674+00:00</End>
  <PeriodType>sample string 3</PeriodType>
  <Start>2026-10-02T23:36:56.0064674+00:00</Start>
</UpdateBudget>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The newly added budget.

Budget
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Start

date

None.
End

date

None.
PeriodType

string

None.
Amount

decimal number

None.
Currency

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": "dd061269-2104-4621-a2ec-425e003d5833",
  "Start": "2026-10-02T23:36:56.0064674Z",
  "End": "2026-10-02T23:36:56.0064674Z",
  "PeriodType": "sample string 4",
  "Amount": 5.0,
  "Currency": "sample string 6"
}

text/html

Sample: 
{"Id":"dd061269-2104-4621-a2ec-425e003d5833","Start":"2026-10-02T23:36:56.0064674Z","End":"2026-10-02T23:36:56.0064674Z","PeriodType":"sample string 4","Amount":5.0,"Currency":"sample string 6"}

application/xml, text/xml

Sample: 
<Budget xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models">
  <Amount>5</Amount>
  <Currency>sample string 6</Currency>
  <End>2026-10-02T23:36:56.0064674+00:00</End>
  <Id>dd061269-2104-4621-a2ec-425e003d5833</Id>
  <PeriodType>sample string 4</PeriodType>
  <Start>2026-10-02T23:36:56.0064674+00:00</Start>
</Budget>