Skip to navigation
APIPay Out endpointsVendor

Get vendor stats

View as MarkdownOpen in Claude

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

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

Response

Success
statXstring

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

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

activeVolumedouble
Total value of the vendor's active bills, net of fees.
sentToApprovalinteger
Number of the vendor's bills submitted into an approval workflow.
sentToApprovalVolumedouble
Total value of the vendor's bills sent to approval, net of fees.
toApprovalinteger
Number of the vendor's bills awaiting an approver's decision.
toApprovalVolumedouble
Total value of the vendor's bills awaiting approval, net of fees.
approvedinteger
Number of the vendor's bills approved for payment.
approvedVolumedouble
Total value of the vendor's approved bills, net of fees.
disapprovedinteger
Number of the vendor's bills rejected during approval.
disapprovedVolumedouble
Total value of the vendor's disapproved bills, net of fees.
cancelledinteger
Number of the vendor's cancelled bills.
cancelledVolumedouble
Total value of the vendor's cancelled bills, net of fees.
inTransitinteger
Number of the vendor's bills whose payment is in transit.
inTransitVolumedouble

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

paidinteger
Number of the vendor's bills marked paid. Paid means the payout has settled, not merely that Payabli issued it.
paidVolumedouble
Total value of the vendor's paid bills, net of fees.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error