API referencePay Out endpointsVendor

Get vendor stats

Retrieve the basic statistics about a vendor for a given time period, grouped by frequency.

Path parameters

freqstringRequired

Frequency to group series. Allowed values:

  • m - monthly
  • w - weekly
  • d - daily
  • h - hourly

For example, w groups the results by week.

idVendorintegerRequired
Vendor ID.
modestringRequired

Mode for request. Allowed values:

  • ytd - Year To Date
  • mtd - Month To Date
  • wtd - Week To Date
  • today - All current day
  • m12 - Last 12 months
  • d30 - Last 30 days
  • h24 - Last 24 hours
  • lasty - Last Year
  • lastm - Last Month
  • lastw - Last Week
  • yesterday - Last Day

Headers

requestTokenstringRequired

Query parameters

parametersmap from strings to optional stringsOptional
List of parameters

Response

Success
activeinteger or null
activeVolumedouble or null
approvedinteger or null
approvedVolumedouble or null
cancelledinteger or null
cancelledVolumedouble or null
disapprovedinteger or null
disapprovedVolumedouble or null
inTransitinteger or null
inTransitVolumedouble or null
paidinteger or null
paidVolumedouble or null
sentToApprovalinteger or null
sentToApprovalVolumedouble or null
statXstring or null
toApprovalinteger or null
toApprovalVolumedouble or null

Errors