Reporting
Central Reports API — Endpoints
Complete endpoint reference for the Central Reports API. 82 endpoints across 2 tag groups.
Base URL:https://central-reports-api.helixleisure.net
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report returns the overall summary of the card balance movements of the location for the selected period. This will assist user to reconcile the opening and ending card balances. The API call returns 3 sets of results: result: Daily aggregated values of all card balance transactions. opening: The opening balance based on the start date specified. closing: The closing balance based on the end date specified, which is equivalent to the opening balance of the day after the end date. The report that is consuming the result from the API will also required to compute the “Difference” and “Closing Balance Calculated” columns for the period based on the opening and closing balances.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"card_balance_reconciliation_report": {
"balance_transfers": 0,
"card_balance": 0,
"card_balance_type": 0,
"cointech_transfers": 0,
"game_plays": 0,
"location_description": "string",
"location_id": 0,
"other": 0,
"transaction_date": "2024-01-15",
"transactions_during_period": 0
},
"card_balance_reconciliation_report_balance": {
"location_id": 0,
"snapshot_date": "2024-01-15",
"total_electronic_cash": 0,
"total_play_bonus": 0,
"total_play_value": 0,
"total_promotional_cash": 0,
"total_tickets": 0
}
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report shows cards transactions history.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"application_name": "string",
"bonus_amount": 0,
"card_barcode": 0,
"cashier": "string",
"description": "string",
"game_id": "string",
"location_description": "string",
"location_id": 0,
"tickets": 0,
"transaction_amount": 0,
"transaction_datetime": "2024-01-15T10:30:00Z",
"transaction_type": "string"
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report shows details of a card holder including accumulated spending, card issue date, card holder name, contact details and date of birth.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"address1": "string",
"address2": "string",
"address3": "string",
"amount_spent_in_date_range": 0,
"bonus_balance": 0,
"card_added": "2024-01-15T10:30:00Z",
"card_barcode": 0,
"card_type_description": "string",
"card_type_id": 0,
"cash_balance": 0,
"cumulative_balance": 0,
"customer_id": 0,
"dob": "2024-01-15T10:30:00Z",
"e_cash_balance": 0,
"email": "string",
"firstname": "string",
"last_modified": "2024-01-15T10:30:00Z",
"location_description": "string",
"location_id": 0,
"mobile_phone": "string",
"p_cash_balance": 0,
"phone": "string",
"postcode": "string",
"registered_date": "2024-01-15T10:30:00Z",
"running_cumulative_balance": 0,
"surname": "string",
"ticket_balance": 0
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report returns aggregated details about all card products sold within the queried period. Sales of each card product are aggregated together per location, which can be used to help determine an appropriate card mix for sale.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"avg_unit_sale": 0,
"coupon_used": 0,
"id": 0,
"location_id": 0,
"percentage_of_total": 0,
"product_description": "string",
"qty_net": 0,
"qty_rev": 0,
"qty_sold": 0,
"tax_amount": 0,
"total_gross_sales": 0,
"transaction_date": "2024-01-15",
"user_id": 0
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report lists transactions which cashiers have entered comments.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"cashier": "string",
"comment": "string",
"invoice_no": "string",
"location_description": "string",
"location_id": 0,
"product_description": "string",
"sale_number": 0,
"ticket_value": 0,
"transaction_amount": 0,
"transaction_datetime": "2024-01-15T10:30:00Z",
"transaction_type": "string"
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report returns breakdown of all the sales made per cashier per location over the selected period. Commonly used to balance other reports, or to audit staff. Suspicious cashier sales activity can be determined from looking at the sales breakdown.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"account_received": 0,
"cash_out": 0,
"cash_pull": 0,
"cash_received": 0,
"cashier_id": 0,
"check_received": 0,
"credit_card_received": 0,
"eft_received": 0,
"location_description": "string",
"location_id": 0,
"shukran_redemption_value": 0,
"staff_member": "string",
"total_received": 0,
"transaction_date": "2024-01-15"
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report lists all cashier related transactions during a specified period at a store.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"application": "string",
"bonus_amount": 0,
"card_number": "string",
"card_type_description": "string",
"cashier": "string",
"invoice_no": "string",
"location_description": "string",
"location_id": 0,
"new_card": true,
"new_card_cost": 0,
"payment_type": "string",
"product_description": "string",
"product_id": 0,
"sale_number": 0,
"split_cards": [
{
"bonus_amount": 16.67,
"card_barcode": 9908309284,
"card_type": "string",
"cash_amount": 11.67,
"new_card": true,
"new_card_cost": 5,
"ticket_amount": 0
}
],
"taxone_amount": 0,
"taxtwo_amount": 0,
"ticket_value": 0,
"transaction_amount": 0,
"transaction_count": 0,
"transaction_datetime": "2024-01-15T10:30:00Z",
"transaction_type": "string",
"week_day": "string"
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report returns breakdown of sales per application (or computer) for the selected period. It is especially useful in showing the effectiveness of unattended sales (kiosks) vs attended sales (POS). *Note: Tips received is excluded in the API response. Total Banking is calculated on cash payment only, cash pull and voids are not calculated.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"account_received": 0,
"app_id": 0,
"cash_out": 0,
"cash_pull": 0,
"cash_received": 0,
"cheque_received": 0,
"computer": "string",
"credit_card_received": 0,
"debit_card_received": 0,
"e_cash_received": 0,
"guest_card_received": 0,
"location_description": "string",
"location_id": 0,
"p_cash_received": 0,
"shukran_card_received": 0,
"staff_member": "string",
"total_banking": 0,
"total_received": 0,
"transaction_date": "2024-01-15",
"user_id": 0
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report shows all credit card transactions for the period selected as well as receipt summary.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"credit_card_transactions_receipt_summary_report": {
"credit_card_receipts": 0,
"credit_card_tips": 0,
"location_description": "string",
"location_id": 0,
"outstanding_pre_auths": 0,
"previous_post_auths": 0,
"revenue_adjustments": 0,
"total_processed": 0
},
"credit_card_transactions_report": {
"amount": 0,
"card_type": "string",
"cashier": "string",
"computer": "string",
"credit_card_last_four_digits": "string",
"invoice_no": "string",
"location_description": "string",
"location_id": 0,
"pre_auths_status": "string",
"reference": "string",
"sale_number": 0,
"tip": 0,
"transaction_datetime": "2024-01-15T10:30:00Z"
}
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report shows totals and quantities of stock sold during the period selected.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"coupons_amount": 0,
"coupons_tax": 0,
"location_id": 0,
"package_sales_amount": 0,
"package_sales_quantity": 0,
"package_sales_tax": 0,
"percent_of_total_sales": 0,
"product_category": "string",
"product_code": "string",
"product_id": 0,
"product_name": "string",
"retail_price": 0,
"retail_sales_amount": 0,
"retail_sales_quantity": 0,
"retail_sales_tax": 0,
"tax_amount": 0,
"total_gross_sales": 0,
"transaction_date": "2024-01-15"
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report shows the number of staff and guest plays, the value of play, percentage of total, E-Tickets and Paper Tickets issued, average Tickets per play and the percentage Ticket payout.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"asset_number": "string",
"avg_tickets_per_play_by_station": 0,
"avg_tickets_per_play_by_unit": 0,
"card_value": 0,
"coin_value": 0,
"e_tickets_issued_by_station": 0,
"e_tickets_issued_by_unit": 0,
"game_category": "string",
"game_class": "string",
"game_description": "string",
"game_detail_description": "string",
"game_id": "string",
"game_ml_id": 0,
"game_type": "string",
"guest_plays": 0,
"location_description": "string",
"location_id": 0,
"paper_tickets_issued_by_station": 0,
"paper_tickets_issued_by_unit": 0,
"percent_ticket_payout": 0,
"percent_total_game": 0,
"serial_number": "string",
"staff_plays": 0,
"transaction_date": "2024-01-15",
"value_of_game_play": 0
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report shows information about games that are offline that can then be used by game technicians to schedule and monitor game repairs/issues
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"comment": "string",
"location_description": "string",
"location_id": 0,
"read_log": "string",
"swiper_description": "string",
"swiper_id": 0,
"transaction_datetime": "2024-01-15T10:30:00Z",
"user_id": 0,
"user_name": "string"
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report breaks down all customer plays into standard, timed, product and free plays and their credit value for profit sharing purposes.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"category_description": "string",
"customer_free_notional_value": 0,
"customer_free_plays": 0,
"customer_product_notional_value": 0,
"customer_product_plays": 0,
"customer_standard_actual_cash": 0,
"customer_standard_card_cash": 0,
"customer_standard_cash_value": 0,
"customer_standard_play_bonus": 0,
"customer_standard_plays": 0,
"customer_standard_total": 0,
"customer_time_play_bonus": 0,
"customer_time_play_value": 0,
"customer_time_total": 0,
"customer_timed_plays": 0,
"customer_total_plays": 0,
"customer_total_value": 0,
"game_definition_name": "string",
"game_deleted": true,
"game_description": "string",
"game_id": "string",
"game_ml_id": "string",
"game_type": 0,
"location_description": "string",
"location_id": 0,
"swiper_description ": "string",
"transaction_date": "2024-01-15"
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report returns the details of all the takings in the store in hourly period. User will be able to derive the daily receipts by summing the total takings of the reported periods for each day.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"hourly_takings": [
{
"hour": 0,
"taking": 0
}
],
"location_description": "string",
"location_id": 0,
"total_takings": 0,
"transaction_date": "2024-01-15"
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report returns the details of all the card sales, retail sales and coupons used in the store in hourly period. User will be able to derive the card sales, retail sales and coupons by summing the total sales of the reported periods for each day.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"hourly_card_sales": [
{
"hour": 0,
"taking": 0
}
],
"hourly_coupons": [
{
"hour": 0,
"taking": 0
}
],
"hourly_experience_booking_sales": [
{
"hour": 0,
"taking": 0
}
],
"hourly_retail_sales": [
{
"hour": 0,
"taking": 0
}
],
"location_description": "string",
"location_id": 0,
"total_card_sales": 0,
"total_coupons": 0,
"total_experience_booking_sales": 0,
"total_retail_sales": 0,
"transaction_date": "2024-01-15"
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report returns the total units of the payment amount and type used for the sales transactions done in Kiosk station. It also contains the total gross sales and sales percentage.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"application_id": 0,
"application_name": "string",
"cash": 0,
"gross_sales": 0,
"location_description": "string",
"location_id": 0,
"other": 0,
"payment_amount": 0,
"payment_type": "string",
"payment_units": 0,
"transaction_date": "2024-01-15"
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report shows a summary of Sales, Deposits, Receipts and Taxes.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"location_sales_and_taxes_details": {
"account_banked": 0,
"account_compulsory_gratuity": 0,
"account_payment": 0,
"account_tip": 0,
"card_sale_coupon": 0,
"card_sale_tax_exempt": 0,
"card_sales_tax": 0,
"card_sales_total": 0,
"card_total_inc_tax": 0,
"cash_banked": 0,
"cash_compulsory_gratuity": 0,
"cash_payment": 0,
"cash_tip": 0,
"cheque_banked": 0,
"cheque_compulsory_gratuity": 0,
"cheque_payment": 0,
"cheque_tip": 0,
"credit_card_banked": 0,
"credit_card_compulsory_gratuity": 0,
"credit_card_payment": 0,
"credit_card_tip": 0,
"debit_card_banked": 0,
"debit_card_compulsory_gratuity": 0,
"debit_card_payment": 0,
"debit_card_tip": 0,
"deposit_applied": 0,
"deposit_received": 0,
"deposit_refunded": 0,
"e_cash_total_inc_tax": 0,
"ecash_compulsory_gratuity": 0,
"ecash_play": 0,
"ecash_sale": 0,
"ecash_sale_tax": 0,
"ecash_tip": 0,
"experience_booking_sale": 0,
"experience_booking_sale_tax": 0,
"experience_booking_sale_total_inc_tax": 0,
"location_id": 0,
"mobile_wallet_refund": 0,
"mobile_wallet_refund_tax": 0,
"mobile_wallet_refund_total_inc_tax": 0,
"mobile_wallet_sale": 0,
"mobile_wallet_sale_tax": 0,
"mobile_wallet_sale_total_inc_tax": 0,
"online_booking": 0,
"online_booking_tax": 0,
"online_booking_total_inc_tax": 0,
"other_income": 0,
"other_income_tax": 0,
"other_income_total_inc_tax": 0,
"pcash_play": 0,
"pcash_sale": 0,
"purchase_by_ecash": 0,
"purchase_by_pcash": 0,
"refund_adj_tax": 0,
"refund_adj_total": 0,
"refund_adj_total_inc_tax": 0,
"refund_tax": 0,
"refund_total": 0,
"refund_total_inc_tax": 0,
"retail_sale_coupon": 0,
"retail_sale_tax_exempt": 0,
"retail_sales_tax": 0,
"retail_sales_total": 0,
"retail_total_inc_tax": 0,
"revadj_tax": 0,
"revadj_total": 0,
"revenueadj_total_inc_tax": 0,
"tax_category1": 0,
"tax_category2": 0,
"tax_details": [
{
"tax_amount": 0,
"tax_description": "string"
}
],
"transaction_date": "2024-01-15"
},
"location_sales_and_taxes_summary_report": {
"adjusted_gross_sales": 0,
"deposits_on_open_tabs": 0,
"location_id": 0,
"net_change_in_deposits": 0,
"payments_on_open_tabs": 0,
"previous_period_paid_unpaid_open_tab_sales": 0,
"total_combined_tax": 0,
"total_compulsory_gratuity": 0,
"total_coupons": 0,
"total_gross_tax": 0,
"total_net_sales": 0,
"total_net_tax": 0,
"total_receipts": 0,
"total_tax_exemptions": 0
}
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report returns guest registration data for Mobile Wallet including card barcodes, contact details, and marketing consent.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"brand_id": "string",
"card_barcode": "string",
"date_of_birth": "2024-01-15",
"date_of_registration": "2024-01-15T10:30:00Z",
"email": "string",
"first_name": "string",
"last_name": "string",
"marketing_consent": "string",
"phone_number": "string",
"postal_code": "string",
"rsp_code": "string"
}
204no content
{}
400bad request
401unauthorized
500internal server error
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report returns raw transaction data for Mobile Wallet transactions including sales, refunds, and failed transactions.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"amount_loaded": 0,
"bonus": 0,
"brand_id": "string",
"card_barcode": "string",
"card_number": "string",
"cash_play_value": 0,
"comments": "string",
"created_date": "2024-01-15T10:30:00Z",
"ecash_or_play_value": "string",
"fixed_tax": 0,
"guest_name": "string",
"payment_provider_name": "string",
"payment_provider_txn_id": "string",
"price": 0,
"product": "string",
"qty_sold": 0,
"status": "string",
"tickets": 0,
"transaction_datetime": "2024-01-15T10:30:00Z",
"txn_type": "string"
}
204no content
{}
400bad request
401unauthorized
500internal server error
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report shows individual redemption game revenue, number of plays, tickets issued and payout in one or many locations picked during the date range selected.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"avg_ticket_per_game": 0,
"game_category": "string",
"game_play_value": 0,
"location_description": "string",
"location_id": 0,
"number_of_game_play": 0,
"percentage_payout_tickets": 0,
"percentage_tickets_outstanding": 0,
"ticket_value": 0,
"tickets_eaten": 0,
"tickets_issued": 0,
"tickets_redeemed": 0,
"total_tickets_outstanding": 0,
"transaction_date": "2024-01-15"
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report shows opening and closing quantities of stock items, stock transactions as well as stock movement for the requested date range. The API call returns 2 sets of results: activity: Daily aggregated values of stock transactions for the date range specified. stock_movement: The opening balance, closing balance and stock movement based on the date range specified. Note: The API returns HTTP 204 response if there's no stock transactions (no activity) for the date range specified.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"adjustments": 0,
"deleted": 0,
"issues": 0,
"last_purchase_price": 0,
"location_description": "string",
"location_id": 0,
"product_code": "string",
"product_description": "string",
"product_id": 0,
"receipts": 0,
"transaction_date": "2024-01-15",
"warehouse_description": "string",
"warehouse_id": 0
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report is used to track of stock deliveries (stock received transactions) and their quantity and value. The API call returns 2 sets of results: total: The aggregated ticket value, sale price and stock value of all stock deliveries. result: List of the stock deliveries. The value of stock can be arrived at as follows, - Using Sale Price to calculate Sale Value - Using Average Unit Cost or Last Purchase Price to calculate Stock Value
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"average_unit_cost": 0,
"cashier": "string",
"invoice": "string",
"last_purchase_price": 0,
"location_description": "string",
"location_id": 0,
"po_number": "string",
"product_code": "string",
"product_description": "string",
"product_id": 0,
"quantity": 0,
"receipt_datetime": "2024-01-15T10:30:00Z",
"sale_price": 0,
"sale_value": 0,
"stock_value_average_unit_cost": 0,
"stock_value_last_purchase_price": 0,
"supplier_name": "string",
"ticket_value": 0,
"warehouse_description": "string",
"warehouse_id": 0
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report returns stock sales and redemption for the selected period.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"average_unit_cost": 0,
"last_purchase_price": 0,
"location_id": 0,
"product_code": "string",
"product_description": "string",
"product_id": 0,
"quantity_redeemed": 0,
"quantity_sold": 0,
"tickets_redeemed": 0,
"total_cost_recorded_avg": 0,
"total_quantity": 0,
"total_sale_cost_average_unit_cost": 0,
"total_sale_cost_last_purchase_price": 0,
"transaction_date": "2024-01-15",
"value_sold": 0
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report is used to check the value of stock in the inventory. The API call returns 2 sets of results: total: The aggregated quantity on hand of all stock. result: List of the current stock levels. Note: The date parameters are only used to get 'Stock on Order Details'. Therefore the API always returns inventory data regardless of the date range specified. Stock value not returned as there're two calculation methods with which the stock value can be arrived at.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"average_unit_cost": 0,
"category_description": "string",
"last_purchase_price": 0,
"location_description": "string",
"location_id": 0,
"product_code": "string",
"product_description": "string",
"product_id": 0,
"quantity_on_order": 0,
"quantity_on_order_value": 0,
"quantity_redeemed": 0,
"stock_quantity_on_hand": 0,
"supplier_name": "string",
"ticket_value": 0,
"warehouse_description": "string",
"warehouse_id": 0
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report shows the total number of minutes that a swiper was offline, its downtime as a percentage of its potential uptime, the cost to repair the swiper and any related comments.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"comments": [
{
"comment": "string",
"commented_on": "2024-01-15T10:30:00Z",
"commenter": "string",
"commenter_id": 0
}
],
"downtime_minutes": 0,
"game_definition_name": "string",
"game_id": "string",
"game_swiper_deleted": true,
"location_description": "string",
"location_id": 0,
"percentage_of_average_utilization": 0,
"percentage_of_downtime": 0,
"potential_total_uptime_minutes": 0,
"swiper_description": "string",
"swiper_id": 0,
"swiper_unit_deleted": true,
"transaction_date": "2024-01-15"
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report shows detailed Ticket Token usage per cashier, and compliments the Ticket Token feature in RedPro.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"associated_game_id": "string",
"card_type": "string",
"card_voucher_no": "string",
"cashier_name": "string",
"comments": "string",
"computer": "string",
"invoice_no": "string",
"location_description": "string",
"location_id": 0,
"quantity": 0,
"sale_number": 0,
"ticket_token_description": "string",
"ticket_token_value": 0,
"total_value_redeemed": 0,
"transaction_datetime": "2024-01-15T10:30:00Z"
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| end_date | query | string | ✓ | Denotes the ending date range for report data to be returned. |
| location_ids | query | array | ✓ | List of location ids to return results for. |
| start_date | query | string | ✓ | Denotes the starting date range for report data to be returned. |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This report shows totals and quantities of stock sold during the period selected.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"departmental_sales_coupons_report": {
"coupons_amount": 0,
"coupons_tax": 0,
"location_id": 0,
"package_sales_amount": 0,
"package_sales_quantity": 0,
"package_sales_tax": 0,
"product_id": 0,
"product_name": "string",
"retail_sales_amount": 0,
"retail_sales_quantity": 0,
"retail_sales_tax": 0,
"tax_amount": 0,
"total_gross_sales": 0,
"transaction_date": "2024-01-15"
},
"departmental_sales_v2_report": {
"location_id": 0,
"package_sales_amount": 0,
"package_sales_quantity": 0,
"package_sales_tax": 0,
"percent_of_total_sales": 0,
"product_category": "string",
"product_code": "string",
"product_id": 0,
"product_name": "string",
"retail_price": 0,
"retail_sales_amount": 0,
"retail_sales_quantity": 0,
"retail_sales_tax": 0,
"tax_amount": 0,
"total_gross_sales": 0,
"transaction_date": "2024-01-15"
}
}
204no content
{}
400bad request
401unauthorized
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| token | path | string | ✓ | token |
Responses
200success
{
"error": "string",
"parameters": {
"end_date": "2024-01-15",
"location_ids": [
0
],
"report_type": "CardBalanceReconciliation",
"start_date": "2024-01-15"
},
"queue_time": "2024-01-15T10:30:00Z",
"status": "ERROR",
"token": "string"
}
400bad request
401unauthorized
This API is to get Access Token needed for APIs authorization
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| client_secret | string | ✓ | client secret |
Responses
200success
{
"access_token": "string",
"expires_in": 0,
"token_type": "Bearer"
}
400bad request
401unauthorized