Entity Sets

Every set is read-only and scoped to your museum and your key's test mode. Edm.DateTimeOffset values are ISO 8601 UTC timestamps, Edm.Guid values are UUIDs, Edm.Decimal amounts are in the museum's currency (major units). Properties marked data only cannot be used in $filter or $orderby.

Customers, Memberships and MembershipTypes carry updatedAt from the source record: when Loby last recorded a change to it. Not every change updates it, so treat it as a hint, not a guarantee. Visits, tickets, orders and transactions have no reliable change time in Loby, so those sets have no updatedAt; use their own dates (see Power BI & Excel).

Visits

One entry to the venue: a ticket scan, a member checkin, a manual entry or an event ticket scan.

Property	Type	Description
id	Edm.Guid	Unique identifier (key)
visitDate	Edm.DateTimeOffset	When the visit happened
origin	Edm.String	Ticket, Membership, Manual or EventTicket (data only)
quantityPerson … quantityYoungPerson	Edm.Int32	Visitors per role: quantityPerson, quantityAdult, quantityChild, quantityInfant, quantitySenior, quantityPensioner, quantityDisabled, quantityVeteran, quantityStudent, quantityYoungPerson (data only)
quantityTotal	Edm.Int32	Total visitors in the entry
ticketId	Edm.Guid	The scanned ticket, for ticket visits
eventTicketId	Edm.Guid	The scanned event ticket, for event visits
customerId	Edm.Guid	The customer, when known
departmentId	Edm.Guid	The department the visit was registered at
membershipId	Edm.Guid	The membership used, for member checkins
customerMuseumId	Edm.Guid	The visitor's home museum, when a partner-museum member visited you
customerMuseumName	Edm.String	That museum's name (data only)

Tickets

Property	Type	Description
id	Edm.Guid	Unique identifier (key)
createdAt	Edm.DateTimeOffset	When the ticket was issued
expiresAt	Edm.DateTimeOffset	When the ticket expires
number	Edm.Int32	Ticket number within the museum
globalNumber	Edm.Int32	Ticket number across Loby
used	Edm.Boolean	Whether the ticket has been used
batchCode	Edm.String	The batch, for tickets issued in batches
ticketTypeId	Edm.Guid	The ticket type
customerId	Edm.Guid	The buyer, when known
orderId	Edm.Guid	The order it was sold on
locationId	Edm.Guid	The location it admits to
timeSlotId	Edm.Guid	The time slot, for timed tickets

Customers

Property	Type	Description
id	Edm.Guid	Unique identifier (key)
createdAt	Edm.DateTimeOffset	When the customer was created
updatedAt	Edm.DateTimeOffset	When Loby last recorded a change to the customer
firstName, lastName, name	Edm.String	Name fields
email	Edm.String	Email address
phone	Edm.String	Phone number
memberNumber	Edm.Int32	Member number, for members
archived	Edm.Boolean	Whether the customer is archived
subscribedToNewsletter	Edm.Boolean	Newsletter consent
address, postalCode, city, country	Edm.String	Address fields
gender, nationality, preferredLanguage	Edm.String	Profile fields

Memberships

Property	Type	Description
id	Edm.Guid	Unique identifier (key)
createdAt	Edm.DateTimeOffset	When the membership was created
updatedAt	Edm.DateTimeOffset	When Loby last recorded a change to the membership
startDate	Edm.DateTimeOffset	Validity start
endDate	Edm.DateTimeOffset	Validity end; null while open
autoRenew	Edm.Boolean	Whether it renews automatically
autoRenewed	Edm.Boolean	Whether it was created by an automatic renewal
renewal	Edm.Boolean	Whether this row is a renewal of an earlier membership
origin	Edm.String	Where it was created, e.g. WEB, POS, ADMIN
membershipTypeName	Edm.String	The membership type's name (data only)
customerId	Edm.Guid	The member
secondaryCustomerId	Edm.Guid	The second member, on couple memberships
membershipTypeId	Edm.Guid	The membership type
orderId	Edm.Guid	The order it was sold on

Orders

The ORDER rows of the transactions ledger: one row per completed sale.

Property	Type	Description
id	Edm.Guid	Unique identifier (key)
orderDate	Edm.DateTimeOffset	When the order was completed
orderNumber	Edm.Int32	Order number
amount, fee, net, vatAmount	Edm.Decimal	Sale total, payment fee, net and VAT
channel	Edm.String	Sales channel, e.g. POS, WEB
paymentMethod	Edm.String	e.g. CREDIT_CARD, CASH, MOBILE_PAY
cardBrand	Edm.String	Card brand, for card payments
psp	Edm.String	Payment service provider
bankReference	Edm.String	Reference on the bank statement
customerId	Edm.Guid	The buyer, when known

Transactions

The whole money ledger: orders, refunds and payouts, told apart by type.

Property	Type	Description
id	Edm.Guid	Unique identifier (key)
transactionDate	Edm.DateTimeOffset	When the transaction happened
type	Edm.String	ORDER, REFUND or PAYOUT
amount, fee, net, vatAmount	Edm.Decimal	Amounts; negative on refunds and payouts
channel, paymentMethod, cardBrand, wallet, psp, bankReference	Edm.String	Payment details
includeInBalance	Edm.Boolean	Whether the row counts toward the payout balance
stripeConnect	Edm.Boolean	Whether it ran through Stripe Connect
orderNumber	Edm.Int32	The order number, on order rows
orderId	Edm.Guid	The order, on order and refund rows
customerId	Edm.Guid	The buyer, when known

TicketTypes

Property	Type	Description
id	Edm.Guid	Unique identifier (key)
name	Edm.String	Name
sku	Edm.String	SKU, for bookkeeping
price	Edm.Decimal	Price
locationId	Edm.Guid	The location it admits to
createdAt	Edm.DateTimeOffset	When it was created

MembershipTypes

Property	Type	Description
id	Edm.Guid	Unique identifier (key)
name	Edm.String	Name
sku	Edm.String	SKU, for bookkeeping
price	Edm.Decimal	Price
renewalPrice	Edm.Decimal	Renewal price, when it differs
couple	Edm.Boolean	Whether it covers two members
createdAt	Edm.DateTimeOffset	When it was created
updatedAt	Edm.DateTimeOffset	When Loby last recorded a change to it

Departments

Property	Type	Description
id	Edm.Guid	Unique identifier (key)
name	Edm.String	Name

Locations

Property	Type	Description
id	Edm.Guid	Unique identifier (key)
name	Edm.String	Name