ValidationMessage

class xbrl_filings_api.ValidationMessage

Bases: APIResource

Message for a filing in the database from a validator software.

Validation messages are issues in XBRL standard conformance, and the formula rules defined in the XBRL taxonomy.

Country-specific filing rules defined by financial regulatory authorities and other agencies are not in the scope of validation. The rules defined in ESEF Reporting Manual are not checked if they are not codified in the taxonomy formula rules.

Calculation inconsistency is the term used for issues in accounting coherence.

Derived attributes beginning calc_ are only available when code is 'xbrl.5.2.5.2:calcInconsistency'. The ones beginning duplicate_ are available for code 'message:tech_duplicated_facts1' if the values are numeric. They are parsed out from the text of the message.

Notes

The source of validation has not been published by the API provider. However, it seems likely that they originate from Arelle software as they seem similar and JSON and iXBRL viewer files are also generated with it.

Methods

get_data_attributes([flags, filings])	Return data attributes for an APIResource.
__hash__()	Return hash of ('APIResource', cls.TYPE, self.api_id).
__repr__()	Return repr with api_id, code and severity.
__str__()	Return "[severity[:3] code] text".

Attributes

code	The code describing the source of the broken rule.
severity	Severity of the validation message.
text	Validation message text.
calc_computed_sum	Derived computed sum of the calculation inconsistency.
calc_reported_sum	Derived reported sum of the calculation inconsistency.
calc_context_id	Derived XBRL context ID of the calculation inconsistency.
calc_line_item	Derived line item name of the calculation inconsistency.
calc_short_role	Derived last part of the link role of the calculation inconsistency.
calc_unreported_items	Derived unreported contributing line items of the calculation inconsistency.
duplicate_greater	Derived greater item of the duplicate pair.
duplicate_lesser	Derived lesser item of the duplicate pair.
filing_api_id	api_id of filing object.
filing	Filing of this validation message.
api_id	JSON-API resource id of APIResource.
query_time	Time when the query function was called for an APIObject.
request_url	HTTP request URL for an APIObject.

TYPE: str = 'validation_message'

JSON-API resource type of APIResource subclass.

code: str | None

The code describing the source of the broken rule.

For example, code 'xbrl.5.2.5.2:calcInconsistency' refers to XBRL 2.1 base specification heading 5.2.5.2 with title “The <calculationArc> element”.

severity: str | None

Severity of the validation message.

Can be ERROR, WARNING or INCONSISTENCY. Might include ERROR-SEMANTIC and WARNING-SEMANTIC but most likely not.

Arelle has also more message levels, but these are very certainly not included anywhere ((DYNAMIC), CRITICAL, DEBUG, EXCEPTION, INFO, INFO-RESULT).

text: str | None

Validation message text.

calc_computed_sum: float | None

Derived computed sum of the calculation inconsistency.

Based on attribute text for validation messages whose code is 'xbrl.5.2.5.2:calcInconsistency'.

calc_reported_sum: float | None

Derived reported sum of the calculation inconsistency.

Based on attribute text for validation messages whose code is 'xbrl.5.2.5.2:calcInconsistency'.

calc_context_id: str | None

Derived XBRL context ID of the calculation inconsistency.

Based on attribute text for validation messages whose code is 'xbrl.5.2.5.2:calcInconsistency'.

calc_line_item: str | None

Derived line item name of the calculation inconsistency.

This field contains the qualified name of the line item (XBRL concept) with the taxonomy prefix and the local name parts. It could be for example ifrs-full:Assets.

Based on attribute text for validation messages whose code is 'xbrl.5.2.5.2:calcInconsistency'.

calc_short_role: str | None

Derived last part of the link role of the calculation inconsistency.

For example a link role URI “http://www.example.com/esef/taxonomy/2022-12-31/FinancialPositionConsolidated” is truncated to “FinancialPositionConsolidated”.

Based on attribute text for validation messages whose code is 'xbrl.5.2.5.2:calcInconsistency'.

calc_unreported_items: list[str] | None

Derived unreported contributing line items of the calculation inconsistency.

This refers to the line item names of items which are defined as the addends for calc_line_item in any of the link roles in the XBRL taxonomies of this report and which were not reported in the same XBRL context with this fact.

When the data is output to a database, this field is a string with parts joined by a newline character.

Based on attribute text for validation messages whose code is 'xbrl.5.2.5.2:calcInconsistency'.

duplicate_greater: float | None

Derived greater item of the duplicate pair.

Based on attribute text for validation messages whose code is 'message:tech_duplicated_facts1'.

Does not include code 'formula:assertionUnsatisfied' with tech_duplicated_facts1 in the beginning of the message (more than 2 duplicated facts).

duplicate_lesser: float | None

Derived lesser item of the duplicate pair.

Based on attribute text for validation messages whose code is 'message:tech_duplicated_facts1'.

Does not include code 'formula:assertionUnsatisfied' with tech_duplicated_facts1 in the beginning of the message (more than 2 duplicated facts).

filing_api_id: str | None

api_id of filing object.

filing: Filing | None

Filing of this validation message.

__repr__()

Return repr with api_id, code and severity.

Return type:

str

__str__()

Return “[severity[:3] code] text”.

Attribute severity shows only the first three characters. Square brackets are used to encompass severity and code.

Return type:

str