[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/)Doctype States & Status Fields

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/)

FrappeDoctype States & Status Fields

How the status field, workflow_state, and the states array relate, and how to use them together in workflows.

UpdatedMar 13, 2026

Tagsfrappedoctypeworkflowstatus

Reading time3 min

On this page[The status Field](#the-status-field)[The workflow_state Field](#the-workflow_state-field)[The states Array (Indicator Colors)](#the-states-array-indicator-colors)[How States Map to Colors](#how-states-map-to-colors)[Important: States Titles Need Not Match Status Options](#important-states-titles-need-not-match-status-options)[Submittable Documents](#submittable-documents)[Practical Pattern: Multiple Status Tracking](#practical-pattern-multiple-status-tracking)

Frappe has three separate but related mechanisms for tracking document status. Understanding their interplay is critical for correct workflow implementation.

## The `status` Field

A standard `Select` field on the DocType that represents the human-readable status:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">{</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldname"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"status"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldtype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Select"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"label"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Application Status"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"options"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Pending</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\n</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">Approved</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\n</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">Rejected</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\n</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">Canceled"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"default"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Pending"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"allow_on_submit"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"in_list_view"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"in_standard_filter"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"no_copy"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
```

Key properties:

**`allow_on_submit: 1`** — Can change after document submission (critical for workflow-driven status changes)

**`in_standard_filter: 1`** — Adds a filter dropdown in list views

**`no_copy: 1`** — Status resets when duplicating the document

## The `workflow_state` Field

A hidden `Link` field to `Workflow State`, managed by Frappe's workflow engine:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">{</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldname"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"workflow_state"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldtype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Link"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"options"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Workflow State"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"hidden"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"read_only"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"allow_on_submit"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"search_index"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
```

This field drives automatic transitions and email notifications when a Workflow is configured for the DocType.

## The `states` Array (Indicator Colors)

The `states` array in the DocType JSON definition maps state titles to **colored indicator dots** displayed in list views and form headers:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">{</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"states"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: [</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"color"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Yellow"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Payment Pending"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"color"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Orange"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Payment Requested"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"color"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Blue"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,   </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Payment Received"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"color"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Green"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,  </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Approved"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"color"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Red"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Rejected"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"color"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Red"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Canceled"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    ]</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
```

### How States Map to Colors

Frappe looks at the **`status` field value** (or `workflow_state` if a workflow is active) and matches it against the `title` in the `states` array. The matched `color` renders as a colored dot.

Available colors: `Blue`, `Cyan`, `Gray`, `Green`, `Light Blue`, `Orange`, `Pink`, `Purple`, `Red`, `Yellow`.

### Important: States Titles Need Not Match Status Options

The `states` array titles can differ from the `status` field's `options`. This is useful when:

The workflow has more granular states than the simple status

You want different visual indicators for workflow states vs. application status

Both `payment_status` and `status` feed into the visual indicators

## Submittable Documents

Adding `"is_submittable": 1` to the DocType enables the Draft → Submitted → Cancelled lifecycle:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">{</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"is_submittable"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
```

This automatically adds a `docstatus` field:

`0` = Draft

`1` = Submitted

`2` = Cancelled

Fields with `allow_on_submit: 1` can still be modified after submission.

## Practical Pattern: Multiple Status Tracking

A real-world example combining all three mechanisms:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">{</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fields"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: [</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldname"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"status"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldtype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Select"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"options"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Pending</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\n</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">Approved</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\n</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">Rejected</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\n</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">Canceled"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"default"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Pending"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"allow_on_submit"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldname"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"payment_status"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldtype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Select"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"options"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Unpaid</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\n</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">Paid</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\n</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">Refunded"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"default"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Unpaid"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"allow_on_submit"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldname"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"workflow_state"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldtype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Link"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"options"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Workflow State"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"hidden"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"read_only"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"allow_on_submit"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        }</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    ],</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"states"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: [</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"color"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Yellow"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Payment Pending"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"color"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Orange"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Payment Requested"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"color"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Blue"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,   </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Payment Received"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"color"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Green"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,  </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Approved"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"color"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Red"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Rejected"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"color"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Red"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Canceled"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    ],</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"is_submittable"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
```

This gives:

**`status`** — Application lifecycle (Pending → Approved/Rejected)

**`payment_status`** — Payment tracking (Unpaid → Paid  → Refunded)

**`workflow_state`** — Granular workflow engine states for server-side automation

**`states`** — Visual colored indicators derived from the workflow state titles

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/)

[← PreviousCustomizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/)[Next →Grandchild Table Fields](/kb/frappe/grandchild-table-fields/)

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

- [The status Field](#the-status-field)
- [The workflow_state Field](#the-workflow_state-field)
- [The states Array (Indicator Colors)](#the-states-array-indicator-colors)
- [How States Map to Colors](#how-states-map-to-colors)
- [Important: States Titles Need Not Match Status Options](#important-states-titles-need-not-match-status-options)
- [Submittable Documents](#submittable-documents)
- [Practical Pattern: Multiple Status Tracking](#practical-pattern-multiple-status-tracking)

[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/)
