Statistic

Get basic statistics for a vendor

Retrieve the basic statistics about a vendor over a date range, grouped by frequency. The response returns one row per time bucket, breaking the vendor's bills down by bill state (active, sent to approval, approved, in transit, paid, and so on). Volumes are net of fees.

get/Statistic/vendorbasic/{mode}/{freq}/{idVendor}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Statistic/vendorbasic/{mode}/{freq}/{idVendor}
  • Auth: HTTP bearer

Path parameters

freqstring required

Frequency to group series. Allowed values:

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

For example, w groups the results by week.

idVendorinteger required

Vendor ID.

modestring 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

Response

Success

statXstring required

The time bucket for this row, formatted according to the query's freq (for example, 2025-11 for a monthly bucket). Each bill falls in the bucket of its most recent update. The counts below break the vendor's bills down by bill state.

activeinteger required

Number of the vendor's bills in the active state (created, not yet submitted for approval).

activeVolumenumber double required

Total value of the vendor's active bills, net of fees.

sentToApprovalinteger required

Number of the vendor's bills submitted into an approval workflow.

sentToApprovalVolumenumber double required

Total value of the vendor's bills sent to approval, net of fees.

toApprovalinteger required

Number of the vendor's bills awaiting an approver's decision.

toApprovalVolumenumber double required

Total value of the vendor's bills awaiting approval, net of fees.

approvedinteger required

Number of the vendor's bills approved for payment.

approvedVolumenumber double required

Total value of the vendor's approved bills, net of fees.

disapprovedinteger required

Number of the vendor's bills rejected during approval.

disapprovedVolumenumber double required

Total value of the vendor's disapproved bills, net of fees.

cancelledinteger required

Number of the vendor's cancelled bills.

cancelledVolumenumber double required

Total value of the vendor's cancelled bills, net of fees.

inTransitinteger required

Number of the vendor's bills whose payment is in transit.

inTransitVolumenumber double required

Total value of the vendor's in-transit bills, net of fees.

paidinteger required

Number of the vendor's bills marked paid. Paid means the payout has settled, not merely that Payabli issued it.

paidVolumenumber double required

Total value of the vendor's paid bills, net of fees.

Changes

No recorded changes to this operation across all 1 revision of this API.