Query Spend

POST /api/spend/queryData

Api key

Get's spend entered within date range

Query parameters

length integer Required

Number of results to return
datefrom date

Date from
groupturnover boolean

Group spend by agreement
start integer Required

Start row of returned results
dateto date

Date to

Responses

• default

Return example
Hide response attributes Show response attributes object
- data object
  
  Hide data attributes Show data attributes
  
  data array[object]
  
  Hide data attributes Show data attributes
  
  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
  
  psaID integer
  
  memberID integer
  
  period string(date)
  
  invoicingRoute string
  
  value number(double)
  
  columns array[object]
  
  Hide columns attribute Show columns attribute
  
  title string
- total integer

POST /api/spend/queryData

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

Response examples (default)

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