The vendor performance report object contains a dashboard identifier (called event_id) and then an array of individual vendor report records (vendor_performance_records)

Field Name Type Description Example value
event_id string(UUID) Unique identifier for the dashboard "253723ad-3e3b-4f13-b9f7-8b08d1d88906"
vendor_performance_records array(vendor_performance_report_record) A list of vendor_performance_report_record as specified below.

Vendor Performance Report Record

Key Type Description
vendor_id string(UUID) Unique identifier for the vendor
vendor_name string Name of the vendor
vendor_description string Description of the vendor
gross_revenue_total int Total gross revenue in cents
gross_gratuity_total int Total gross gratuity in cents
arbitrary_deduction_total int Total arbitrary deductions in cents
arbitrary_deduction_gratuity_total int Total arbitrary deduction gratuity in cents
item_revenue_total int Total revenue from items in cents
item_gratuity_total int Total gratuity from items in cents
item_sales_tax_total int Total sales tax from items in cents
items_sold_total int Total number of items sold
reversal_request_total int Total reversal requests in cents
reversal_request_approved_total int Total approved reversal requests in cents
reversal_request_denied_total int Total denied reversal requests in cents
reward_points_awarded_total int Total reward points awarded
reward_points_redeemed_total int Total reward points redeemed
reward_items_sold int Total reward items sold