Query Spend

POST /api/spend/queryData

Api key

Get's spend entered within date range

Query parameters

datefrom date

Date from - turnover loaded after this date
groupturnover boolean

Group spend by agreement
length integer Required

Number of results to return
start integer Required

Start row of returned results
dateto date

Date to - turnover loaded before this date

Responses

default application/json

Return example
Hide response attributes Show response attributes object
- data object
  
  Additional properties are allowed.
  
  Hide data attributes Show data attributes object
  
  data array[object]
  
  Hide data attributes Show data attributes object
  
  inputName string
  
  query_raised string(date-time)
  
  turnoverID integer
  
  memberName string
  
  display string
  
  date_added string(date-time)
  
  memberValue number(double)
  
  known_as string
  
  name string
  
  flagged boolean
  
  NMBSID string
  
  memberID integer
  
  period string(date)
  
  invoicingRoute string
  
  value number(double)
  
  psaID integer
  
  columns array[object]
  
  Hide columns attribute Show columns attribute object
  
  title string
- total integer

POST /api/spend/queryData

curl \
 --request POST 'http://api.example.com/api/spend/queryData?length=42&start=42' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (default)

{
  "data": {
    "data": [
      {
        "inputName": "Input Name",
        "query_raised": "2025-05-04T09:42:00Z",
        "turnoverID": 42,
        "memberName": "string",
        "display": "&pound",
        "date_added": "2025-05-04T09:42:00Z",
        "memberValue": 42.0,
        "known_as": "Supplier Name",
        "name": "Agreement Name",
        "flagged": true,
        "NMBSID": "A56BV",
        "memberID": 42,
        "period": "2025-05-04",
        "invoicingRoute": "DIRECT/NMBS",
        "value": 42.0,
        "psaID": "44833"
      }
    ],
    "columns": [
      {
        "title": "string"
      }
    ]
  },
  "total": 42
}