Skip to main content

API: On Time Performance Summary (Legacy)

Updated

NOTE: This is an article for the legacy API. To access updated information on this endpoint, please reference the HTML guide attached to the bottom of the REST API Access document

 

Description: Returns On Time Performance Summary details from the Timing tab in the Vendor Scorecard screen in the Supply module

Resource: OnTimePerformanceSummary/

Verb: GET

Query String Arguments

  • interval (required):
    • 2 = Weekly
    • 4 = Monthly
    • 8 = Quarterly
    • 16 = Yearly
  • leadTimeType (required):
    • 4= Shipping (from Display Options)
    • 8= Vendor (from Display Options)
    • 32= Planning (from Display Options)
  • dateFilterOption (required):
    • 0= Order Creation Date (from Display Options)
    • 1= Receipt Date (from Display Options)
  • primarySupplierIds (optional)
  • supplierIds (optional)

Returns: JSON Array containing records matching On Time Performance Summary details

Example Response JSON:

[{
"PeriodDate": "2023/02/01",
"EarlyCount": 18,
"OnTimeCount": 31,
"UnknownCount": 0,
"LateCount": 29,
"TotalCount": 78,
"PercentEarly": 0.2307692307692307692307692308,
"PercentOnTime": 0.2307692307692307692307692308,
"PercentLate": 0.2307692307692307692307692308
},
{
"PeriodDate": "2023/03/01",
"EarlyCount": 0,
"OnTimeCount": 1,
"UnknownCount": 0,
"LateCount": 0,
"TotalCount": 1,
"PercentEarly": 0.0,
"PercentOnTime": 0.0,
"PercentLate": 0.0
}
...
]

 

Related articles