Electronic gaming operations
Documents

Documents

Records, fields, and the reads.

This is the integration reference. It is written for the person who will call the API: what each record contains, which identifier joins it to the next record, and which values to pull when two numbers have to be compared.

Calls go to that company’s server with that company’s sign-in (Authorization: Bearer). A person can call them today. A system calling with its own key, such as QuickBooks reading commission, would use these same resources. That key is not issued yet. A missing sign-in is 401. A signed-in person without that area is 403. List reads are paged with page and page_size.

A signed-in account also shows how that account’s own records are set up, under each section.

Identifiers

Join on the stable id. Use the serial when a person is matching a machine. Do not treat the serial as the only key: the same serial can leave one property and arrive at another, and a conversion keeps the serial while replacing the placement.

IdWhat it is
asset reference / asset_idThe physical unit. Placements, project lines, and parts discussions point here.
serial / serial_no / serial_numberThe manufacturer serial on that asset. The human join. Always pair it with asset_id when the unit has moved.
placement reference_keyOne span of that asset at one property. A conversion or a removal closes this row and opens another. Counting both counts two machines.
casino_idThe property. Same value on the placement, the project, the month, and the deal.
project reference_keyThe catalog job. ims_id on that job points at the schedule row. project_id on a placement points back at the job that opened or closed it.

Asset

The asset is the unit everything else hangs from. An operator needs the serial, the cabinet, who built it, where it sits right now, and whether that location is a floor or a warehouse.

Fields

FieldUse
compidMaintenance-system id of the unit. Stable inside that system.
serial_noManufacturer serial.
asset_idCatalog id. This is what a placement and a project line store.
vendor_name, cabinet_nameWho built it, and the cabinet model. Parts and warehouse counts group on the cabinet.
propertyWhere the maintenance record says the unit is. A floor property or a warehouse name.
statusOperational status on that record.

Comparisons

Pull serial_no and asset_id and match them to serial and asset_id on the active placement. Same serial, different property than casino_name, and the maintenance record has not caught the move. Same serial, a cabinet that does not match the placement’s cabinet_name, and you are not looking at the same build.

Pull property and compare it to the warehouse list. A unit whose property is a warehouse and that still has is_active on a floor placement is in two places.

Read

GET /api/assets

compid, serial_no, asset_id, vendor_name, cabinet_name, property, status. Search is token AND. --token excludes. * is a wildcard inside one word.

GET /api/assets/hub/{asset_id}

One unit, with the records that reference it.

Placement

A placement is one asset at one property for one span. The floor an operator bills is the set of placements still open at month-end. House number, bank position, theme, denomination, and hold are attributes of that span, not of the serial forever.

Fields

FieldUse
reference_keyThis placement. Not the asset.
asset_id, serialWhich unit.
casino_id, casino_nameWhich property.
zone, bank, location, zblWhere it sits on that floor. zbl is the three joined.
asset_noHouse number at that property. Often what a participation sheet calls the machine.
vendor_name, cabinet_name, theme_nameWhat was on it during this span.
Hold, denomPar and denomination for this span.
date_instl, lastconverWhen this span started. Install date, or the conversion date if this span is a convert.
is_activeOpen at the current floor. History includes closed spans. active_count and history_count come back with the list.
action, project_idOn the history read. The action that opened the span, and the project that did it.
rmvl_dateOn the history read. When the span ended.

Comparisons

Pull is_active placements and count distinct asset_id per casino_id. That is the machine count. Compare it to expected_entries on the month for the same property. A gap is a placement with no participation line, or a billed line whose placement is already closed.

Pull date_instl or lastconver and set it next to the month. A span that starts on the 12th did not play a full month. Compare that date to days-on-floor on the participation row before treating a low coin-in as a weak game.

Pull GET /api/slot-master/assets/{asset_id}/history and order the spans. Two open rows for one asset_id means a conversion or a move did not close the previous placement.

Read

GET /api/slot-master/casinos

casino_id, casino_name, active_count.

GET /api/slot-master/machines?casino_id=

Active placements for one property, including the latest month’s cipd, adw, win_index, actual_index, and last_report when the caller can read performance.

GET /api/slot-master/assets/{asset_id}/history

