Field reference
Number Card
How to use Number Card in Dashboards: access, working steps, fields, related records and troubleshooting.
Purpose and access
Choose a dashboard appropriate to your role and company. Review the period and filters before interpreting a number. Follow a metric to its underlying records where available; empty charts can reflect no matching data, restricted access or an incomplete filter.
This page is a record page in Home → Dashboards. Use the link above to open the configured destination; permissions are checked by the destination service.
ERP links open in a new tab. Sign in with your own account; record visibility, actions and approval authority follow your assigned permissions. Screens can differ by company and configuration.
Before you start
Prepare the required information: Label.
Confirm the company, party, dates, units and source references that apply. Select existing links carefully and check for an existing record before creating a duplicate.
Working steps
- Open Number Card from Home → Dashboards, or use ERP Search.
- Filter the list and open the relevant record. To add a record, use Add/New when your role provides that action.
- Complete the editable fields described below. Required fields and validation conditions must be satisfied; read-only values are set by the system or their source records.
- Save the record and address validation messages. Reload and verify the saved values and relationships.
- Use any additional workflow actions only when the record and your role provide them. Saving this record does not automatically complete a related transaction or external action.
Field reference
These fields come from the installed ERP definition. Hidden fields and password inputs are omitted. Additional conditions, custom scripts and workflow rules can make a field required or read-only in a particular context.
| Field | Type / behavior | How to use it |
|---|---|---|
Is Standardis_standard | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Modulemodule | Link Optional | Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Module Def |
Labellabel | Data Required | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Typetype | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
Report Namereport_name | Link Optional | Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Report |
Methodmethod | Data Optional | Set the path to a whitelisted function that will return the data for the number card in the format: { "value": value, "fieldtype": "Currency", "route_options": {"from_date": "2023-05-23"}, "route": ["query-report", "Permitted Documents For User"] } |
Functionfunction | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
Aggregate Function Based Onaggregate_function_based_on | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow. |
Document Typedocument_type | Link Optional | Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: DocType |
Parent Document Typeparent_document_type | Link Optional | The document type selected is a child table, so the parent document type is required. Linked record: DocType |
Fieldreport_field | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow. |
Functionreport_function | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
Is Publicis_public | Check Optional | This card will be available to all Users if this is set |
Currencycurrency | Link Optional | Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Currency |
Show Full Numbershow_full_number | Check Optional | Check to display the full numeric value (e.g., 1,234,567 instead of 1.2M). |
Filters Configurationfilters_config | Code Optional | Set the filters here. For example: [{ fieldname: "company", label: __("Company"), fieldtype: "Link", options: "Company", default: frappe.defaults.get_user_default("Company"), reqd: 1 }, { fieldname: "account", label: __("Account"), fieldtype: "Link", options: "Account", reqd: 1 }] |
Show Percentage Statsshow_percentage_stats | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Stats Time Intervalstats_time_interval | Select Optional | Show percentage difference according to this time intervalAvailable choices
|
Filters JSONfilters_json | Code Optional | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Dynamic Filters JSONdynamic_filters_json | Code Optional | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Colorcolor | Color Optional | Complete the value according to the field label and the record’s validation rules. |
Background Colorbackground_color | Color Optional | Complete the value according to the field label and the record’s validation rules. |
Troubleshooting
- Not permitted: verify the account, role and source-document permission. Do not share an administrator login.
- Missing record or address: inspect the relevant Link or Dynamic Link fields; a matching title alone does not establish a relationship.
- Cannot save or change status: review required fields, read-only values, document status and the configured approval transition.
- Unexpected report or portal result: review company/date filters, source-document submission and the approved party or Employee link.