pos.session: fields, relations and API
The pos.session model ("Point of Sale Session") is a persistent model declared by the Point of Sale module, then extended by 8 other modules. It exposes 65 fields, 34 of them declared directly on the model; 12 fields from other models point to it. Below you will find every field with its technical name, type, label and relations, followed by an Odoo 20 JSON-2 API call.
Model identity
- Technical name
pos.session- Label
- Point of Sale Session
- Type
- Persistent (models.Model)
- SQL table
pos_session- Origin module
- Point of Sale (
point_of_sale) - Extended by
- l10n_fr_pos_cert, pos_event, pos_sale, pos_hr, pos_restaurant, pos_loyalty, pos_stock, pos_self_order
- Default order (_order)
id desc- Inherits from (mixins)
- mail.threadmail.activity.mixinpos.bus.mixinpos.load.mixin
Model fields
34 own fields, 25 inherited from mixins and 6 automatic ORM fields. Click a name to get a direct link to that field.
65 of 65 fields shown
| Technical name | Label | Type | Details |
|---|---|---|---|
| account_move_count | Number of related journal entries | integer | computed |
| bank_statement_id | Bank Statement | many2one | read-only |
| bank_statement_line_ids | Bank Statement Lines | one2many | read-only related: |
| closing_balance | Closing Balance | monetary | read-only related: |
| closing_difference | Closing Difference | monetary | computed |
| closing_notes | Closing Notes | text | |
| company_id | Company | many2one | read-only related: |
| config_id | Point of Sale | many2one | required |
| correction_move_ids | Correction Entries | one2many | inverse: |
| crm_team_id | Sales Team | many2one→ crm.team | read-only related: added by POS - Sales ( |
| currency_id | Currency | many2one | related: |
| employee_id | Cashier The employee who currently uses the cash register | many2one | added by POS - HR ( |
| failed_pickings | Failed Pickings | boolean | computed added by PoS - Stock ( |
| is_in_company_currency | Is Using Company Currency | boolean | computed |
| logged_employee_ids | Logged In Cashiers All employees who have logged into this session | many2many | computed, stored added by POS - HR ( |
| move_ids | Related Journal Entries | many2many | computed |
| name | Session ID | char | read-only |
| opening_balance | Opening Balance | monetary | read-only related: |
| opening_notes | Opening Notes | text | |
| order_count | Order Count | integer | computed |
| order_ids | Orders | one2many | inverse: |
| payment_method_ids | Payment Methods | many2many | related: |
| picking_count | Picking Count | integer | computed added by PoS - Stock ( |
| picking_ids | Picking | one2many | inverse: added by PoS - Stock ( |
| refund_move_count | Number of related refunds journal entries | integer | computed |
| refund_move_ids | Refunds Entry | one2many | inverse: |
| sale_move_count | Number of related sales journal entries | integer | computed |
| sale_move_ids | Sales Entry | one2many | inverse: |
| start_at | Opening Date | datetime | read-only |
| state | Status | selection | requiredread-only Values: |
| stop_at | Closing Date | datetime | read-only |
| total_payments_amount | Total Payments Amount | float | computed |
| update_stock_at_closing | Stock should be updated at closing | boolean | added by PoS - Stock ( |
| user_id | Opened By | many2one | required |
| access_token | Security Token | char | inherited from pos.bus.mixin |
| activity_calendar_event_id | Next Activity Calendar Event | many2one | computed inherited from mail.activity.mixin |
| activity_date_deadline | Next Activity Deadline | date | read-onlycomputed inherited from mail.activity.mixin |
| activity_exception_decoration | Activity Exception Decoration Type of the exception activity on record. | selection | computed Values: inherited from mail.activity.mixin |
| activity_exception_icon | Icon Icon to indicate an exception activity. | char | computed inherited from mail.activity.mixin |
| activity_ids | Activities | one2many | inverse: inherited from mail.activity.mixin |
| activity_plans_ids | Activity Plans | many2many | computed inherited from mail.activity.mixin |
| activity_state | Activity State Status based on activities Overdue: Due date is already passed Today: Activity date is today Planned: Future activities. | selection | computed Values: inherited from mail.activity.mixin |
| activity_summary | Next Activity Summary | char | related: inherited from mail.activity.mixin |
| activity_type_icon | Activity Type Icon | char | related: inherited from mail.activity.mixin |
| activity_type_id | Next Activity Type | many2one | related: inherited from mail.activity.mixin |
| activity_user_id | Responsible User | many2one | read-onlycomputed inherited from mail.activity.mixin |
| has_message | Has Message | boolean | computed inherited from mail.thread |
| message_attachment_count | Attachment Count | integer | computed inherited from mail.thread |
| message_follower_ids | Followers | one2many | inverse: inherited from mail.thread |
| message_has_error | Message Delivery error If checked, some messages have a delivery error. | boolean | computed inherited from mail.thread |
| message_has_error_counter | Number of errors Number of messages with delivery error | integer | computed inherited from mail.thread |
| message_has_sms_error | SMS Delivery error If checked, some messages have a delivery error. | boolean | computed inherited from mail.thread |
| message_ids | Messages | one2many | inverse: inherited from mail.thread |
| message_is_follower | Is Follower | boolean | computed inherited from mail.thread |
| message_needaction | Action Needed If checked, new messages require your attention. | boolean | computed inherited from mail.thread |
| message_needaction_counter | Number of Actions Number of messages requiring action | integer | computed inherited from mail.thread |
| message_partner_ids | Followers (Partners) | many2many | computed inherited from mail.thread |
| my_activity_date_deadline | My Activity Deadline | date | read-onlycomputed inherited from mail.activity.mixin |
| rating_ids | Ratings | one2many | inverse: inherited from mail.thread |
| create_date | Created on | datetime | read-onlyautomatic |
| create_uid | Created by | many2one | read-onlyautomatic |
| display_name | Display Name | char | read-onlycomputedautomatic |
| id | ID | integer | read-onlyautomatic |
| write_date | Last Updated on | datetime | read-onlyautomatic |
| write_uid | Last Updated by | many2one | read-onlyautomatic |
Relations
Models linked from this model
- account.bank.statement: bank_statement_id
- account.bank.statement.line: bank_statement_line_ids
- account.move: correction_move_ids, move_ids, refund_move_ids, sale_move_ids
- crm.team: crm_team_id
- hr.employee: employee_id, logged_employee_ids
- pos.config: config_id
- pos.order: order_ids
- pos.payment.method: payment_method_ids
- res.company: company_id
- res.currency: currency_id
- res.users: user_id
- stock.picking: picking_ids
Fields of other models pointing here
- account.bank.statement.line: pos_session_id
- account.move: pos_session_correction_id, pos_session_refunds_id, pos_session_sales_id
- account.payment: pos_session_id
- pos.config: current_session_id
- pos.daily.sales.reports.wizard: pos_session_id
- pos.order: session_id
- pos.payment: session_id
- pos.payment.method: open_session_ids
- report.pos.order: session_id
- stock.picking: pos_session_id
Reading this model through the API
Odoo 20 JSON-2 API call reading the first five records with real fields of the model. Replace the instance, database and API key with your own.
curl -X POST "https://your-instance.odoo.com/json/2/pos.session/search_read" \
-H "Authorization: bearer $ODOO_API_KEY" \
-H "X-Odoo-Database: your-db" \
-H "Content-Type: application/json" \
-d '{"domain":[],"fields":["name","config_id","state","user_id","bank_statement_id"],"limit":5}'import requests
BASE_URL = "https://your-instance.odoo.com/json/2"
headers = {"Authorization": f"bearer {API_KEY}", "X-Odoo-Database": "your-db"}
res = requests.post(
f"{BASE_URL}/pos.session/search_read",
headers=headers,
json={"domain": [], "fields": ["name","config_id","state","user_id","bank_statement_id"], "limit": 5},
)
res.raise_for_status()
print(res.json())- External API access requires Odoo's Custom plan.
- XML-RPC and JSON-RPC will be removed in Odoo 22 (fall 2028): use JSON-2.
- The access rights and record rules of the key's user apply.
Cite this tool
Writing a tutorial, internal documentation or a forum answer? Copy this link to send your readers to the up-to-date reference.
<a href="https://aidoo.ai/en/outils/explorateur-modeles-odoo/pos-session">pos.session (Odoo 20.0)</a>Sources
Data verified on September 25, 2026 · Odoo 20.0 Community
Have an Odoo project, or want to put your ERP to work with AI? Let's talk
Implementation, custom module development, connecting Claude or ChatGPT to your data: tell us about your context and we will reply within 24 business hours.