res.country.state: fields, relations and API
The res.country.state model ("Country state") is a persistent model declared by the Base module, then extended by 1 other module. It exposes 9 fields, 3 of them declared directly on the model; 18 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 19 JSON-2 API call.
Model identity
- Technical name
res.country.state- Label
- Country state
- Type
- Persistent (models.Model)
- SQL table
res_country_state- Origin module
- Base (
base) - Extended by
- point_of_sale
- Default order (_order)
code, id- Inherits from (mixins)
- pos.load.mixin
Model fields
3 own fields, 0 inherited from mixins and 6 automatic ORM fields. Click a name to get a direct link to that field.
9 of 9 fields shown
| Technical name | Label | Type | Details |
|---|---|---|---|
| code | State Code The state code. | char | required |
| country_id | Country | many2one | required |
| name | State Name Administrative divisions of a country. E.g. Fed. State, Department, Canton | char | required |
| 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
- res.country: country_id
Fields of other models pointing here
- account.fiscal.position: state_ids
- crm.iap.lead.mining.request: state_ids
- crm.lead: state_id
- crm.reveal.rule: state_ids
- delivery.carrier: state_ids
- hr.version: allowed_country_state_ids, private_state_id
- lunch.supplier: state_id
- payment.transaction: partner_state_id
- res.bank: state
- res.city: state_id
- res.company: state_id
- res.country.group: exclude_state_ids
- res.partner: state_id
- res.partner.bank: bank_state
- res.users: private_state_id
- sale.report: state_id
- snailmail.letter: state_id
Reading this model through the API
Odoo 19 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/res.country.state/search_read" \
-H "Authorization: bearer $ODOO_API_KEY" \
-H "X-Odoo-Database: your-db" \
-H "Content-Type: application/json" \
-d '{"domain":[],"fields":["name","code","country_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}/res.country.state/search_read",
headers=headers,
json={"domain": [], "fields": ["name","code","country_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/res-country-state">res.country.state (Odoo 19.0)</a>Sources
Data verified on September 23, 2026 · Odoo 19.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.