[Skip to content](#main)

[→](/)

[![Avunu](/brand/avunu-logo.svg)![Avunu](/brand/avunu-logo-light.svg)](/)[Services](/services/)[Consulting](/services/consulting/)[ERP](/services/erp/)[Odoo](/services/erp/odoo/)[ERPNext](/services/erp/erpnext/)[Custom software](/services/custom-software/)[Devices & IoT](/services/devices-iot/)[Websites](/services/websites/)[Infrastructure](/services/infrastructure/)[Partners](/partners/)

[Work](/work/)[Open source](/open-source/)[Knowledge base](/kb/)[About](/about/)

[About Avunu](/about/)[Team](/about/team/)[Insights](/insights/)[Contact](/contact/)

[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

- [Services](/services/)[Consulting](/services/consulting/)
- [ERP](/services/erp/)
- [Odoo](/services/erp/odoo/)
- [ERPNext](/services/erp/erpnext/)
- [Custom software](/services/custom-software/)
- [Devices & IoT](/services/devices-iot/)
- [Websites](/services/websites/)
- [Infrastructure](/services/infrastructure/)
- [Partners](/partners/)

[Work](/work/)[Open source](/open-source/)[Knowledge base](/kb/)[About](/about/)

- [About Avunu](/about/)
- [Team](/about/team/)
- [Insights](/insights/)
- [Contact](/contact/)

[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

[Knowledge base](/kb/)[Frappe](/kb/frappe/)Type Annotations & Controller Overrides

Search the knowledge basePress/

ESC

Jump to

[Browse the knowledge base](/kb/)[Frappe](/kb/frappe/)[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

↵select↑↓navigateescclose

Search the knowledge base

[Skip to the article](#kb-article)[Frappe](/kb/frappe/)20 articles

- [Overview](/kb/frappe/)
- [Bench Operations](/kb/frappe/bench-operations/)
- [Builder Page Scripts](/kb/frappe/builder-page-scripts/)
- [Client-Side Recipes](/kb/frappe/client-side-recipes/)
- [Common Query Patterns](/kb/frappe/common-query-patterns/)
- [Custom Field Controllers](/kb/frappe/custom-field-controllers/)
- [Custom Pages](/kb/frappe/custom-pages/)
- [Custom Views](/kb/frappe/custom-views/)
- [Customizations API](/kb/frappe/customizations-api/)
- [Customizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/)
- [Doctype States & Status Fields](/kb/frappe/doctype-states-status-fields/)
- [Grandchild Table Fields](/kb/frappe/grandchild-table-fields/)
- [Portal Views](/kb/frappe/portal-views/)
- [Project Structure & Hooks](/kb/frappe/project-structure-hooks/)
- [Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/)
- [Quick Entry Forms](/kb/frappe/quick-entry-forms/)
- [Script Reports](/kb/frappe/script-reports/)
- [Testing on Live Databases](/kb/frappe/testing-live-databases/)
- [Type Annotations & Controller Overrides](/kb/frappe/type-annotations-controller-overrides/)
- [Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/)
- [Web Forms](/kb/frappe/web-forms/)

Other sections[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

In Frappe: 20 articles

[Overview](/kb/frappe/)[Bench Operations](/kb/frappe/bench-operations/)[Builder Page Scripts](/kb/frappe/builder-page-scripts/)[Client-Side Recipes](/kb/frappe/client-side-recipes/)[Common Query Patterns](/kb/frappe/common-query-patterns/)[Custom Field Controllers](/kb/frappe/custom-field-controllers/)[Custom Pages](/kb/frappe/custom-pages/)[Custom Views](/kb/frappe/custom-views/)[Customizations API](/kb/frappe/customizations-api/)[Customizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/)[Doctype States & Status Fields](/kb/frappe/doctype-states-status-fields/)[Grandchild Table Fields](/kb/frappe/grandchild-table-fields/)[Portal Views](/kb/frappe/portal-views/)[Project Structure & Hooks](/kb/frappe/project-structure-hooks/)[Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/)[Quick Entry Forms](/kb/frappe/quick-entry-forms/)[Script Reports](/kb/frappe/script-reports/)[Testing on Live Databases](/kb/frappe/testing-live-databases/)[Type Annotations & Controller Overrides](/kb/frappe/type-annotations-controller-overrides/)[Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/)[Web Forms](/kb/frappe/web-forms/)

Other sections[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

FrappeType Annotations & Controller Overrides

Type Frappe controllers with DF field annotations, cast, TypedDict, and TYPE_CHECKING imports.

UpdatedMay 29, 2026

Tagsfrappepythontypingcontrollers

Reading time3 min

On this page[Enabling Type Annotations](#enabling-type-annotations)[Field Type Annotations](#field-type-annotations)[Common DF.\* Types](#common-df-types)[Controller Class Override Pattern](#controller-class-override-pattern)[Simple Override (Custom Fields Only)](#simple-override-custom-fields-only)[Complex Override (Methods + Typed Children)](#complex-override-methods-typed-children)[Key Conventions](#key-conventions)[Using cast for Type Safety](#using-cast-for-type-safety)[TypedDict for API Contracts](#typeddict-for-api-contracts)[Conditional Imports with TYPE_CHECKING](#conditional-imports-with-type_checking)[Auto-Generated Type Blocks](#auto-generated-type-blocks)

## Enabling Type Annotations

In `hooks.py`:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">export_python_type_annotations </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">True</span>
```

This enables the `DF.*` type annotation system from `frappe.types`, allowing field-level type declarations on DocType controllers.

## Field Type Annotations

Import `DF` from `frappe.types` and annotate fields on the controller class:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.types </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span>

<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">class</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">MyDocType</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">Document</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Standard field types</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    customer_name: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Data</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    amount: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Currency</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    is_active: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Check</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    description: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.TextEditor</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Optional fields (custom or nullable)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    part_group: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Link </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">|</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    pro_number: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Int </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">|</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    surface_area: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Float </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">|</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    charge: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Currency </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">|</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    markup: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Percent </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">|</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Child table fields</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    items: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Table[BOMItem]</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    operations: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Table[BOMOperation]</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Table MultiSelect</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    guardians: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.TableMultiSelect[FamilyGuardian]</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Select with literals</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    status: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Literal[</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Open"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Completed"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Cancelled"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]</span>
```

### Common `DF.*` Types

| Annotation                       | Frappe Fieldtype  |
| -------------------------------- | ----------------- |
| `DF.Data`                        | Data              |
| `DF.Int`                         | Int               |
| `DF.Float`                       | Float             |
| `DF.Currency`                    | Currency          |
| `DF.Percent`                     | Percent           |
| `DF.Check`                       | Check             |
| `DF.Link`                        | Link              |
| `DF.Table[ChildType]`            | Table             |
| `DF.TableMultiSelect[ChildType]` | Table MultiSelect |
| `DF.TextEditor`                  | Text Editor       |
| `DF.Literal[...]`                | Select            |

## Controller Class Override Pattern

### Simple Override (Custom Fields Only)

When you only need type annotations for custom fields:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> erpnext.stock.doctype.item.item </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> Item </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">as</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> BaseItem</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.types </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span>

<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">class</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">Item</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">BaseItem</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"""Custom Item with additional fields."""</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    valuation_uom: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Link </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">|</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span>
```

### Complex Override (Methods + Typed Children)

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> typing </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> Any, cast</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> erpnext.manufacturing.doctype.bom.bom </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">BOM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">as</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> BaseBOM</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.types </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span>

<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">class</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">BOM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">BaseBOM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"""Custom BOM override for app-specific functionality."""</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Inline imports for child table types (avoids circular imports)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> myapp.mymodule.doctype.bom_part_group.bom_part_group </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> BOMPartGroup</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    part_group_measurements: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Table[BOMPartGroup]</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    cadwork_guid: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Data</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Override standard child table types for stronger typing</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> myapp.myapp.custom.bom_item </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> BOMItem</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    items: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Table[BOMItem]</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Transient attributes (not persisted to DB)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    _import_warnings: dict[</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, list[dict[</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, Any]]] </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">|</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">def</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">validate</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(self) -> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">super</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">().validate()</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Custom validation logic</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">@frappe.whitelist</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">()</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">def</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">custom_action</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(self) -> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Whitelisted method callable from client</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">...</span>
```

### Key Conventions

**Alias the base class** to avoid name collision:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> erpnext.stock.doctype.item.item </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> Item </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">as</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> BaseItem</span>
```

**Custom fields use `| None`** since they may not exist in the base schema:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">my_custom_field: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Float </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">|</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span>
```

**Inline imports** for child table types prevent circular import issues:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">class</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">BOM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">BaseBOM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> myapp.custom.bom_item </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> BOMItem</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    items: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Table[BOMItem]</span>
```

**Transient attributes** (not saved to DB) use class-level defaults:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">_cache: dict[</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, Any] </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">|</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span>
```

## Using `cast` for Type Safety

When `frappe.get_doc()` returns a generic `Document`, use `cast` to get type checking:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> typing </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> cast</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">doc </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> cast(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, frappe.get_doc(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, item_code))</span>
<span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Now doc.valuation_uom, doc.uoms, etc. are typed</span>

<span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Also useful for whitelisted endpoint return values</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">doc </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> cast(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, frappe.get_doc(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, item_code))</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">for</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> row </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">in</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> doc.uoms:  </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># row is typed as UOMConversionDetail</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">if</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> row.uom </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">==</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> sales_uom:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        row.conversion_factor </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> flt(value)</span>
```

## TypedDict for API Contracts

Use `TypedDict` to type filter parameters, query results, and API responses:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> typing </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> TypedDict</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.types </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span>

<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">class</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">Filters</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">TypedDict</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">total</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">False</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    project: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Link </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">|</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    sales_quote: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Link </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">|</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    date_range: tuple[</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    status: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Literal[</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Open"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Completed"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Cancelled"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]</span>

<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">class</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">QueryResult</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">TypedDict</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">total</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">False</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">id</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    name: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    quoted_hours: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">float</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    actual_hours: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">float</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    indent: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">int</span>

<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">def</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">execute</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(filters: Filters </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">|</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) -> tuple[list[Any], list[QueryResult], </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, Chart]:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">...</span>
```

## Conditional Imports with TYPE_CHECKING

For imports only needed by type checkers (not at runtime):

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> typing </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">TYPE_CHECKING</span>

<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">if</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">TYPE_CHECKING</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> myapp.myapp.custom.item </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> Item</span>

<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">def</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">update_item</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(item_code: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) -> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">dict</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    doc </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> cast(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, frappe.get_doc(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, item_code))</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">...</span>
```

## Auto-Generated Type Blocks

Frappe can auto-generate type annotations for DocType controllers. These go in a guarded block:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">class</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">Family</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">Document</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># begin: auto-generated types</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># This code is auto-generated. Do not modify anything in this block.</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> typing </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">TYPE_CHECKING</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">if</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">TYPE_CHECKING</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.types </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> my_app.my_module.doctype.family_guardian.family_guardian </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> FamilyGuardian</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        address: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.Link </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">|</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">None</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        guardians: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DF</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.TableMultiSelect[FamilyGuardian]</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># end: auto-generated types</span>
```

Custom logic and additional annotations go **outside** this block.

Need help with Frappe?

Our notes can take you a long way, but sometimes you'd rather have someone who's done it before.

[ERPNext implementation](/services/erp/erpnext/)

[← PreviousTesting on Live Databases](/kb/frappe/testing-live-databases/)[Next →Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/)

CC0This article is in the public domain ([CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)), code samples included. Use it however helps you.

On this page

- [Enabling Type Annotations](#enabling-type-annotations)
- [Field Type Annotations](#field-type-annotations)
- [Common DF.\* Types](#common-df-types)
- [Controller Class Override Pattern](#controller-class-override-pattern)
- [Simple Override (Custom Fields Only)](#simple-override-custom-fields-only)
- [Complex Override (Methods + Typed Children)](#complex-override-methods-typed-children)
- [Key Conventions](#key-conventions)
- [Using cast for Type Safety](#using-cast-for-type-safety)
- [TypedDict for API Contracts](#typeddict-for-api-contracts)
- [Conditional Imports with TYPE_CHECKING](#conditional-imports-with-type_checking)
- [Auto-Generated Type Blocks](#auto-generated-type-blocks)

[Back to top↑](#top)

Services

- [ERP implementation](/services/erp/)
- [Odoo](/services/erp/odoo/)
- [ERPNext](/services/erp/erpnext/)
- [Custom software](/services/custom-software/)
- [Devices & IoT](/services/devices-iot/)
- [Websites](/services/websites/)
- [Infrastructure](/services/infrastructure/)

Resources

- [Our work](/work/)
- [Open source](/open-source/)
- [Knowledge base](/kb/)
- [Insights](/insights/)

Company

- [About](/about/)
- [Team](/about/team/)
- [Partners](/partners/)
- [Contact](/contact/)

Clients

- [Project portal](https://erp.avunu.net/projects)
- [Invoices](https://erp.avunu.net/)
- [Support](https://erp.avunu.net/)

[![Avunu](/brand/avunu-logo-light.svg)](/)[\<av-icon data-jx-static>\<svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor" stroke="none" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false">\<path d="M20.400 20.500h-3.600v-5.600c0-1.300 0-3-1.800-3s-2.100 1.400-2.100 2.900v5.700H9.400V9h3.400v1.600c.5-.9 1.600-1.900 3.400-1.900 3.600 0 4.300 2.400 4.300 5.500v6.300zM5.300 7.400a2.100 2.100 0 1 1 0-4.100 2.100 2.100 0 0 1 0 4.100zm1.800 13.100H3.600V9h3.500v11.500zM22.200 0H1.800C.8 0 0 .8 0 1.700v20.600c0 .9.800 1.700 1.800 1.700h20.400c1 0 1.800-.8 1.800-1.700V1.700C24 .8 23.200 0 22.200 0z">\</path>\</svg>\</av-icon>](https://www.linkedin.com/company/avunu)[\<av-icon data-jx-static>\<svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor" stroke="none" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false">\<path d="M12 .3a12 12 0 0 0-3.8 23.4c.6.1.8-.3.8-.6v-2c-3.3.7-4-1.6-4-1.6-.6-1.4-1.4-1.8-1.4-1.8-1-.7.1-.7.1-.7 1.2.1 1.8 1.2 1.8 1.2 1 1.8 2.8 1.3 3.5 1 .1-.8.4-1.3.7-1.6-2.7-.3-5.5-1.3-5.5-5.9 0-1.3.5-2.4 1.2-3.2-.1-.3-.5-1.5.1-3.2 0 0 1-.3 3.3 1.2a11.500 11.500 0 0 1 6 0c2.300-1.500 3.300-1.200 3.300-1.200.6 1.700.2 2.900.1 3.200.8.8 1.200 1.900 1.200 3.200 0 4.600-2.800 5.600-5.500 5.900.4.400.8 1.100.8 2.200v3.300c0 .3.2.7.8.6A12 12 0 0 0 12 .3">\</path>\</svg>\</av-icon>](https://github.com/Avunu)[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

Avunu LLC · 948 East Philadelphia Street, York, PA 17403 · (717) 814-8540Knowledge base articles are in the public domain[Privacy](/privacy/)[Terms](/terms/)