Every span for one asset: dates, action, project_id, removal.

Month

A month is participation for the placements that were on the floor. An operator needs three grains: the company total, the property, and the machine. Commission at the company total is not enough to explain a property, and a property total is not enough to explain one serial.

Fields

FieldUse
coinIn, actualWin, commissionCompany totals for the month on GET /api/executive. The Mom fields are the change versus the previous month.
series[].placements.machines, deltaPlayable machines at each month-end, and the change from the prior month.
series[].projects.open, closedJobs whose dates still span that month-end, and jobs whose end date falls in the month.
series[].reporting.reported, expected, pctProperties with a participation row versus properties that were expected to have one.
expected_entries, invoiced_entries, commissionPer property, per month, on the finance overview. uninvoiced_keys were expected and have no invoice. unexpected_keys were invoiced and were not on the expected floor.
cipd, adw, win_index, actual_index, last_reportPer active placement, for the latest reported month. Coin-in per day, actual win per day, and the index versus the house.

Comparisons

Pull commission on the executive read and the sum of commission across properties on GET /api/finance/overview for the same month. They should meet. If the executive number is ahead of the property sum, the property snapshot is older than the company total.

Pull reporting.pct for the month and the month before. A drop from a full month to a fraction means reports are still arriving. It does not mean the floor shrank. Confirm with placements.machines, which moves only when placements open or close.

Pull cipd for a serial and set date_instl or the project date_start beside it. A low per-day figure on a full-month neighbor, with an install inside the month, is a partial month. A low per-day figure with a start date before the month is the game.

Read

GET /api/executive?month=YYYY-MM

Company totals, month-over-month, and a 12-month series.

GET /api/finance/overview?from=YYYY-MM&to=YYYY-MM

Per property: expected lines, invoiced lines, commission. This is the commission read another ledger would call. Range max is 36 months.

GET /api/performance/themes-top?month=YYYY-MM

Themes for that month, rolled up from the placements that carried them.

Project

A project is one job for one client. It lists the assets involved, the start and end, the client, and who was on it. An install, a removal, a move, and a conversion are lines on that job. A repair of a machine that stayed in place is not a project.

Fields

FieldUse
reference_key, project_name, project_type, status, status_nameThe job and whether it is open.
casino_id, casino_name, tribe_nameThe client.
date_start, date_end, date_createdWhen the floor change ran. Open-at-month-end means date_start is on or before the month-end and date_end is after it. Both dates have to be present.
ims_lead_tech, ims_assistant_techs, assigned_to, created_byWho was on the job. The schedule read names the same people as tech and assisting.
ims_id, ims_project_numberThe schedule row this catalog job belongs to.
actions[].action_type, line_countHow the lines split: install, remove, move, convert, and the others. line_count is the number of assets in that action.
serial_number, zone, bank, location, theme_name, cabinetOn the printout. One row per asset on the job, with the position and the theme that moved.

Comparisons

Pull date_start and date_end and lay them on the performance month. A job that starts and ends inside the month changed the floor for part of the month. Compare those dates to placements.delta and to cipd on the serials in the printout before you read the month as a demand change.

Pull serial_number from the printout and asset_id from the placement history where project_id equals this reference_key. The printout is what the job claimed. The history is what the floor recorded. A serial on the printout with no span pointing at the project did not land. A span pointing at the project with no printout line was recorded outside the job.

Pull casino_id and the finance overview for that property for the months the dates overlap. The commission change on that property, minus the serials that were already there for the full month, is the part this job can explain.

Pull actions. A job with both install and remove lines is a swap. Count the smaller of the two line counts. That count belongs in the footprint change for the month of date_start, not in a second machine count.

Read

GET /api/projects/catalog?casino_id=

Job headers: name, client, type, status, date_start, date_end, line_count.

GET /api/projects/catalog/{reference_key}

One job, including who was assigned and the action mix.

GET /api/projects/catalog/{reference_key}/printout

The assets on the job: serial, position, theme, cabinet, denom, hold, and the settings that shipped with the line.

GET /api/projects/ims?casino_id=

The schedule at one property: project_no, date_start, date_end, tech, assisting, and matching_catalog when a catalog job is linked.

