Skip to content

See next year's IT budget from what you pay now and the contracts that renew

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

POST
/v1/budget/forecast
curl --request POST \  --url https://api.xovris.ai/v1/budget/forecast \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "lines": null, "contracts": null, "budgets": null }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
lines
contracts
budgets

Example

{  "lines": null,  "contracts": null,  "budgets": null}

Done.

Media typeapplication/json
object
categories
required
Array<object>
object
category
required
string
currency
required
string
nextYearMinor
required
number
lowMinor
required
number
highMinor
required
number
months
required
number
trendPerMonthMinor
required
number
seasonal
required
boolean
savings
required
Array<object>
object
kind
required
string
Allowed values: unused_seats duplicate_tools pay_yearly renegotiate
vendor
required
string
currency
required
string
perYearMinor
required
number
says
required
string
totals
required
object
key
additional properties
object
nextYearMinor
required
number
savingsMinor
required
number
tooShort
required
Array<string>
watch
required
Array<object>
object
category
required
string
currency
required
string
budgetMinor
required
number
spentMinor
required
number
projectedMinor
required
number
lastMonthMinor
required
One of:
number
status
required
string
Allowed values: within over on_track_to_exceed
overOn
required
One of:
string
says
required
string
whatXovrisDoes
required
string
doItYourself
required
string

Example

{  "categories": [    {      "category": "string",      "currency": "string",      "nextYearMinor": 1,      "lowMinor": 1,      "highMinor": 1,      "months": 1,      "trendPerMonthMinor": 1,      "seasonal": true    }  ],  "savings": [    {      "kind": "unused_seats",      "vendor": "string",      "currency": "string",      "perYearMinor": 1,      "says": "string"    }  ],  "totals": {},  "tooShort": [    "string"  ],  "watch": [    {      "category": "string",      "currency": "string",      "budgetMinor": 1,      "spentMinor": 1,      "projectedMinor": 1,      "lastMonthMinor": 1,      "status": "within",      "overOn": "string",      "says": "string"    }  ],  "whatXovrisDoes": "string",  "doItYourself": "string"}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.