GET
/
Statistic
/
vendorbasic
/
{mode}
/
{freq}
/
{idVendor}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Statistic/vendorbasic/{mode}/{freq}/{idVendor} \
  --header 'requestToken: <api-key>'
[
  {
    "statX": "",
    "active": 123,
    "activeVolume": 123,
    "sentToApproval": 123,
    "sentToApprovalVolume": 123,
    "toApproval": 123,
    "toApprovalVolume": 123,
    "approved": 123,
    "approvedVolume": 123,
    "disapproved": 123,
    "disapprovedVolume": 123,
    "cancelled": 123,
    "cancelledVolume": 123,
    "inTransit": 123,
    "inTransitVolume": 123,
    "paid": 123,
    "paidVolume": 123
  }
]

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

idVendor
integer
required

Vendor ID.

mode
string
required

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
Example:

"ytd"

freq
string
required

Frequency to group series. Allowed values:

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

For example, w groups the results by week.

Example:

"m"

Query Parameters

parameters
object

List of parameters

Response

200 - application/json

Success

The response is of type object[].