XaitCPQ API

GET ai/budget

Gets all budgets paired with the actual customer-charged cost recorded within each budget's period.

Request Information

URI

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

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The list of budgets with their actual cost, remaining amount and percent used.

Collection of BudgetVsCostResponse
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Start

date

None.
End

date

None.
PeriodType

string

None.
Amount

decimal number

None.
Currency

string

None.
ActualCost

decimal number

None.
Remaining

decimal number

None.
PercentUsed

decimal number

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "38f01ab6-1d5c-44ad-bd45-28e9c5b0fae0",
    "Start": "2026-10-02T23:36:55.5059311Z",
    "End": "2026-10-02T23:36:55.5059311Z",
    "PeriodType": "sample string 4",
    "Amount": 5.0,
    "Currency": "sample string 6",
    "ActualCost": 7.0,
    "Remaining": 8.0,
    "PercentUsed": 1.1
  },
  {
    "Id": "38f01ab6-1d5c-44ad-bd45-28e9c5b0fae0",
    "Start": "2026-10-02T23:36:55.5059311Z",
    "End": "2026-10-02T23:36:55.5059311Z",
    "PeriodType": "sample string 4",
    "Amount": 5.0,
    "Currency": "sample string 6",
    "ActualCost": 7.0,
    "Remaining": 8.0,
    "PercentUsed": 1.1
  }
]

text/html

Sample: 
[{"Id":"38f01ab6-1d5c-44ad-bd45-28e9c5b0fae0","Start":"2026-10-02T23:36:55.5059311Z","End":"2026-10-02T23:36:55.5059311Z","PeriodType":"sample string 4","Amount":5.0,"Currency":"sample string 6","ActualCost":7.0,"Remaining":8.0,"PercentUsed":1.1},{"Id":"38f01ab6-1d5c-44ad-bd45-28e9c5b0fae0","Start":"2026-10-02T23:36:55.5059311Z","End":"2026-10-02T23:36:55.5059311Z","PeriodType":"sample string 4","Amount":5.0,"Currency":"sample string 6","ActualCost":7.0,"Remaining":8.0,"PercentUsed":1.1}]

application/xml, text/xml

Sample: 
<ArrayOfBudgetVsCostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.Responses">
  <BudgetVsCostResponse>
    <ActualCost>7</ActualCost>
    <Amount>5</Amount>
    <Currency>sample string 6</Currency>
    <End>2026-10-02T23:36:55.5059311+00:00</End>
    <Id>38f01ab6-1d5c-44ad-bd45-28e9c5b0fae0</Id>
    <PercentUsed>1.1</PercentUsed>
    <PeriodType>sample string 4</PeriodType>
    <Remaining>8</Remaining>
    <Start>2026-10-02T23:36:55.5059311+00:00</Start>
  </BudgetVsCostResponse>
  <BudgetVsCostResponse>
    <ActualCost>7</ActualCost>
    <Amount>5</Amount>
    <Currency>sample string 6</Currency>
    <End>2026-10-02T23:36:55.5059311+00:00</End>
    <Id>38f01ab6-1d5c-44ad-bd45-28e9c5b0fae0</Id>
    <PercentUsed>1.1</PercentUsed>
    <PeriodType>sample string 4</PeriodType>
    <Remaining>8</Remaining>
    <Start>2026-10-02T23:36:55.5059311+00:00</Start>
  </BudgetVsCostResponse>
</ArrayOfBudgetVsCostResponse>