Service

Service is work on a unit that stayed on the floor. The application exposes the parts that cabinet takes and the warehouses holding cabinets that are off the floor. The work order itself stays on the maintenance connection. Do not read a project line as a repair, or a repair as a new placement.

Fields

FieldUse
item, descrip, reference_keyThe part.
item_familyFilter. Software rows are excluded unless exclude_software=false.
mfr, mfrpartno, vpartnoManufacturer and vendor part numbers. This is the join to a purchasing system.
locationWhere that part is stocked.
manufacturer, cabinet, warehouse countsOn the warehouse pivot. One row per manufacturer and cabinet. Columns are warehouses plus a total. A cell is how many of that cabinet are in that warehouse.

Comparisons

Pull cabinet_name on the asset and the parts whose family or description match that cabinet. A part issued against a cabinet the asset does not carry is the wrong bill of materials.

Pull the warehouse pivot for a cabinet and the active placements of that same cabinet. The pivot count is off the floor. The placement count is on the floor. A serial in the asset list with a warehouse property and an active placement is the drift between the two.

Read

GET /api/parts-inventory

Parts. Optional family.

GET /api/parts-inventory/items/{item}

One part.

GET /api/warehouse-inventory/pivot

Cabinet counts by warehouse.

GET /api/warehouse-inventory/serials

The serials behind a pivot cell.

Customer

The customer side is the property, the agreement that covers the machines, and the deal in the CRM. An operator comparing a deal to the floor needs the property id on both, the dates, and the count of machines each one claims.

Fields

FieldUse
reference_key, casino_name, casino_short, tribe_name, stateThe property. casino_short is the name on the finance overview.
licensed, salesWhether this house is a floor you bill or a prospect.
total_number_of_machinesThe house size the commercial record claims, not the placement count.
signed_master_agreement, executed_on, expiration, agreement_typeThe commercial term.
emaint_propertyThe property name on the maintenance connection. Join key when the names differ.
hubspot_deal_id, deal_name, amount, close_date, create_date, is_closed, is_closed_wonThe deal. casino_id ties it to the property. ims_id ties it to a schedule row when the deal became a job. product_units is the count the deal claims.
agreement_id, vendor_name, sales_order, agreement_date, total_priceA vendor agreement. This is the purchase of cabinets, not the casino’s participation deal.

Comparisons

Pull total_number_of_machines and active_count for the same casino_id. The first is the house. The second is your placements. Floor share is the second divided by the first, and only on houses that have both.

Pull product_units and close_date on an open deal and the project line_count where ims_id matches. A deal with units and no ims_id has not become a job. A job whose line count does not match product_units is a different scope than the deal that was sold.

Pull close_date and the project date_start for that ims_id. The deal closed when it was won. The floor changed on date_start. Commission for the months between those dates is still the previous floor.

Read

GET /api/commerce/casinos/{reference_key}

One property, including contacts and deals nested on the payload.

GET /api/commerce/deals?status=open|closed|won|all

Deals across properties. Default status is open.

GET /api/contracts

Vendor agreements: id, vendor, sales order, date, price.

Join map

Screens are views of these records. The join is the id in the left column.

FromTo
placement.asset_idasset.asset_id, and the serial on both
placement.casino_idproject.casino_id, finance row for that property, deal.casino_id
placement.project_idproject.reference_key
project.ims_idschedule reference_key, and deal.ims_id
printout.serial_numberplacement.serial for the casino_id on the project
asset.propertyemaint_property on the casino, or a warehouse column on the pivot
asset.cabinet_namewarehouse pivot row, and the parts for that cabinet

Connections

These are the systems a company can attach. The reads above stay on that company’s server. The connection supplies the record that a read does not store itself.

SystemWhat moves
eMaintFloor and service. Read the unit, the property, and the work on it. Write a floor change back. Join with emaint_property on the casino and compid on the asset.
HubSpotCustomers, contacts, and deals. Read them onto the property. Push catalog quantity the other way. Join the deal with casino_id and, when the deal has become a job, ims_id.
GoogleSign-in with the company’s email. That login opens only that company’s server. Gmail brings participation reports and paperwork in, and sends notices out. The month read is the result after those reports have landed.