Response¶
Response Schemas¶
integrify.clopos.schemas.response.BaseResponse
pydantic-model
¶
Bases: BaseModel
Fields:
integrify.clopos.schemas.response.ObjectResponse
pydantic-model
¶
Bases: BaseResponse, Generic[_ObjectTypeT]
Fields:
integrify.clopos.schemas.response.ObjectListResponse
pydantic-model
¶
Bases: PaginatedResponse, Generic[_ObjectTypeT]
Fields:
-
success(Literal[True]) -
message(UnsetField[str]) -
time(int) -
timestamp(str) -
unix(int) -
total(UnsetField[int]) -
sorts(UnsetField[list[str]]) -
data(list[_ObjectTypeT])
data
pydantic-field
¶
success
pydantic-field
¶
Success status of the request
message
pydantic-field
¶
Success message
time
pydantic-field
¶
Response time (ms)
timestamp
pydantic-field
¶
ISO 8601 date
unix
pydantic-field
¶
Unix timestamp of the response
total
pydantic-field
¶
Number of items returned
sorts
pydantic-field
¶
List of sortable fields
integrify.clopos.schemas.response.ErrorResponse
pydantic-model
¶
integrify.clopos.schemas.response.AuthResponse
pydantic-model
¶
Bases: BaseModel
Fields:
-
success(Literal[True]) -
token(str) -
token_type(str) -
expires_in(int) -
message(str)
Response Object Schemas¶
Main objects¶
integrify.clopos.schemas.objects.main.Venue
pydantic-model
¶
Bases: BaseModel
Fields:
integrify.clopos.schemas.objects.main.User
pydantic-model
¶
Bases: Timestamp
Fields:
-
created_at(str) -
updated_at(str) -
deleted_at(UnsetOrNoneField[str]) -
id(int) -
email(UnsetOrNoneField[str]) -
username(str) -
first_name(UnsetOrNoneField[str]) -
last_name(UnsetOrNoneField[str]) -
pin(str) -
card(UnsetOrNoneField[str]) -
mobile_number(UnsetOrNoneField[str]) -
owner(int) -
hide(int) -
salary(UnsetOrNoneField[int]) -
barcode(UnsetOrNoneField[str]) -
tip_message(UnsetOrNoneField[str]) -
can_receive_tips(UnsetOrNoneField[bool]) -
login_at(UnsetOrNoneField[str]) -
status(bool) -
bonus_balance_id(UnsetOrNoneField[int]) -
properties(UnsetOrNoneField[Union[dict, list]]) -
image(UnsetOrNoneField[list[str]])
id
pydantic-field
¶
Unique user identifier
email
pydantic-field
¶
Email address associated with the user
username
pydantic-field
¶
Display name shown in the POS
first_name
pydantic-field
¶
First name of the user
last_name
pydantic-field
¶
last name of the user
pin
pydantic-field
¶
POS PIN code
card
pydantic-field
¶
POS card number
mobile_number
pydantic-field
¶
Mobile number of the user
owner
pydantic-field
¶
1 if the user owns the brand, otherwise 0
hide
pydantic-field
¶
1 if hidden from POS selection, otherwise 0
salary
pydantic-field
¶
Salary of the user
barcode
pydantic-field
¶
POS barcode number
tip_message
pydantic-field
¶
Tip message shown in the POS
can_receive_tips
pydantic-field
¶
Whether the user can receive tips or not
login_at
pydantic-field
¶
Timestamp when the user logged in
status
pydantic-field
¶
Indicates whether the user account is active
bonus_balance_id
pydantic-field
¶
Balance ID of the user
properties
pydantic-field
¶
User properties
image
pydantic-field
¶
User images
created_at
pydantic-field
¶
The timestamp when the object was created
updated_at
pydantic-field
¶
The timestamp when the object was last updated
deleted_at
pydantic-field
¶
The timestamp when the object was deleted
integrify.clopos.schemas.objects.main.Group
pydantic-model
¶
Bases: Timestamp
Fields:
-
created_at(str) -
updated_at(str) -
deleted_at(UnsetOrNoneField[str]) -
id(int) -
name(str) -
discount_type(UnsetOrNoneField[DiscountType]) -
discount_value(int) -
system_type(str)
id
pydantic-field
¶
The unique identifier for the customer group
name
pydantic-field
¶
The name of the customer group
discount_type
pydantic-field
¶
The type of discount applied to the customer group
discount_value
pydantic-field
¶
The discount applied to the customer group
system_type
pydantic-field
¶
The system type of the customer group
created_at
pydantic-field
¶
The timestamp when the object was created
updated_at
pydantic-field
¶
The timestamp when the object was last updated
deleted_at
pydantic-field
¶
The timestamp when the object was deleted
integrify.clopos.schemas.objects.main.Customer
pydantic-model
¶
Bases: Timestamp
Fields:
-
created_at(str) -
updated_at(str) -
deleted_at(UnsetOrNoneField[str]) -
id(int) -
venue_id(int) -
cid(str) -
group_id(int) -
group(UnsetOrNoneField[Group]) -
balance_id(int) -
name(str) -
discount(int) -
email(UnsetOrNoneField[str]) -
phone(UnsetOrNoneField[str]) -
phones(list[str]) -
address(UnsetOrNoneField[str]) -
addresses(list[str]) -
description(UnsetOrNoneField[str]) -
address_data(UnsetOrNoneField[list[str]]) -
bonus_balance_id(UnsetOrNoneField[int]) -
balance(UnsetOrNoneField[Balance]) -
cashback_balance_id(UnsetOrNoneField[int]) -
cashback_balance(UnsetOrNoneField[Balance]) -
spent(Decimal) -
total_discount(Decimal) -
total_bonus(Decimal) -
receipt_count(int) -
gender(UnsetOrNoneField[int]) -
date_of_birth(UnsetOrNoneField[str]) -
code(UnsetOrNoneField[str]) -
source(UnsetOrNoneField[str]) -
reference_id(UnsetOrNoneField[str]) -
phone_verified_at(UnsetOrNoneField[str]) -
status(bool) -
can_use_loyalty_system(UnsetOrNoneField[bool]) -
is_verified(UnsetOrNoneField[bool])
id
pydantic-field
¶
The unique identifier for the customer
venue_id
pydantic-field
¶
The ID of the venue the customer belongs to
cid
pydantic-field
¶
The unique identifier for the customer in the POS
group_id
pydantic-field
¶
The ID of the customer group they belong to
group
pydantic-field
¶
An object containing details of the customer's group
balance_id
pydantic-field
¶
The balance ID of the customer
name
pydantic-field
¶
The name of the customer
discount
pydantic-field
¶
The discount applied to the customer
email
pydantic-field
¶
The email address of the customer
phone
pydantic-field
¶
The primary phone number of the customer
phones = []
pydantic-field
¶
An array of the customer's phone numbers
address
pydantic-field
¶
The address of the customer
addresses = []
pydantic-field
¶
An array of the customer's saved addresses
description
pydantic-field
¶
The description of the customer
address_data
pydantic-field
¶
The customer's address data
bonus_balance_id
pydantic-field
¶
The ID of the customer's bonus balance
balance
pydantic-field
¶
Contains details about the customer's store credit balance
cashback_balance_id
pydantic-field
¶
The ID of the customer's cashback balance
cashback_balance
pydantic-field
¶
Contains details about the customer's cashback balance
spent
pydantic-field
¶
The total amount spent by the customer
total_discount
pydantic-field
¶
The total discount applied to the customer
total_bonus
pydantic-field
¶
The total amount of bonus points applied to the customer
receipt_count
pydantic-field
¶
The total number of receipts for the customer
gender
pydantic-field
¶
The gender of the customer
date_of_birth
pydantic-field
¶
The date of birth of the customer
code
pydantic-field
¶
The code of the customer
source
pydantic-field
¶
The source of the customer
reference_id
pydantic-field
¶
The reference ID of the customer
phone_verified_at
pydantic-field
¶
The timestamp when the customer's phone number was verified
status
pydantic-field
¶
The status of the customer account
can_use_loyalty_system
pydantic-field
¶
Whether the customer can use the loyalty system or not
is_verified
pydantic-field
¶
Whether the customer is verified or not
created_at
pydantic-field
¶
The timestamp when the object was created
updated_at
pydantic-field
¶
The timestamp when the object was last updated
deleted_at
pydantic-field
¶
The timestamp when the object was deleted
integrify.clopos.schemas.objects.main.Category
pydantic-model
¶
Bases: Timestamp
Fields:
-
created_at(str) -
updated_at(str) -
deleted_at(UnsetOrNoneField[str]) -
id(int) -
name(str) -
status(int) -
hidden(bool) -
type(CategoryType) -
image(UnsetOrNoneField[Image]) -
position(UnsetOrNoneField[int]) -
emenu_position(UnsetOrNoneField[int]) -
meta(UnsetOrNoneField[dict]) -
emenu_hidden(UnsetOrNoneField[bool]) -
code(UnsetOrNoneField[str]) -
lft(int) -
rgt(int) -
depth(int) -
parent_id(UnsetOrNoneField[int]) -
slug(UnsetOrNoneField[str]) -
color(UnsetOrNoneField[str]) -
properties(UnsetOrNoneField[Union[dict, list]]) -
media(list[Media]) -
children(UnsetOrNoneField[list[Category]])
id
pydantic-field
¶
Unique identifier
name
pydantic-field
¶
Name of the category
status
pydantic-field
¶
1 = active, 0 = inactive
hidden
pydantic-field
¶
Whether the category is hidden or not
type
pydantic-field
¶
product_category, ingredient_category, accounting_category
image
pydantic-field
¶
Image of the category
position
pydantic-field
¶
The position of the category
emenu_position
pydantic-field
¶
The position of the category in the eMenu
meta
pydantic-field
¶
Additional settings and visibility info
emenu_hidden
pydantic-field
¶
Whether the category is hidden in the eMenu or not
code
pydantic-field
¶
The code of the category
lft
pydantic-field
¶
Nested set boundaries
rgt
pydantic-field
¶
Nested set boundaries
depth
pydantic-field
¶
Depth of the subcategory
parent_id
pydantic-field
¶
Parent category ID, null for root
slug
pydantic-field
¶
URL-friendly identifier
color
pydantic-field
¶
HEX color
properties
pydantic-field
¶
Additional settings and visibility info
media
pydantic-field
¶
Media of the category
children
pydantic-field
¶
Subcategories
created_at
pydantic-field
¶
The timestamp when the object was created
updated_at
pydantic-field
¶
The timestamp when the object was last updated
deleted_at
pydantic-field
¶
The timestamp when the object was deleted
integrify.clopos.schemas.objects.main.Station
pydantic-model
¶
Bases: Timestamp
Fields:
-
created_at(str) -
updated_at(str) -
deleted_at(UnsetOrNoneField[str]) -
id(int) -
name(str) -
status(int) -
type(UnsetOrNoneField[int]) -
printable(UnsetOrNoneField[int]) -
can_print(UnsetOrNoneField[bool]) -
reminder_enabled(UnsetOrNoneField[bool]) -
meta(UnsetOrNoneField[dict]) -
description(UnsetOrNoneField[str])
id
pydantic-field
¶
Unique identifier
name
pydantic-field
¶
Name of the station
status
pydantic-field
¶
1 = active, 0 = inactive
type
pydantic-field
¶
Type of the station
printable
pydantic-field
¶
Whether the station is printable or not
can_print
pydantic-field
¶
Can be redirected to a printer
reminder_enabled
pydantic-field
¶
Is reminder notification on?
meta
pydantic-field
¶
Additional settings and visibility info
description
pydantic-field
¶
Optional description
created_at
pydantic-field
¶
The timestamp when the object was created
updated_at
pydantic-field
¶
The timestamp when the object was last updated
deleted_at
pydantic-field
¶
The timestamp when the object was deleted
integrify.clopos.schemas.objects.main.Product
pydantic-model
¶
Bases: Timestamp
Fields:
-
deleted_at(UnsetOrNoneField[str]) -
id(int) -
cid(UnsetOrNoneField[str]) -
parent_id(UnsetOrNoneField[int]) -
station_id(UnsetOrNoneField[int]) -
category_id(UnsetOrNoneField[int]) -
unit_id(UnsetOrNoneField[int]) -
net_output(UnsetOrNoneField[int]) -
type(UnsetOrNoneField[ProductType]) -
name(str) -
parent_name(UnsetOrNoneField[str]) -
image(UnsetOrNoneField[Image]) -
position(UnsetOrNoneField[int]) -
description(UnsetOrNoneField[str]) -
barcode(UnsetOrNoneField[str]) -
gov_code(UnsetOrNoneField[str]) -
cost(UnsetOrNoneField[Decimal]) -
status(UnsetOrNoneField[int]) -
hidden(UnsetOrNoneField[bool]) -
sold_by_weight(UnsetOrNoneField[bool]) -
max_age(UnsetOrNoneField[int]) -
discountable(UnsetOrNoneField[bool]) -
giftable(UnsetOrNoneField[bool]) -
has_modifications(UnsetOrNoneField[bool]) -
meta(UnsetOrNoneField[dict]) -
setting(UnsetOrNoneField[TimerSetting]) -
modifications(UnsetOrNoneField[list[Variant]]) -
modificator_groups(UnsetOrNoneField[list[ModifierGroup]]) -
recipe(UnsetOrNoneField[list[Product]]) -
packages(UnsetOrNoneField[list[Package]]) -
variants(list[Product]) -
e_menu_id(UnsetOrNoneField[int]) -
emenu_category_id(UnsetOrNoneField[int]) -
emenu_position(UnsetOrNoneField[int]) -
emenu_hidden(UnsetOrNoneField[bool]) -
accounting_category_id(UnsetOrNoneField[int]) -
price(Decimal) -
prices(UnsetOrNoneField[list[Price]]) -
cost_price(UnsetOrNoneField[Decimal]) -
markup_rate(UnsetOrNoneField[Decimal]) -
taxes(UnsetOrNoneField[list[Tax]]) -
cooking_time(UnsetOrNoneField[int]) -
ignore_service_charge(UnsetOrNoneField[bool]) -
inventory_behavior(UnsetOrNoneField[int]) -
low_stock(UnsetOrNoneField[int]) -
unit_weight(UnsetOrNoneField[int]) -
name_slug(UnsetOrNoneField[str]) -
full_name(UnsetOrNoneField[str]) -
gross_margin(UnsetOrNoneField[Decimal]) -
slug(UnsetOrNoneField[str]) -
color(UnsetOrNoneField[str]) -
venues(UnsetOrNoneField[list[Venue]]) -
properties(UnsetOrNoneField[Union[dict, list]]) -
media(UnsetOrNoneField[list[Media]]) -
tags(UnsetOrNoneField[list[dict]]) -
total_quantity(UnsetOrNoneField[int]) -
total_cost(UnsetOrNoneField[Decimal]) -
average_cost(UnsetOrNoneField[Decimal]) -
open_receipts_count(UnsetOrNoneField[int]) -
created_at(UnsetOrNoneField[str]) -
updated_at(UnsetOrNoneField[str])
id
pydantic-field
¶
Unique identifier
cid
pydantic-field
¶
Unique identifier
parent_id
pydantic-field
¶
Parent product ID, null for root
station_id
pydantic-field
¶
The ID of the station the product belongs to
category_id
pydantic-field
¶
The ID of the category the product belongs to
unit_id
pydantic-field
¶
The ID of the unit the product belongs to
net_output
pydantic-field
¶
Net output of the product
type
pydantic-field
¶
product, ingredient, accounting
name
pydantic-field
¶
The main name of the product
parent_name
pydantic-field
¶
The name of the parent product
image
pydantic-field
¶
Image of the product
position
pydantic-field
¶
The position of the product in the menu
description
pydantic-field
¶
Description of the product
barcode
pydantic-field
¶
The barcode of the product
gov_code
pydantic-field
¶
The government code of the product
cost
pydantic-field
¶
The cost of the product
status
pydantic-field
¶
1 = active, 0 = inactive
hidden
pydantic-field
¶
Whether the product is hidden or not
sold_by_weight
pydantic-field
¶
Whether the product is sold by weight or not
max_age
pydantic-field
¶
The maximum age of the product
discountable
pydantic-field
¶
Whether the product is discountable or not
giftable
pydantic-field
¶
Whether the product is giftable or not
has_modifications
pydantic-field
¶
If true, the product has variants in the modifications array
meta
pydantic-field
¶
Additional settings and visibility info
setting
pydantic-field
¶
Pricing rules for TIMER type products. See Timer Settings
modifications
pydantic-field
¶
List of variants for GOODS type products. See Variant Object
modificator_groups
pydantic-field
¶
List of modificator groups for GOODS type products. See Modificator Group Object
recipe
pydantic-field
¶
Recipe for DISH or PREPARATION type products. See Recipe Item.
packages
pydantic-field
¶
Packages for INGREDIENT type products. See Package Object.
variants = []
pydantic-field
¶
Variants of the product
e_menu_id
pydantic-field
¶
The ID of the eMenu the product belongs to
emenu_category_id
pydantic-field
¶
The ID of the category the product belongs to in eMenu
emenu_position
pydantic-field
¶
The position of the product in eMenu
emenu_hidden
pydantic-field
¶
Whether the product is hidden in eMenu or not
accounting_category_id
pydantic-field
¶
The ID of the category the product belongs to in accounting
price
pydantic-field
¶
The base price of the product (variants may have their own prices)
prices
pydantic-field
¶
The prices of the product
cost_price
pydantic-field
¶
The cost price of the product
markup_rate
pydantic-field
¶
The markup rate of the product
taxes
pydantic-field
¶
Taxes applied to the product
cooking_time
pydantic-field
¶
The cooking time of the product
ignore_service_charge
pydantic-field
¶
Whether the product should ignore the service charge or not
inventory_behavior
pydantic-field
¶
The inventory behavior of the product
low_stock
pydantic-field
¶
Low stock count
unit_weight
pydantic-field
¶
The weight of the product in grams
name_slug
pydantic-field
¶
The slug of the product name
full_name
pydantic-field
¶
The full product name, including variant information
gross_margin
pydantic-field
¶
The gross margin of the product
slug
pydantic-field
¶
The slug of the product
color
pydantic-field
¶
The color of the product
venues
pydantic-field
¶
The venues the product is available in
properties
pydantic-field
¶
The properties of the product
media
pydantic-field
¶
Media of the product
tags
pydantic-field
¶
Tags of the product
total_quantity
pydantic-field
¶
The total quantity of the product
total_cost
pydantic-field
¶
The total cost of the product
average_cost
pydantic-field
¶
The average cost of the product
open_receipts_count
pydantic-field
¶
The number of open receipts for the product
created_at
pydantic-field
¶
The timestamp when the object was created
updated_at
pydantic-field
¶
The timestamp when the object was last updated
deleted_at
pydantic-field
¶
The timestamp when the object was deleted
integrify.clopos.schemas.objects.main.PaymentMethod
pydantic-model
¶
Bases: Timestamp
Fields:
-
created_at(str) -
updated_at(str) -
deleted_at(UnsetOrNoneField[str]) -
id(int) -
name(str) -
customer_required(int) -
is_system(int) -
balance_id(UnsetOrNoneField[int]) -
balance(UnsetOrNoneField[Balance]) -
service(UnsetOrNoneField[dict]) -
split(UnsetOrNoneField[int]) -
status(dict[str, int])
id
pydantic-field
¶
The unique identifier for the payment method
name
pydantic-field
¶
The name of the payment method (e.g., "Cash", "Card")
customer_required
pydantic-field
¶
Whether a customer must be attached to the transaction (1 for yes, 0 for no)
is_system
pydantic-field
¶
Indicates if it’s a system-default payment method
balance_id
pydantic-field
¶
The ID of the balance associated with the payment method
balance
pydantic-field
¶
An object containing details of the associated balance account
service
pydantic-field
¶
Details of any external service integrated with this payment method
split
pydantic-field
¶
Indicates if this payment method can be used for split payments
status
pydantic-field
¶
Map of venue_id -> 0/1 availability for this method
created_at
pydantic-field
¶
The timestamp when the object was created
updated_at
pydantic-field
¶
The timestamp when the object was last updated
deleted_at
pydantic-field
¶
The timestamp when the object was deleted
integrify.clopos.schemas.objects.main.SaleType
pydantic-model
¶
Bases: Timestamp
Fields:
-
created_at(str) -
updated_at(str) -
deleted_at(UnsetOrNoneField[str]) -
id(int) -
name(str) -
system_type(UnsetOrNoneField[str]) -
status(dict[str, int]) -
channel(UnsetOrNoneField[str]) -
service_charge_rate(UnsetOrNoneField[Decimal]) -
payment_method_id(UnsetOrNoneField[int]) -
position(UnsetOrNoneField[int]) -
payment_method(UnsetOrNoneField[PaymentMethod]) -
media(UnsetOrNoneField[list[Media]])
id
pydantic-field
¶
The unique identifier for the sale type
name
pydantic-field
¶
The name of the sale type (e.g., "In-store", "Delivery")
system_type
pydantic-field
¶
A system-defined type identifier (e.g., "IN", "DELIVERY")
status
pydantic-field
¶
Map of venue_id -> 0/1 availability for this method
channel
pydantic-field
¶
The channel the sale type belongs to
service_charge_rate
pydantic-field
¶
The service charge rate associated with this sale type
payment_method_id
pydantic-field
¶
The ID of the default payment method for this sale type, if any
position
pydantic-field
¶
The position of the sale type in the list of sale types
payment_method
pydantic-field
¶
An object containing details of the associated payment method
media
pydantic-field
¶
Media of the sale type
created_at
pydantic-field
¶
The timestamp when the object was created
updated_at
pydantic-field
¶
The timestamp when the object was last updated
deleted_at
pydantic-field
¶
The timestamp when the object was deleted
integrify.clopos.schemas.objects.main.Order
pydantic-model
¶
Bases: Timestamp
Fields:
-
created_at(str) -
updated_at(str) -
deleted_at(UnsetOrNoneField[str]) -
id(int) -
venue_id(UnsetOrNoneField[int]) -
type(UnsetOrNoneField[str]) -
integration(UnsetOrNoneField[str]) -
integration_uuid(UnsetOrNoneField[str]) -
integration_id(UnsetOrNoneField[int]) -
customer_ref_id(UnsetOrNoneField[str]) -
integration_status(UnsetOrNoneField[str]) -
integration_response(UnsetOrNoneField[str]) -
customer_id(UnsetOrNoneField[int]) -
receive_user_id(UnsetOrNoneField[int]) -
receive_terminal_id(UnsetOrNoneField[int]) -
status(OrderStatus) -
payload(OrderPayload) -
receipt_id(UnsetOrNoneField[int]) -
payment_status(UnsetOrNoneField[str]) -
total_amount(UnsetOrNoneField[Decimal]) -
line_items(UnsetOrNoneField[list[OrderItem]]) -
sale_type(UnsetOrNoneField[SaleType]) -
payment_method_id(UnsetOrNoneField[int]) -
payment_method(UnsetOrNoneField[PaymentMethod]) -
properties(UnsetOrNoneField[dict])
id
pydantic-field
¶
The unique identifier for the order
venue_id
pydantic-field
¶
The ID of the venue associated with the order
type
pydantic-field
¶
The ID of the sale type associated with the order
integration
pydantic-field
¶
The integration channel associated with the order
integration_uuid
pydantic-field
¶
The UUID of the integration associated with the order
integration_id
pydantic-field
¶
The ID of the integration associated with the order
customer_ref_id
pydantic-field
¶
The reference ID of the customer associated with the order
integration_status
pydantic-field
¶
The status of the integration associated with the order
integration_response
pydantic-field
¶
The response from the integration associated with the order
customer_id
pydantic-field
¶
The ID of the customer associated with the order
receive_user_id
pydantic-field
¶
The ID of the user who received the order
receive_terminal_id
pydantic-field
¶
The ID of the terminal where the order was received
status
pydantic-field
¶
Current lifecycle state. accepted orders are sent to the POS
payload
pydantic-field
¶
Payload of the order
receipt_id
pydantic-field
¶
Linked open receipt ID once the POS accepts the order
payment_status
pydantic-field
¶
Payment state (e.g., pending, paid)
total_amount
pydantic-field
¶
Order grand total
line_items
pydantic-field
¶
Line items of the order
sale_type
pydantic-field
¶
An object containing details of the associated sale type
payment_method_id
pydantic-field
¶
The ID of the payment method associated with the order
payment_method
pydantic-field
¶
An object containing details of the associated payment method
properties
pydantic-field
¶
Additional properties of the order
created_at
pydantic-field
¶
The timestamp when the object was created
updated_at
pydantic-field
¶
The timestamp when the object was last updated
deleted_at
pydantic-field
¶
The timestamp when the object was deleted
integrify.clopos.schemas.objects.main.Receipt
pydantic-model
¶
Bases: Timestamp
Fields:
-
created_at(str) -
updated_at(str) -
deleted_at(UnsetOrNoneField[str]) -
id(int) -
venue_id(UnsetOrNoneField[int]) -
cash_shift_cid(UnsetOrNoneField[str]) -
cid(UnsetOrNoneField[str]) -
user_id(UnsetOrNoneField[int]) -
open_by_user_id(UnsetOrNoneField[int]) -
close_by_user_id(UnsetOrNoneField[int]) -
courier_id(UnsetOrNoneField[int]) -
seller_id(UnsetOrNoneField[int]) -
terminal_id(UnsetOrNoneField[int]) -
source(UnsetOrNoneField[str]) -
closed_terminal_id(UnsetOrNoneField[int]) -
service_notification_id(UnsetOrNoneField[int]) -
table_id(UnsetOrNoneField[int]) -
hall_id(UnsetOrNoneField[int]) -
customer_id(UnsetOrNoneField[int]) -
sale_type_id(UnsetOrNoneField[int]) -
is_returns(UnsetOrNoneField[bool]) -
guests(UnsetOrNoneField[int]) -
status(UnsetOrNoneField[int]) -
local_status(UnsetOrNoneField[int]) -
lock(UnsetOrNoneField[bool]) -
inventory_status(UnsetOrNoneField[int]) -
report_status(UnsetOrNoneField[int]) -
meta(UnsetOrNoneField[dict]) -
suspicion(UnsetOrNoneField[int]) -
printed(UnsetOrNoneField[bool]) -
total(UnsetOrNoneField[Decimal]) -
subtotal(UnsetOrNoneField[Decimal]) -
original_subtotal(UnsetOrNoneField[Decimal]) -
gift_total(UnsetOrNoneField[Decimal]) -
total_cost(UnsetOrNoneField[Decimal]) -
payment_methods(UnsetOrNoneField[list[ReceiptPaymentMethod]]) -
fiscal_id(UnsetOrNoneField[str]) -
by_cash(UnsetOrNoneField[Decimal]) -
by_card(UnsetOrNoneField[Decimal]) -
remaining(UnsetOrNoneField[Decimal]) -
customer_discount_type(UnsetOrNoneField[int]) -
discount_type(UnsetOrNoneField[DiscountType]) -
discount_value(UnsetOrNoneField[Decimal]) -
discount_rate(UnsetOrNoneField[Decimal]) -
rps_discount(UnsetOrNoneField[Decimal]) -
service_charge(UnsetOrNoneField[Decimal]) -
service_charge_value(UnsetOrNoneField[Decimal]) -
i_tax(UnsetOrNoneField[Decimal]) -
delivery_fee(UnsetOrNoneField[Decimal]) -
e_tax(UnsetOrNoneField[Decimal]) -
total_tax(UnsetOrNoneField[Decimal]) -
description(UnsetOrNoneField[str]) -
address(UnsetOrNoneField[str]) -
terminal_version(UnsetOrNoneField[str]) -
loyalty_type(UnsetOrNoneField[int]) -
loyalty_value(UnsetOrNoneField[Decimal]) -
order_status(UnsetOrNoneField[OrderStatus]) -
order_number(UnsetOrNoneField[str]) -
receipt_products(UnsetOrNoneField[list[ReceiptProduct]]) -
terminal_updated_at(UnsetOrNoneField[str]) -
closed_at(UnsetOrNoneField[str]) -
shift_date(UnsetOrNoneField[str]) -
gift_count(UnsetOrNoneField[int]) -
total_discount(UnsetOrNoneField[Decimal]) -
properties(UnsetOrNoneField[dict])
id
pydantic-field
¶
Unique receipt identifier
venue_id
pydantic-field
¶
The ID of the venue associated with the receipt
cash_shift_cid
pydantic-field
¶
The UUID of the cash shift associated with the receipt
cid
pydantic-field
¶
Transaction UUID
user_id
pydantic-field
¶
The ID of the user associated with the receipt
open_by_user_id
pydantic-field
¶
The ID of the user who opened the receipt
close_by_user_id
pydantic-field
¶
The ID of the user who closed the receipt
courier_id
pydantic-field
¶
The ID of the courier associated with the receipt
seller_id
pydantic-field
¶
The ID of the seller associated with the receipt
terminal_id
pydantic-field
¶
The ID of the terminal associated with the receipt
source
pydantic-field
¶
The source of the receipt
closed_terminal_id
pydantic-field
¶
The ID of the terminal where the receipt was closed
service_notification_id
pydantic-field
¶
The ID of the service notification associated with the receipt
table_id
pydantic-field
¶
The ID of the table associated with the receipt
hall_id
pydantic-field
¶
The ID of the hall associated with the receipt
customer_id
pydantic-field
¶
The ID of the customer associated with the receipt
sale_type_id
pydantic-field
¶
Sale type identifier
is_returns
pydantic-field
¶
Whether the receipt is a return
guests
pydantic-field
¶
The number of guests associated with the receipt
status
pydantic-field
¶
Receipt status code
local_status = None
pydantic-field
¶
Receipt local status
lock
pydantic-field
¶
Lock identifier
inventory_status
pydantic-field
¶
Inventory status code
report_status
pydantic-field
¶
Report status code
meta
pydantic-field
¶
Receipt meta data
suspicion
pydantic-field
¶
Suspicion level code
printed
pydantic-field
¶
Whether the receipt has been printed
total
pydantic-field
¶
Total amount collected
subtotal
pydantic-field
¶
Subtotal before adjustments
original_subtotal
pydantic-field
¶
Receipt original subtotal
gift_total
pydantic-field
¶
Receipt gift total
total_cost
pydantic-field
¶
Receipt total cost
payment_methods
pydantic-field
¶
Payment methods associated with the receipt
fiscal_id
pydantic-field
¶
Receipt fiscal ID
by_cash
pydantic-field
¶
Amount collected by cash
by_card
pydantic-field
¶
Amount collected by card
remaining
pydantic-field
¶
Remaining amount
customer_discount_type = None
pydantic-field
¶
Customer discount type
discount_type
pydantic-field
¶
Discount type
discount_value
pydantic-field
¶
Discount value
discount_rate
pydantic-field
¶
Discount rate
rps_discount
pydantic-field
¶
RPS discount
service_charge
pydantic-field
¶
Service charge
service_charge_value
pydantic-field
¶
Service charge value
i_tax
pydantic-field
¶
I tax
delivery_fee
pydantic-field
¶
Delivery fee
e_tax
pydantic-field
¶
E tax
total_tax
pydantic-field
¶
Total tax
description
pydantic-field
¶
Receipt description
address
pydantic-field
¶
Receipt address
terminal_version
pydantic-field
¶
Receipt terminal version
loyalty_type
pydantic-field
¶
Loyalty type
loyalty_value
pydantic-field
¶
Loyalty value
order_status
pydantic-field
¶
Order status code
order_number
pydantic-field
¶
Order number
receipt_products = None
pydantic-field
¶
Receipt products
terminal_updated_at
pydantic-field
¶
Receipt terminal updated at
closed_at
pydantic-field
¶
Receipt closed at
shift_date
pydantic-field
¶
Shift date associated with the receipt
gift_count
pydantic-field
¶
Receipt gift count
total_discount
pydantic-field
¶
Receipt total discount
properties
pydantic-field
¶
Receipt properties
created_at
pydantic-field
¶
The timestamp when the object was created
updated_at
pydantic-field
¶
The timestamp when the object was last updated
deleted_at
pydantic-field
¶
The timestamp when the object was deleted
SubObjects¶
integrify.clopos.schemas.objects.sub.Timestamp
pydantic-model
¶
integrify.clopos.schemas.objects.sub.Balance
pydantic-model
¶
Bases: Timestamp
Fields:
-
created_at(str) -
updated_at(str) -
deleted_at(UnsetOrNoneField[str]) -
id(int) -
system_type(UnsetOrNoneField[str]) -
venue_id(UnsetOrNoneField[int]) -
name(UnsetOrNoneField[str]) -
description(UnsetOrNoneField[str]) -
type(str) -
amount(Decimal) -
position(int)
id
pydantic-field
¶
Balance ID
system_type
pydantic-field
¶
The system type of the balance
venue_id
pydantic-field
¶
The ID of the venue the balance belongs to
name
pydantic-field
¶
The name of the balance
description
pydantic-field
¶
The description of the balance
type
pydantic-field
¶
Balance type
amount
pydantic-field
¶
The balance amount
position
pydantic-field
¶
The position of the balance
created_at
pydantic-field
¶
The timestamp when the object was created
updated_at
pydantic-field
¶
The timestamp when the object was last updated
deleted_at
pydantic-field
¶
The timestamp when the object was deleted
integrify.clopos.schemas.objects.sub.Image
pydantic-model
¶
Bases: BaseModel
Fields:
-
original(UnsetOrNoneField[str]) -
large(UnsetOrNoneField[str]) -
extra_large(UnsetOrNoneField[str]) -
thumb(UnsetOrNoneField[str]) -
blur_hash(UnsetOrNoneField[str])
integrify.clopos.schemas.objects.sub.Media
pydantic-model
¶
Bases: BaseModel
Fields:
-
uuid(UnsetOrNoneField[str]) -
mime_type(UnsetOrNoneField[str]) -
size(UnsetOrNoneField[int]) -
urls(Image) -
blur_hash(UnsetOrNoneField[str]) -
dimensions(UnsetOrNoneField[dict])
uuid
pydantic-field
¶
The UUID of the media
mime_type
pydantic-field
¶
The MIME type of the media
size
pydantic-field
¶
The size of the media in bytes
urls
pydantic-field
¶
The image URLs of the media
blur_hash
pydantic-field
¶
The blur hash of the media
dimensions
pydantic-field
¶
The dimensions of the media
integrify.clopos.schemas.objects.sub.Variant
pydantic-model
¶
Bases: BaseModel
List of product variants (for GOODS)
Fields:
-
id(int) -
parent_id(UnsetOrNoneField[int]) -
type(Literal[MODIFICATION]) -
name(str) -
price(Decimal) -
cost_price(Decimal) -
barcode(UnsetOrNoneField[str]) -
full_name(UnsetOrNoneField[str]) -
status(int)
id
pydantic-field
¶
Modification ID
parent_id
pydantic-field
¶
The identifier of the parent product
type
pydantic-field
¶
Modification type
name
pydantic-field
¶
The name of the variant (e.g., "0.5 L")
price
pydantic-field
¶
The sales price of the variant
cost_price
pydantic-field
¶
The cost price of the variant
barcode
pydantic-field
¶
The barcode of the variant
full_name
pydantic-field
¶
The full name of the variant
status
pydantic-field
¶
The status of the variant (1: Active, 0: Inactive)
integrify.clopos.schemas.objects.sub.Modifier
pydantic-model
¶
integrify.clopos.schemas.objects.sub.ModifierGroup
pydantic-model
¶
Bases: Timestamp
List of modifier groups (for DISH)
Fields:
-
created_at(str) -
updated_at(str) -
deleted_at(UnsetOrNoneField[str]) -
id(int) -
name(str) -
type(int) -
min_select(int) -
max_select(int) -
modifiers(UnsetOrNoneField[list[Modifier]]) -
adjust_to_portion(bool) -
status(UnsetOrNoneField[bool]) -
meta(UnsetOrNoneField[dict]) -
pivot(UnsetOrNoneField[dict])
id
pydantic-field
¶
The group's identifier
name
pydantic-field
¶
The name of the group (e.g., "Spice Level")
type
pydantic-field
¶
Selection rule (1: Single-choice, 0: Multi-choice)
min_select
pydantic-field
¶
Minimum number of selections
max_select
pydantic-field
¶
Maximum number of selections
modifiers
pydantic-field
¶
The modifiers in the group
adjust_to_portion
pydantic-field
¶
Whether the group is adjusted to the portion size
status
pydantic-field
¶
The status of the group
meta
pydantic-field
¶
The metadata of the group
pivot
pydantic-field
¶
The pivot information of the group
created_at
pydantic-field
¶
The timestamp when the object was created
updated_at
pydantic-field
¶
The timestamp when the object was last updated
deleted_at
pydantic-field
¶
The timestamp when the object was deleted
integrify.clopos.schemas.objects.sub.Package
pydantic-model
¶
integrify.clopos.schemas.objects.sub.Tax
pydantic-model
¶
integrify.clopos.schemas.objects.sub.Price
pydantic-model
¶
integrify.clopos.schemas.objects.sub.TimerSetting
pydantic-model
¶
integrify.clopos.schemas.objects.sub.OrderItem
pydantic-model
¶
Bases: BaseModel
Fields:
-
id(int) -
product_id(int) -
quantity(int) -
unit_price(Decimal) -
total_price(Decimal)
integrify.clopos.schemas.objects.sub.Service
pydantic-model
¶
Bases: BaseModel
Fields:
-
sale_type_id(UnsetOrNoneField[int]) -
sale_type_name(UnsetOrNoneField[str]) -
venue_id(UnsetOrNoneField[int]) -
venue_name(UnsetOrNoneField[str])
integrify.clopos.schemas.objects.sub.OrderProductProduct
pydantic-model
¶
Bases: BaseModel
Fields:
-
product(UnsetOrNoneField[Union[Product, list]]) -
count(int) -
status(UnsetOrNoneField[str]) -
product_modificators(UnsetOrNoneField[list[dict]]) -
product_hash(UnsetOrNoneField[str])
product
pydantic-field
¶
The product information
count
pydantic-field
¶
The quantity of the product
status
pydantic-field
¶
The status of the product (e.g., "Active", "Inactive")
product_modificators
pydantic-field
¶
The modificators of the product
product_hash
pydantic-field
¶
The hash of the product
integrify.clopos.schemas.objects.sub.OrderPayload
pydantic-model
¶
Bases: BaseModel
Fields:
-
service(UnsetOrNoneField[Service]) -
customer(UnsetOrNoneField[OrderCustomer]) -
products(UnsetOrNoneField[list[OrderProduct]]) -
meta(UnsetOrNoneField[dict]) -
customer_id(UnsetOrNoneField[int]) -
sale_type_id(UnsetOrNoneField[int]) -
payload_updated_at(UnsetOrNoneField[str])
service
pydantic-field
¶
The sale type of the order
customer
pydantic-field
¶
The sale type of the order
products
pydantic-field
¶
The products in the order
meta
pydantic-field
¶
The order information
customer_id
pydantic-field
¶
The customer ID of the order
sale_type_id
pydantic-field
¶
The sale type ID of the order
payload_updated_at
pydantic-field
¶
The timestamp of the last update to the payload
integrify.clopos.schemas.objects.sub.OrderCustomer
pydantic-model
¶
Bases: BaseModel
Fields:
-
id(UnsetOrNoneField[int]) -
name(str) -
phone(UnsetOrNoneField[str]) -
address(UnsetOrNoneField[str]) -
customer_discount_type(UnsetOrNoneField[DiscountType])
integrify.clopos.schemas.objects.sub.OrderProduct
pydantic-model
¶
Bases: BaseModel
Fields:
-
product_id(UnsetOrNoneField[int]) -
count(int) -
product_modificators(UnsetOrNoneField[list[dict]]) -
meta(UnsetOrNoneField[OrderProductMeta])
integrify.clopos.schemas.objects.sub.OrderProductMeta
pydantic-model
¶
integrify.clopos.schemas.objects.sub.OrderProductProduct
pydantic-model
¶
Bases: BaseModel
Fields:
-
product(UnsetOrNoneField[Union[Product, list]]) -
count(int) -
status(UnsetOrNoneField[str]) -
product_modificators(UnsetOrNoneField[list[dict]]) -
product_hash(UnsetOrNoneField[str])
product
pydantic-field
¶
The product information
count
pydantic-field
¶
The quantity of the product
status
pydantic-field
¶
The status of the product (e.g., "Active", "Inactive")
product_modificators
pydantic-field
¶
The modificators of the product
product_hash
pydantic-field
¶
The hash of the product
integrify.clopos.schemas.objects.sub.ReceiptPaymentMethod
pydantic-model
¶
integrify.clopos.schemas.objects.sub.ReceiptProduct
pydantic-model
¶
Bases: ReceiptProductIn
Fields:
-
id(UnsetField[int]) -
cid(str) -
product_id(int) -
meta(dict) -
count(int) -
portion_size(Decimal) -
total(Decimal) -
price(Decimal) -
cost(UnsetField[Decimal]) -
is_gift(bool) -
created_at(UnsetField[IsoDateTime]) -
updated_at(UnsetField[IsoDateTime]) -
terminal_updated_at(UnsetField[IsoDateTime]) -
deleted_at(UnsetField[IsoDateTime]) -
receipt_id(int) -
product_hash(Optional[str]) -
preprint_count(int) -
station_printed_count(int) -
station_aborted_count(int) -
seller_id(int) -
loyalty_type(Optional[str]) -
loyalty_value(Optional[Decimal]) -
discount_rate(Decimal) -
discount_value(Decimal) -
discount_type(Optional[DiscountType]) -
total_discount(Decimal) -
subtotal(Decimal) -
receipt_discount(Decimal) -
receipt_product_modificators(list) -
taxes(list)
receipt_id
pydantic-field
¶
The ID of the receipt associated with the receipt product
product_hash
pydantic-field
¶
The hash of the product associated with the receipt product
preprint_count
pydantic-field
¶
The preprint count of the receipt product
station_printed_count
pydantic-field
¶
The station printed count of the receipt product
station_aborted_count
pydantic-field
¶
The station aborted count of the receipt product
seller_id
pydantic-field
¶
The ID of the seller associated with the receipt product
loyalty_type
pydantic-field
¶
The loyalty type of the receipt product
loyalty_value
pydantic-field
¶
The loyalty value of the receipt product
discount_rate
pydantic-field
¶
The discount rate of the receipt product
discount_value
pydantic-field
¶
The discount value of the receipt product
discount_type
pydantic-field
¶
The discount type of the receipt product
total_discount
pydantic-field
¶
The total discount of the receipt product
subtotal
pydantic-field
¶
The subtotal of the receipt product
receipt_discount
pydantic-field
¶
The receipt discount of the receipt product
receipt_product_modificators
pydantic-field
¶
The receipt product modificators of the receipt product
taxes
pydantic-field
¶
The taxes of the receipt product
model_config = {'extra': 'allow'}
class-attribute
instance-attribute
¶
id
pydantic-field
¶
The unique identifier for the receipt product
cid
pydantic-field
¶
The CID of the receipt product
product_id
pydantic-field
¶
The ID of the product associated with the receipt product
meta
pydantic-field
¶
The meta data of the receipt product
count
pydantic-field
¶
The count of the receipt product
portion_size
pydantic-field
¶
The portion size of the receipt product
total
pydantic-field
¶
The total of the receipt product
price
pydantic-field
¶
The price of the receipt product
cost
pydantic-field
¶
The cost of the receipt product
is_gift
pydantic-field
¶
Whether the receipt product is a gift
created_at
pydantic-field
¶
The created at of the receipt product
updated_at
pydantic-field
¶
The updated at of the receipt product
terminal_updated_at
pydantic-field
¶
The terminal updated at of the receipt product
deleted_at
pydantic-field
¶
The deleted at of the receipt product