Servidor MCP
schedule-iii
com.datavrn/schedule-iii
Qué hace este MCP
Transforms Indian company trial balances into controlled Schedule III financial statement workbooks with account mappings, disclosures, comparative data, management allocations, and finalisation workflows.
Capacidades
Herramientas
67
herramientas
assert_previous_year_no_activity
Record that the previous year genuinely had no activity
Record your userâs assertion that the previous year genuinely had no activity, so this statementâs all-nil previous-year Profit and Loss is a fact rather than a closing-entry artefact. This clears Datavrnâs refusal to finalise it. THIS IS A PROFESSIONAL ASSERTION ABOUT A CLIENTâS ACCOUNTS, RECORDED IN THE NAMED MEMBERâS NAME AND KEPT WITH THE STATEMENT. Only send it when your user has told you, in their own words, that the previous year had no activity â a dormant entity is the case it is for. NEVER write the reason yourself and never paraphrase it into something firmer: send what they said. If they are unsure, or if the previous year DID trade and the trial balance was simply taken after closing, do not call this â the other two remedies in get_comparative_source_state are the correct ones. Call get_comparative_source_state first, read out the finding, get their explicit go-ahead, and send the confirm_token it returned. Datavrn refuses if the previous-year figures changed after you read the state, and nothing is recorded. It can be withdrawn in Datavrn if it was recorded in error; withdrawing restores the refusal.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id', 'reason', 'confirm_token'], 'properties': {'reason': {'type': 'string', 'maxLength': 2000, 'minLength': 1, 'description': 'Your userâ\x80\x99s own words: why the previous year had no activity. Recorded with the statement and shown to whoever reviews it.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid', 'description': 'The reporting period id â\x80\x94 from list_periods.'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': "The statement template id (e.g. 'schedule3_v1' Division I; see list_snapshots/workspace)."}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}, 'confirm_token': {'type': 'string', 'maxLength': 200, 'minLength': 20, 'description': 'The approval from get_comparative_source_state. Call it first and present its finding to your user.'}}, 'additionalProperties': False}
confirm_capture_review
Confirm a section has been reviewed
Record your userâs confirmation that they have REVIEWED a whole section and it is complete â the entire previous-year comparative column, or the entire disclosure set. A review confirmation is your userâs professional assertion, recorded as authorised by them. Before calling this, show them what you are confirming â the whole comparative, or the whole disclosure set â and get their explicit go-ahead. Never confirm a review that has not happened. Saving figures or text does NOT complete these two sections and never has; only this confirmation does. The confirmation is pinned to the exact set that was reviewed, so ANY later save to that section withdraws it â if a confirmation appears not to stick, the next step is to re-review and confirm again, never to retry. Confirming again after such a change supersedes the earlier confirmation: it is marked withdrawn (it stays on the record) and the response names what was withdrawn. Re-confirming also invalidates any finalise approval you already hold. Only two sections take a review confirmation: the previous-year comparative and the disclosure set. Every other section is answered by saving its rows, or by declare_capture_na. Datavrn notifies the member you name that this was recorded in their name. Generate a fresh version after your last capture change â finalisation checks the versionâs frozen capture state, not todayâs.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id', 'capture_kind', 'reason_code'], 'properties': {'note': {'type': 'string', 'maxLength': 2000, 'minLength': 1}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'reason_code': {'enum': ['comparative_reviewed_complete', 'disclosures_reviewed_complete'], 'type': 'string'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'capture_kind': {'enum': ['adjustments', 'prior_year_values', 'asset_movements', 'provision_movements', 'reserves_movements', 'share_capital', 'partner_capital', 'settings', 'disclosures'], 'type': 'string'}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}}, 'additionalProperties': False}
confirm_centre_mappings
Confirm cost-centre mappings
Persist only the explicit account-to-centre decisions the user approved. Before calling, show the proposal grouped by confidence tier and target with exact counts, call out every medium/low-confidence row, and get a clear approval for the enumerated items. Omitted accounts stay unchanged; there is no apply-all, auto-confirm, or use-suggestions flag. Each item writes ONE dimension, chosen by target_type: "cost_centre" writes the cost-centre policy and "profit_centre" writes the profit-centre policy. The two are independent â writing one never replaces the other â and the same account may appear once per dimension in a single call. A centre policy can only be set on a profit-and-loss account: an account Datavrn resolves to a balance-sheet type, or has not classified yet, is refused by name and nothing is saved. After the write, report confirmed, unmapped_total and unmapped_with_balance (the cost dimension), and profit_unmapped_total and profit_unmapped_with_balance (the profit dimension) so the user knows exactly what remains. When profit_centres_total is 0 the profit dimension is not in use and no account needs a profit-centre policy â never report the entity as profit-mapped. Read profit_mapped_total beside it: 0 means no account holds one, and above 0 means the dimension has been closed while that many accounts still carry a saved policy pointing at a deactivated centre. The counts describe the policies in force on counts_as_of. A write can be saved and still not be in force, in two ways, and next_action says which: effective_from later than counts_as_of (not in force yet), or superseded_total above 0 (that many of these accounts already carry a LATER version that is in force, so this back-dated write changes nothing visible). In either case do not repeat the call. This tool never returns rupee amounts.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'effective_from', 'items'], 'properties': {'items': {'type': 'array', 'items': {'type': 'object', 'required': ['account_id', 'centre_id'], 'properties': {'centre_id': {'type': 'string', 'format': 'uuid'}, 'account_id': {'type': 'string', 'format': 'uuid'}, 'target_type': {'enum': ['cost_centre', 'profit_centre'], 'type': 'string'}, 'source_of_suggestion': {'anyOf': [{'enum': ['library', 'per_client_history', 'manual'], 'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, 'maxItems': 1000, 'minItems': 1, 'description': 'Every account decision explicitly approved by the user; never a blanket flag.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'removal_count': {'type': 'integer', 'minimum': 0, 'description': 'The exact removal count returned by the removal preview.'}, 'removal_token': {'type': 'string', 'maxLength': 200, 'minLength': 20, 'description': 'Only include the short-lived token returned by the removal preview for this exact proposal.'}, 'effective_from': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'The effective date shown to the user.'}}, 'additionalProperties': False}
confirm_column_mapping
Confirm column mapping
Confirm the columnâfield mapping for a staged upload and run validation. Returns the full validation result (row counts, warnings, blocking issues). Mapping suggestions are never auto-applied â pass exactly the mapping your user approved. Review any warnings with your user before ingesting.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['upload_id', 'mapping'], 'properties': {'mapping': {'type': 'object', 'additionalProperties': {'type': 'string', 'minLength': 1}}, 'options': {'type': 'object', 'properties': {'wide': {'type': 'boolean'}, 'buckets': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'minItems': 1}, 'pnl_basis': {'enum': ['period_activity', 'cumulative_fy'], 'type': 'string'}, 'as_at_date': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'party_type': {'enum': ['receivable', 'payable'], 'type': 'string'}, 'date_format': {'enum': ['DMY', 'MDY'], 'type': 'string'}, 'declared_to': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$'}, 'period_start': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'declared_from': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$'}, 'number_format': {'enum': ['comma_grouped', 'european'], 'type': 'string'}, 'basis_confirmed': {'type': 'boolean'}}, 'additionalProperties': False}, 'save_as': {'type': 'string', 'maxLength': 120, 'minLength': 1}, 'upload_id': {'type': 'string', 'format': 'uuid', 'description': 'The upload session id returned by upload_trial_balance.'}}, 'additionalProperties': False}
confirm_complete_chart
Confirm an upload is the entityâs whole chart
Record your userâs explicit confirmation that one upload is an entityâs COMPLETE CURRENT chart of accounts, so Datavrn starts treating it as evidence when checking whether future files belong to that entity. Recorded as authorised by the member you name. THIS IS A PROFESSIONAL JUDGMENT, NOT A CALCULATION. Datavrn will never make it from the numbers, and neither should you: call preview_chart_rebaseline for that upload first, read its counts to your user, and ask them plainly whether that upload is the entityâs whole book now. Confirming a file that is NOT the entityâs chart teaches Datavrn the wrong chart and weakens wrong-entity detection for that entity from then on. Send back the state_digest and confirm_token from the SAME preview_chart_rebaseline response, unchanged. Datavrn refuses and changes nothing if: the entityâs uploads moved after you were shown those figures, someone already confirmed this upload, the upload no longer needs confirming, or it is one Datavrn asked about directly â for those, answering that question is what settles it. Nothing about the landed figures changes: this affects only which uploads count as evidence of identity.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'source_snapshot_id', 'state_digest', 'confirm_token'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}, 'state_digest': {'type': 'string', 'maxLength': 200, 'minLength': 16, 'description': 'The state_digest from the same preview_chart_rebaseline response, unchanged. It pins the figures your user was shown; a different one is refused.'}, 'confirm_token': {'type': 'string', 'maxLength': 200, 'minLength': 20, 'description': 'The approval from preview_chart_rebaseline. Call it first and present its counts to your user.'}, 'source_snapshot_id': {'type': 'string', 'format': 'uuid', 'description': 'The uploadâ\x80\x99s id â\x80\x94 the `snapshot_id` field of a list_chart_rebaselines row.'}}, 'additionalProperties': False}
confirm_groupings
Confirm account groupings
Persist USER-approved accountâline groupings. Omitted accounts stay unchanged. Only explicit leaf_code:null clears a saved grouping. When clearing a saved grouping, use the current grouping_version from list_grouping_suggestions. An actual clear first returns an approval request; nothing changes then. Resend the unchanged request with the approval details to proceed. Clearing an already-unclassified account is an idempotent no-op. Every row must be explicit â there is deliberately no "apply all suggestions" option.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'decisions'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'decisions': {'type': 'array', 'items': {'type': 'object', 'required': ['account_id', 'leaf_code'], 'properties': {'leaf_code': {'anyOf': [{'type': 'string', 'maxLength': 80, 'minLength': 1}, {'type': 'null'}]}, 'account_id': {'type': 'string', 'format': 'uuid'}, 'suggested_reason': {'type': 'string', 'maxLength': 400, 'minLength': 1}, 'is_cash_equivalent': {'type': ['boolean', 'null']}, 'suggested_confidence': {'enum': ['high', 'medium', 'low'], 'type': 'string'}}, 'additionalProperties': False}, 'maxItems': 2000, 'minItems': 1}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'removal_count': {'type': 'integer', 'maximum': 2000, 'minimum': 1}, 'removal_token': {'type': 'string', 'maxLength': 200, 'minLength': 20}, 'grouping_version': {'type': 'integer', 'minimum': 0}}, 'additionalProperties': False}
confirm_reporting_lines
Confirm reporting-line mappings
Persist only the explicit reporting-line decisions the user approved. Before calling, show the proposal grouped by confidence tier and target with exact counts, flag every medium/low-confidence row, and get clear approval for the enumerated decisions. Omitted accounts stay unchanged. Sending leaf_code:null permanently removes that account saved reporting line; send it only when the user explicitly asked to clear that row. There is no apply-all or auto-confirm flag. The response tells you how many were confirmed, cleared, and whether the balance-bearing set is fully mapped; never claim completion without checking those fields.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'decisions'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'decisions': {'type': 'array', 'items': {'type': 'object', 'required': ['account_id', 'leaf_code'], 'properties': {'leaf_code': {'anyOf': [{'type': 'string', 'maxLength': 80, 'minLength': 1}, {'type': 'null'}]}, 'account_id': {'type': 'string', 'format': 'uuid'}, 'suggested_reason': {'type': 'string', 'maxLength': 400, 'minLength': 1}, 'suggested_confidence': {'enum': ['high', 'medium', 'low'], 'type': 'string'}}, 'additionalProperties': False}, 'maxItems': 2000, 'minItems': 1}, 'removal_count': {'type': 'integer', 'minimum': 0, 'description': 'The exact removal count returned by the removal preview.'}, 'removal_token': {'type': 'string', 'maxLength': 200, 'minLength': 20, 'description': 'Only include the short-lived token returned by the removal preview for this exact proposal.'}}, 'additionalProperties': False}
copy_capture_declarations
Copy last periodâs capture answers
Copy the previous periodâs "nothing this period" and "does not apply" answers into this period, for sections that have no answer yet. It NEVER copies a review confirmation â a review is about this periodâs content and cannot be inherited. Last periodâs answer is not evidence about this period: list what it would copy to your user, section by section, and get their go-ahead before calling it. Answers already recorded for this period are left alone. Generate a fresh version after your last capture change â finalisation checks the versionâs frozen capture state, not todayâs.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}}, 'additionalProperties': False}
create_client
Create entity
Create a new entity (company) in the organization. Requires a Manager-role key. Use only when the user explicitly asks to set up a new entity; show them the name you will create first.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'business_model_code': {'anyOf': [{'type': 'string', 'minLength': 1}, {'type': 'null'}]}}, 'additionalProperties': False}
create_cost_centre
Create a cost centre
Create one cost centre for an entity after showing the user the exact name, kind, parent, effective date, and reason. This is one explicit centre at a time; there is no apply-all shortcut. After creating it, call list_cost_centres again and explain which mapping suggestions can now use it.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'name', 'reason'], 'properties': {'code': {'anyOf': [{'type': 'string', 'maxLength': 80}, {'type': 'null'}], 'description': 'Optional short code.'}, 'name': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': 'The cost-centre name to create.'}, 'reason': {'type': 'string', 'maxLength': 500, 'minLength': 3, 'description': 'Why the user asked for this centre.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'centre_kind': {'enum': ['operating', 'support'], 'type': 'string', 'description': 'Operating or shared-support centre; defaults to operating.'}, 'description': {'anyOf': [{'type': 'string', 'maxLength': 1000}, {'type': 'null'}], 'description': 'Optional plain-language description.'}, 'effective_from': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'Date from which this centre applies; defaults to the start of the entity data.'}, 'parent_cost_centre_id': {'anyOf': [{'type': 'string', 'format': 'uuid'}, {'type': 'null'}], 'description': 'Optional existing parent cost-centre id.'}}, 'additionalProperties': False}
create_profit_centre
Create a profit centre
Create one profit centre for an entity after showing the user the exact name, optional parent, and description. This is one explicit centre at a time; there is no apply-all shortcut. Re-list the centres after creation so the user can see the new target before any mapping confirmation.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'name'], 'properties': {'name': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': 'The profit-centre name to create.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'description': {'anyOf': [{'type': 'string', 'maxLength': 1000}, {'type': 'null'}], 'description': 'Optional plain-language description.'}, 'parent_profit_centre_id': {'anyOf': [{'type': 'string', 'format': 'uuid'}, {'type': 'null'}], 'description': 'Optional existing parent profit-centre id.'}}, 'additionalProperties': False}
create_upload_link
Create upload link
Mint a single-use, login-free upload link so a file reaches Datavrn WITHOUT passing through your context, where it cannot truncate or corrupt. Use this whenever a human has the file (a trial balance export, etc.) â and also whenever YOU hold the file and it is larger than about 10 KB. This is the RELIABLE path at that size: inlined base64 mutates often enough that the damage arrives as a plausible-looking trial balance rather than an obvious error, while the link delivers the bytes byte-perfect. Two ways to deliver the file: a HUMAN opens upload_url in their browser and chooses the file; a PROGRAMMATIC caller that already holds the file on disk POSTs it to the SEPARATE upload_post_url as a multipart form with a single `file` field (upload_url is the human page and will not accept a POST). The POST reply carries received_file_hash â compare it to your local sha256 before confirming the mapping. The link stages the file for ONE entity and expires in about 15 minutes; nothing is ingested until the column mapping is confirmed.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'file_name'], 'properties': {'format': {'type': 'string', 'description': 'Leave unset â\x80\x94 the assistant handles Trial Balances only; any other format is refused (use the Datavrn web app).'}, 'source': {'type': 'string', 'description': "Set 'tally_file' when the file is a Tally xlsx export; omit otherwise."}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'file_name': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': "The file the user is expected to upload, e.g. 'tb-2026-03.xlsx' (shown on the upload page)."}}, 'additionalProperties': False}
declare_capture_na
Record nothing to report, or not applicable
Record that a capture section had NOTHING to report this period, DOES NOT APPLY to this entity, or that this is the entityâs FIRST YEAR (previous-year figures only). These are three different statements and are not interchangeable: "nothing this period" means the section applies but had no activity; "does not apply" means it never applies to this entity at all. This is your userâs professional assertion, recorded as authorised by them â ask which one is true, and never guess. NOT every reason is available for every section â call get_schedule3_workspace and read allowed_reason_codes on the section before you ask your user, so you never put a choice to them that Datavrn will refuse. The restrictions: Settings takes NO answer here at all (it is only answered by saving the settings); share capital and partner capital take only "nothing this period", because those sections are shown only for statement formats they apply to, so "does not apply" can never be true; and "first year" belongs only to previous-year figures. To record a REVIEW being complete (previous-year figures, disclosures) use confirm_capture_review instead; this tool cannot make that assertion. A section can only hold one active answer. If the sectionâs current answer is still standing, this call refuses â revoke it with revoke_capture_declaration first. If the current answer was already WITHDRAWN by later changes (Datavrn shows the section as unanswered), this call supersedes it: the old answer is marked withdrawn and stays on the record, and the response names what was withdrawn. An answer is never edited in place. Superseding or changing an answer invalidates any finalise approval you already hold â the next finalise_statement will ask you to review the current state again. Generate a fresh version after your last capture change â finalisation checks the versionâs frozen capture state, not todayâs.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id', 'capture_kind', 'reason_code'], 'properties': {'note': {'type': 'string', 'maxLength': 2000, 'minLength': 1}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'reason_code': {'enum': ['first_year', 'no_activity', 'not_applicable'], 'type': 'string'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'capture_kind': {'enum': ['adjustments', 'prior_year_values', 'asset_movements', 'provision_movements', 'reserves_movements', 'share_capital', 'partner_capital', 'settings', 'disclosures'], 'type': 'string'}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}}, 'additionalProperties': False}
finalise_statement
Seal the permanent client copy of a version
Seal a statement version as Datavrnâs permanent client copy, recorded as authorised by the member you name. THIS IS NOT APPROVAL OR ADOPTION OF THE FINANCIAL STATEMENTS AND IT IS NOT A SIGNATURE. It does not discharge section 134(1) for a company or section 34(3) for an LLP. THERE IS NO UNDO. A change afterwards means generating a new version and finalising that one; the version you seal here stays sealed. Call get_finalise_readiness first, show your user every gate and every warning it returns, get their explicit go-ahead, and only then send the confirm_token it gave you together with the acknowledgements. Never acknowledge a warning your user has not seen, and never write the acceptance reason yourself â it is their professional judgment in their own words. Datavrn will refuse if anything about the statement changed after you read the state, and nothing will be finalised. If the response comes back with reused set to true, a finalisation of this same version was already under way: nothing new was done and your approval was not used. Do not call finalise_statement again â the status field says where that finalisation is (queued, running, or paused, which means it hit a temporary problem and Datavrn will retry it on its own). Poll get_job with the job_id and tell your user what it says.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'snapshot_id', 'acknowledgments', 'confirm_token'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'snapshot_id': {'type': 'string', 'format': 'uuid'}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}, 'confirm_token': {'type': 'string', 'maxLength': 200, 'minLength': 20}, 'acknowledgments': {'type': 'object', 'required': ['advisory_labels', 'pending_input_count'], 'properties': {'reason': {'type': 'string', 'maxLength': 500, 'minLength': 1}, 'advisory_labels': {'type': 'array', 'items': {'type': 'string', 'maxLength': 500, 'minLength': 1}, 'maxItems': 50}, 'pending_input_count': {'type': 'integer', 'minimum': 0}}, 'additionalProperties': False}}, 'additionalProperties': False}
generate_schedule_iii
Generate Schedule III statements
Queue the Schedule III workbook build (returns a job_id to poll with get_job â the build runs as a background job). REFUSES when ungrouped accounts exist unless acknowledged: before acknowledging, present the ungrouped accounts to your user and obtain their explicit go-ahead; record it in acknowledge_reason and pass the exact count in acknowledge_count â an acknowledgement WITHOUT its count is always re-demanded. A multi-month statement period additionally requires acknowledge_multi_month_pnl WITH acknowledge_month_count (confirm with your user that the TBs are period movements, not cumulative). Never acknowledge anything the user has not seen. Once queued, the build usually completes in a few minutes â tell your user their statements are being prepared and poll get_job periodically; do not present the wait as a problem.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'acknowledge_count': {'type': 'integer', 'minimum': 0}, 'acknowledge_reason': {'type': 'string', 'maxLength': 500, 'minLength': 1}, 'acknowledge_month_count': {'type': 'integer', 'minimum': 0}, 'acknowledge_unclassified': {'type': 'boolean'}, 'acknowledge_multi_month_pnl': {'type': 'boolean'}}, 'additionalProperties': False}
get_allocation_account_figures
Read allocation account figures
MANAGEMENT data class. Read one explicit cost or profit partition of the current persisted allocation run at account grain. Cost-centre and profit-centre reconciliations are independent views of the same P&L activity; do not add them. Books figure plus spreading adjustment equals MIS figure, all as decimal-string rupees. Filter account names or minimum absolute MIS amount before paging. The signed page_token is source-pinned, so restart at page 1 if source_changed. known_stale and not_assessed disclose run state; neither means fresh.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'period', 'allocation_dimension'], 'properties': {'period': {'type': 'string', 'pattern': '^\\d{4}-(0[1-9]|1[0-2])$', 'description': 'Management month in YYYY-MM.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'page_size': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'Rows per source-pinned page (default 50, max 200).'}, 'page_token': {'type': 'string', 'maxLength': 4096, 'minLength': 1, 'description': 'Signed continuation from the prior page; restart without it if source_changed.'}, 'min_abs_mis': {'type': 'string', 'pattern': '^\\d{1,16}(\\.\\d{1,2})?$', 'description': "Minimum absolute MIS figure in rupees as a decimal string, e.g. '100000'."}, 'allocation_dimension': {'enum': ['cost', 'profit'], 'type': 'string', 'description': 'Required partition: cost for cost-centre or step-down questions; profit for profit-centre questions. Do not add the two views.'}, 'account_name_patterns': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 10, 'description': 'Up to 10 case-insensitive account-name substrings; any match is retained.'}}, 'additionalProperties': False}
get_allocation_target_figures
Read allocation target figures
MANAGEMENT data class. Read one explicit cost or profit partition of the current persisted allocation run at account à target à source à mode grain, with decimal-string allocated amounts. Cost-centre and profit-centre reconciliations are independent views of the same P&L activity; do not add them. Final post-step-down cost uses the complete selected cost population: non-step-down plus signed step-down. Filter allocation_sources=['step_down'] only to inspect transfers and confirm their run net is zero. Accounted equals assigned plus Unallocated; Unallocated is not additional. For profit centres, choose profit. Use filters before paging; the signed page_token is source-pinned, so restart at page 1 if source_changed. Target labels use the current governed centre timeline evaluated at the run period (target_labels_frozen: false); persisted allocation amounts stay unchanged. A controlled in-period centre correction changes a displayed label and invalidates the page token; restart at page 1 without regenerating allocation. Review run staleness and methodology, and regenerate when either changed. An integrity failure means regenerate, retry, then contact support if it recurs. No owners, descriptions, source transactions, or recomputation are returned.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'period', 'allocation_dimension'], 'properties': {'period': {'type': 'string', 'pattern': '^\\d{4}-(0[1-9]|1[0-2])$', 'description': 'Management month in YYYY-MM.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'page_size': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'Rows per source-pinned page (default 50, max 200).'}, 'page_token': {'type': 'string', 'maxLength': 4096, 'minLength': 1, 'description': 'Signed continuation from the prior page; restart without it if source_changed.'}, 'target_types': {'type': 'array', 'items': {'enum': ['cost_centre', 'sub_cost_centre', 'profit_centre', 'sub_profit_centre', 'unallocated'], 'type': 'string'}, 'maxItems': 5, 'description': 'Restrict to allocation target types.'}, 'min_abs_amount': {'type': 'string', 'pattern': '^\\d{1,16}(\\.\\d{1,2})?$', 'description': "Minimum absolute allocated amount in rupees as a decimal string, e.g. '100000'."}, 'allocation_sources': {'type': 'array', 'items': {'enum': ['account_mapping', 'source_dimension', 'unallocated', 'step_down'], 'type': 'string'}, 'maxItems': 4, 'description': 'Restrict to allocation sources.'}, 'allocation_dimension': {'enum': ['cost', 'profit'], 'type': 'string', 'description': 'Required partition: cost for cost-centre or step-down questions; profit for profit-centre questions. Do not add the two views.'}, 'account_name_patterns': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 10, 'description': 'Up to 10 case-insensitive account-name substrings; any match is retained.'}}, 'additionalProperties': False}
get_budget
Read budget
MANAGEMENT data class. Read one versioned budget: identity-free header, its pinned P&L tree, and filtered/paginated cells with entered-versus-inferred truth. Amounts and locked FX rate are decimal strings. Filter months, lines, centres, or inference before paging; the signed page_token is source-pinned, so restart at page 1 if source_changed. Cells across different P&L lines are not one meaningful grand total, so no cross-line grand total is exposed. No people, ownership, editability, or approval identities are returned.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'budget_id'], 'properties': {'month': {'type': 'string', 'pattern': '^\\d{4}-(0[1-9]|1[0-2])$', 'description': 'Optional budget month in YYYY-MM.'}, 'budget_id': {'type': 'string', 'format': 'uuid', 'description': 'Budget id from list_budgets.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'inference': {'enum': ['all', 'entered', 'inferred'], 'type': 'string', 'description': 'Cell inference state (default all).'}, 'page_size': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'Cells per source-pinned page (default 100, max 200).'}, 'line_codes': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 25, 'description': 'Up to 25 P&L line codes.'}, 'page_token': {'type': 'string', 'maxLength': 4096, 'minLength': 1, 'description': 'Signed continuation from the prior page; restart without it if source_changed.'}, 'cost_centre_ids': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 25, 'description': 'Up to 25 cost-centre ids.'}}, 'additionalProperties': False}
get_comparative_source_state
Check the previous-year comparative source
Check whether this statementâs previous-year comparative can be sealed, and get the approval assert_previous_year_no_activity needs. Datavrn refuses to finalise a statement whose previous-year figures come from a trial balance drawn AFTER the year-end closing entries: that derives a previous-year Profit and Loss of all zeroes which foots perfectly and is not last yearâs results. When post_closing_detected is true, READ THE WHOLE finding TO YOUR USER â what the state is and all three ways out â and let them choose. Never choose for them. Two of the three remedies are things only they can do (upload the pre-closing trial balance, or enter last yearâs signed figures as previous-year values, then generate a fresh version). The third is an assertion that the previous year genuinely had NO ACTIVITY, which is a statement about their clientâs accounts, in their words, recorded in their name â a dormant company is the case it exists for. The approval is single-use, expires in 15 minutes, and is tied to this statement, this connection and the member you name; if the previous-year figures change in between, the assertion will be refused and you start again from here. If nothing is wrong there is no approval to hand back, because there is nothing to assert.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid', 'description': 'The reporting period id â\x80\x94 from list_periods.'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': "The statement template id (e.g. 'schedule3_v1' Division I; see list_snapshots/workspace)."}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}}, 'additionalProperties': False}
get_consolidated_statements
Read sealed consolidated statements
CONSOLIDATED data class. Read one sealed group profit-and-loss, balance-sheet, or cash-flow face for an exact periodicity and period. The response exposes presentation currency and exactly one decimal-string amount per line: section-natural for P&L/BS, signed cash movement for CFS. Amounts are persisted on the sealed run; P&L/BS labels are current display metadata and the signed page_token is source-fingerprinted across the complete safe face, so a changed value or label requires restarting at page 1. A stale sealed run is disclosed on every page and is never called current. Member names, components, eliminations, journal references and lineage are not returned. QUALIFICATIONS. A response may carry `owned_share_capital_caveat` (at seal, share capital owned by the group could not be eliminated, so those amounts remained inside consolidated share capital as the engine computed it; the DISPLAYED line may differ in either direction where a manual journal also moved it, so never characterise the direction from this field alone) and always carries `domestic_cash_flow_caveat`. These qualify specific statement lines. When a caveat is present, any figure it qualifies MUST be presented together with its qualification â never the number alone. `owned_share_capital_caveat` is null when the run was read and carries no such qualification, and `{status: "unavailable"}` when the runâs qualification record could not be read at all, which is not the same as clean: say so rather than presenting the figures as final. WITHHELD CASH FLOW. `cash_flow_status` may say the cash flow was not presented â for a group with a foreign member, or for a window with no opening balance sheet to measure from. An empty `cash_flow` then means the statement was WITHHELD, never that the group had no cash movements: say so. For the missing-opening-basis case `cash_flow_refusal` carries the cause, the message and `remedies`, each tagged with the channel that can perform it â `agent_or_app` you can do here, `app_only` needs a person in the Datavrn app. Never present an app_only remedy as something you will do. `cash_flow_opening_basis` states what a PRESENTED statement measured from; "not_recorded" means the run was sealed before Datavrn recorded that, so its basis is unknown â do not assume a prior period. ROW ROLES. Every statement row carries `row_role`: "line" participates in its section total, "total" restates it (Profit after tax), "attribution" splits a total (the amounts attributable to the owners and to the minority interest). To total a section, sum ONLY rows whose row_role is "line" â including a total or attribution row would double-count the groupâs profit. Present the attribution rows as the split of profit after tax, never as additional income. Consolidated cash-flow is available only for an all-domestic group in v1. If any member uses a foreign currency, Datavrn does not present a consolidated cash-flow statement. Where it is presented, it is prepared by the indirect method from balance-sheet movements rather than from cash records, and classified into operating, investing and financing activities using each entityâs reporting-line mapping. Interest paid and taxes paid are not disclosed separately, so they remain inside the operating movement; a movement whose reporting line carries no cash classification is shown under âUnclassified movements â reviewâ rather than assigned to an activity. Datavrn does not present other comprehensive income or total comprehensive income in the consolidated output.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['group', 'periodicity', 'period'], 'properties': {'group': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': 'An active group UUID or its exact case-insensitive display name.'}, 'period': {'type': 'string', 'maxLength': 10, 'minLength': 1, 'description': 'The period matching periodicity.'}, 'page_size': {'type': 'integer', 'maximum': 100, 'minimum': 1, 'description': 'Rows per source-pinned page (default 50, max 100).'}, 'statement': {'enum': ['pnl', 'balance_sheet', 'cash_flow'], 'type': 'string', 'description': 'Statement face (default pnl).'}, 'page_token': {'type': 'string', 'maxLength': 4096, 'minLength': 1, 'description': 'Signed continuation from the prior page; restart without it if source_changed.'}, 'periodicity': {'enum': ['monthly', 'quarterly', 'annual'], 'type': 'string', 'description': 'Period grammar: monthly YYYY-MM, quarterly FYyyyy-Qn, annual FYyyyy.'}}, 'additionalProperties': False}
get_finalise_readiness
Check finalisation state and get approval
Read the full finalisation state of one statement version, and get the approval finalise_statement needs. Call it ONCE immediately before finalising â it re-reads the stored workbook, so do not poll it. SHOW YOUR USER EVERY ROW THIS RETURNS â the gates that must be green, each warning they would be accepting and why, how many input cells are still empty, any control that could not be evaluated, and capture_live_diverged_message when it is present â before you finalise. Do not summarise the warnings away. capture_live_diverged_message means a capture answer changed after this version was generated: the version can still be sealed as it stands, and generating a fresh one is the alternative. Read it out and let your user choose. A control that "could not be evaluated" is not a pass: it is a check Datavrn did not run, and your user is entitled to know what was not checked before they seal the version. The approval is single-use, expires in 15 minutes, and is tied to this exact version, this connection and the member you name â if anything about the statement changes in between, finalise_statement will refuse and you start again from here. If your connection is not permitted to finalise, you still get the whole state; there is simply no approval to hand back.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'snapshot_id'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'snapshot_id': {'type': 'string', 'format': 'uuid', 'description': 'The statement version id â\x80\x94 from list_snapshots or get_schedule3_workspace.'}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}}, 'additionalProperties': False}
get_help
Get the agent guide
Get the Datavrn agent guide: how connecting works (OAuth and API key), what an assistant can do, how reading a statement as data works, and the guarantees and limits â plus the current list of tools. Call this to answer a user's questions about how Datavrn works from canonical documentation instead of guessing.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}}
get_job
Get job status
Poll a background job by id until status is succeeded or failed. A failed job carries its user-safe error reason â show it to your user. Jobs run on a background worker that claims queued work on a schedule, so a job sitting at "queued" (0 attempts) for the first few minutes is NORMAL, not a fault â keep polling every ~30â60s and reassure the user it is being prepared; do NOT report this as an error or a Datavrn bug. Only if it is still "queued" well past a few minutes should you tell the user it is taking longer than usual.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['job_id'], 'properties': {'job_id': {'type': 'string', 'format': 'uuid', 'description': 'The job id returned by generate_schedule_iii.'}}, 'additionalProperties': False}
get_partner_capital
Read partner or owner capital schedule
Read the partner or owner capital schedule currently on file â Note 3a and Note 3b. THIS RETURNS PEOPLEâS NAMES, along with each personâs profit-sharing ratio and amounts. Call it before save_partner_capital so you can show your user what is on file and what your change would do â that save replaces the whole section, so a schedule you cannot see is a schedule you cannot safely replace. It also returns the total of the capital-account profit-sharing ratios, because Datavrn warns about a total that is not 100% only when at least two rows carry a ratio.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id'], 'properties': {'limit': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'Page size (default 50, max 200).'}, 'offset': {'type': 'integer', 'minimum': 0, 'description': 'Rows to skip (default 0).'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid', 'description': 'The reporting period id â\x80\x94 from list_periods.'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': "The statement template id (e.g. 'schedule3_v1' Division I; see list_snapshots/workspace)."}, 'account_kind': {'enum': ['capital', 'current'], 'type': 'string', 'description': "Limit to one section: 'capital' is Note 3a, 'current' is Note 3b. Omit for both."}}, 'additionalProperties': False}
get_pending_work
List pending work across entities
Answer "what's left to do?" across every entity you can see â one row per entity, with what is blocking its Schedule III statement: whether the trial balance is in, how many accounts are still ungrouped, the latest generated version, and whether it has been finalised. Pass period_label to pick a period, or omit to default to the period most of your entities have a trial balance for (not necessarily the newest â one entity uploading a future period early will not flip the board). Rows include deep links that open the Datavrn web app (a login is needed there). It also answers a second question nothing else here does: restorable_replacements lists automatic connector syncs that REPLACED an entity's data and can still be undone, soonest-closing first, each with the date its 30-day undo window shuts â after that the replaced data cannot be put back, and no message ever announces that clock running out, so raise these with your user rather than waiting to be asked (use list_replacements and preview_replacement_restore on the ids given; restorable_replacements_omitted says how many more were not listed).
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'period_label': {'type': 'string', 'description': "Reporting period label, e.g. '2026-03'; omit to default to the period most of your entities have a trial balance for."}}, 'additionalProperties': False}
get_schedule3_workspace
Get Schedule III workspace
THE state tool: grouping progress, every required capture answer, generated/finalised versions, finalisation blockers, and bounded per-version control summaries. Report generation never marks capture complete. Exception output is rule/severity/count only â no account names or amounts. Call this to know what is left before finalising.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid', 'description': 'The reporting period id â\x80\x94 from list_periods.'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': "The statement template id (e.g. 'schedule3_v1' Division I; see list_snapshots/workspace)."}}, 'additionalProperties': False}
get_setup_status
Show setup status and the next step
Answer "how do I get started?", "what do I do next?", or help a user who seems lost setting up. Returns where they are in the journey from an empty organization to a finished Schedule III statement, and the ONE next step to take. Call it WITHOUT client_id first (the organization view): it lists the entities this credential can see, or â if there are none â the step to create the first one. Then call it again WITH one entityâs client_id for that entityâs full step-by-step path (upload trial balance â confirm groupings â capture figures â generate â download). Each step has a status (done / next / todo / blocked / web_only) and either the exact tool to call or a web-app link. NARRATE ONE STEP AT A TIME â walk the user through the single `next` step; do not dump the whole list unprompted. Steps marked web_only are done in the Datavrn web app and need a login â never claim you can do them yourself. This tool reports STATUS only (counts, names, what is done) â it never returns a figure or balance; read those with get_statement_figures once a statement is generated.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'An entity id (from list_clients or the organization view) for that entityâ\x80\x99s full path; omit for the organization-level overview and, on an empty org, the create-entity step.'}}, 'additionalProperties': False}
get_spreading_reconciliation
Read spreading reconciliation
MANAGEMENT data class. Read the persisted books-to-MIS spreading reconciliation, not a new allocation run. Accounts view gives account-grain books plus adjustments equals MIS; adjustments view requires one account and pages its rule adjustments. Money is decimal-string rupees. Whole-run summary figures never change with account filters. The signed page_token is source-pinned, so restart at page 1 if source_changed. Raw warning context is withheld; known_stale and not_assessed are disclosure states, not freshness claims.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'period'], 'properties': {'view': {'enum': ['accounts', 'adjustments'], 'type': 'string', 'description': 'accounts (default) or adjustments; adjustments requires account_id.'}, 'period': {'type': 'string', 'pattern': '^\\d{4}-(0[1-9]|1[0-2])$', 'description': 'Management month in YYYY-MM.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'page_size': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'Rows per source-pinned page: accounts default 25/max 100; adjustments default 50/max 200.'}, 'account_id': {'type': 'string', 'format': 'uuid', 'description': 'Required for adjustments view; an account in this entity and run.'}, 'page_token': {'type': 'string', 'maxLength': 4096, 'minLength': 1, 'description': 'Signed continuation from the prior page; restart without it if source_changed.'}, 'account_name_patterns': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 10, 'description': 'Up to 10 case-insensitive account-name substrings; any match is retained.'}}, 'additionalProperties': False}
get_statement_figures
Read statement figures
Read a generated Schedule III statement's figures: the balance-sheet and profit-and-loss faces, current-year and previous-year balance-sheet tie verdicts separately (a null verdict means UNKNOWN, never a pass: either no comparative was captured, or the version predates per-column balance recording), the unclassified count, and the notes listed by number. Also returns bounded exception counts by rule/severity and the frozen control changes versus the immediately previous recorded version; it never recomputes either from live books. Figures come from a generated version (the latest unless you pass a specific version) and match the workbook exactly. If the version was generated before figure reads existed it returns available:false with reason "figures_not_available" and only the legacy flat tie verdict; tell the user to generate the statement again, read the latest version, then retry. For a note's line-by-line breakdown, use its note_index entry with get_statement_notes. Amounts are decimal strings in rupees. ONE EXCEPTION: the profit-and-loss face ends with the statutory earnings-per-share rows, marked kind:"eps". Their figures are â¹ PER SHARE, not rupees of profit â report them as EPS and never add them into a face total. They are null until the weighted average share counts are saved in statement settings. Figures are Datavrn's deterministic engine output; interpretation is your assistant's.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id'], 'properties': {'version': {'type': 'integer', 'minimum': 1, 'description': 'A specific statement version; omit for the latest.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid', 'description': 'The reporting period id â\x80\x94 from list_periods.'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': "The statement template id (e.g. 'schedule3_v1' Division I; see list_snapshots/workspace)."}}, 'additionalProperties': False}
get_statement_notes
Read statement notes
Read the line-by-line breakdown of a generated statement's notes â every line's current and prior-year amount, and the note total. Pass note_numbers (from get_statement_figures' note_index) to fetch specific notes, or omit for all. Use this to answer "what's in Other Expenses?" or "what makes up trade receivables?". Each line has a kind: 'component' (an additive line), 'subtotal' (a presentational group subtotal â do NOT add it into the total, or you double-count), or 'header'. Fixed-asset / intangible notes carry a `block` per class with gross_block, accumulated depreciation, and net (the additions/deletions movement schedule itself lives in the workbook). If the full set is too large it returns too_large:true with a note_index â fetch note_numbers in small batches. A single very large note (e.g. a PPE schedule or an ageing note) is returned in explicitly-flagged line pages: each page carries the authoritative note total, lines_page, lines_total, and has_more_lines â keep fetching lines_page until has_more_lines is false; never treat one page's lines as the whole note. Amounts are decimal strings in rupees. Figures are Datavrn's deterministic engine output; interpretation is your assistant's.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id'], 'properties': {'version': {'type': 'integer', 'minimum': 1, 'description': 'A specific statement version; omit for the latest.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid', 'description': 'The reporting period id â\x80\x94 from list_periods.'}, 'lines_page': {'type': 'integer', 'minimum': 1, 'description': 'For a single very large note returned in line pages: the 1-based line page to fetch (fetch exactly one note; keep going until has_more_lines is false).'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': "The statement template id (e.g. 'schedule3_v1' Division I; see list_snapshots/workspace)."}, 'note_numbers': {'type': 'array', 'items': {'type': ['string', 'number']}, 'description': 'Specific note numbers to fetch (from note_index); omit for all notes.'}}, 'additionalProperties': False}
get_tb_rows
Read trial-balance source data
Read the SOURCE DATA behind a statement: the trial-balance rows (account name, debit, credit) as landed for a period, BEFORE grouping â the pre-statement numbers, not statement figures. PREFER FILTERS over fetching everything: name_patterns (e.g. ['cash','bank','od']), side ('debit'/'credit' by net balance), and min_abs_balance return a small exact subset with its own debit/credit totals â e.g. wrong-side cash accounts = name_patterns ['cash','bank'] + side 'credit'. Paginated (page 1-based; page_size default 50, max 500). These are the CURRENT live rows: statement figures are frozen at a generated version, so if the trial balance was re-uploaded after a version was generated, these rows may not tie to that version (the response `note` says so). Amounts are decimal strings in rupees. Figures are Datavrn's deterministic engine output; interpretation is your assistant's.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'period_id'], 'properties': {'page': {'type': 'integer', 'minimum': 1, 'description': '1-based page number (default 1).'}, 'side': {'enum': ['debit', 'credit'], 'type': 'string', 'description': 'Keep only accounts whose net balance falls on this side (debit = debits exceed credits). Accounts netting to zero match neither.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'page_size': {'type': 'integer', 'maximum': 500, 'minimum': 1, 'description': 'Rows per page (default 50, max 500 â\x80\x94 prefer filters over big pages).'}, 'period_id': {'type': 'string', 'format': 'uuid', 'description': 'The reporting period id â\x80\x94 from list_periods.'}, 'name_patterns': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 10, 'description': "Up to 10 case-insensitive substrings; an account matches if its name contains ANY of them (e.g. ['gst','tds'])."}, 'min_abs_balance': {'type': 'string', 'pattern': '^\\d{1,16}(\\.\\d{1,2})?$', 'description': "Keep only accounts whose balance (the larger of its debit/credit) is at least this many rupees â\x80\x94 a decimal string like '100000'."}}, 'additionalProperties': False}
get_upload
Get upload status
Read an upload session: status, detected header row and columns, the confirmed mapping (if any), and the stored validation outcome. Use to check what a staged upload still needs.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['upload_id'], 'properties': {'upload_id': {'type': 'string', 'format': 'uuid', 'description': 'The upload session id returned by upload_trial_balance.'}}, 'additionalProperties': False}
get_upload_link_status
Get upload link status
Check an upload link's state: pending (the user has not uploaded yet), uploaded (returns the upload_id â continue with get_upload), or expired (mint a fresh link with create_upload_link). Poll after the user says they uploaded the file.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['link_id'], 'properties': {'link_id': {'type': 'string', 'format': 'uuid', 'description': 'The link id returned by create_upload_link.'}}, 'additionalProperties': False}
get_variance_report
Read variance report
MANAGEMENT data class. Read the existing budget-or-prior variance report for a month; it never recalculates it. Amounts are decimal strings; a null actual or variance means unavailable, never zero. Rows view has whole-report unfiltered rollups and no cross-side grand total; filters affect only rows and filtered grain counts. Explanations view withholds internal notes and may redact structured PII. Filter lines or centres before paging; the signed page_token is source-pinned, so restart at page 1 if source_changed.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'period'], 'properties': {'view': {'enum': ['rows', 'explanations'], 'type': 'string', 'description': 'Report rows (default) or safe explanations.'}, 'basis': {'enum': ['budget', 'prior'], 'type': 'string', 'description': 'Comparator basis (default budget).'}, 'period': {'type': 'string', 'pattern': '^\\d{4}-(0[1-9]|1[0-2])$', 'description': 'Management month in YYYY-MM.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'page_size': {'type': 'integer', 'maximum': 100, 'minimum': 1, 'description': 'Rows per source-pinned page (default 50, max 100).'}, 'line_codes': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 25, 'description': 'Up to 25 P&L line codes.'}, 'page_token': {'type': 'string', 'maxLength': 4096, 'minLength': 1, 'description': 'Signed continuation from the prior page; restart without it if source_changed.'}, 'cost_centre_ids': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 25, 'description': 'Up to 25 cost-centre ids.'}}, 'additionalProperties': False}
get_workbook_download
Download workbook
Mint a short-lived signed URL for a frozen workbook version (the Excel file). Give the URL to your user to open in a browser â it needs no login and expires in about 10 minutes. The bytes are immutable and integrity-hashed.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'snapshot_id'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'snapshot_id': {'type': 'string', 'format': 'uuid', 'description': 'The snapshot id from list_snapshots.'}}, 'additionalProperties': False}
ingest_upload
Ingest upload into the books
Commit a validated upload into the entityâs books. This is a TWO-CALL approval: if the upload has any warnings, or would permanently delete existing trial-balance rows for a period it covers, the first call writes NOTHING and refuses with every warning, the exact record counts, and a short-lived removal_token. Show your user every warning and both counts, get their explicit go-ahead, then resend the SAME call adding removal_token and removal_count exactly as returned. acknowledge_warnings is IGNORED on this connection â the token is the only acknowledgment, so sending it changes nothing. A clean, additive ingest needs no token and succeeds on the first call. Returns the ingestion outcome including any notices.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['upload_id'], 'properties': {'upload_id': {'type': 'string', 'format': 'uuid', 'description': 'The upload session id returned by upload_trial_balance.'}, 'removal_count': {'type': 'integer', 'minimum': 0, 'description': 'The exact removal count returned by the removal preview.'}, 'removal_token': {'type': 'string', 'maxLength': 200, 'minLength': 20, 'description': 'Only include the short-lived token returned by the removal preview for this exact upload.'}, 'confirm_merges': {'type': 'array', 'items': {'type': 'object', 'required': ['prior_account_id', 'new_name'], 'properties': {'new_name': {'type': 'string', 'minLength': 1}, 'prior_account_id': {'type': 'string', 'format': 'uuid'}}, 'additionalProperties': False}}, 'acknowledge_warnings': {'type': 'boolean', 'default': False}, 'acknowledged_state_digest': {'type': 'string', 'pattern': '^[0-9a-f]{64}$', 'description': 'Browser/REST only, and IGNORED on the agent connection exactly as acknowledge_warnings is: the destroy_state_digest returned by the confirm-mapping step, resent unchanged so the server can prove the acknowledgment was given against the data that is still there. On this connection the removal_token already pins the rows at risk, so sending this changes nothing.'}}, 'additionalProperties': False}
list_account_mappings
Review account mappings
Review account-to-centre mapping status and deterministic suggestions for an entity. Each account carries TWO independent policies: mapping (the cost-centre policy) and profit_mapping (the profit-centre policy). Neither replaces the other. This is status-only: it returns account names, types, target names, confidence, reasons, and balance-bearing booleans, but never debit, credit, balance, or any rupee amount. Always present the rows grouped by confidence tier and target, state exact counts, flag every medium/low-confidence row, and show the completion counts: unmapped_total and unmapped_with_balance are the COST dimension (summary.scope says so), and profit_unmapped_total and profit_unmapped_with_balance are the profit dimension. Never add the two dimensions together, and never call an entity fully mapped on the cost counts alone. Do not call any count pending. Suggestions exist for the cost dimension only: suggestion_groups never describes profit work, and each rowâs centre_suggestion carries dimension "cost" â never present it as an answer to a profit-centre question. A row carrying mapping_targets_inactive is confirmed onto a cost centre that has since been DEACTIVATED, and a row carrying profit_mapping_targets_inactive is the same fact on the profit dimension: those target ids are absent from the centres and profit_centres lists because they are no longer valid targets. Report summary.mappings_with_inactive_target (which counts an account with a dead target on EITHER dimension) alongside the completion counts and never describe such an account as settled. profit_centres_total says which zero a zero profit count is, and profit_mapped_total says what survives: when profit_centres_total is 0 the profit dimension is not in use and no account NEEDS a profit-centre policy â say that, never that the profit dimension is complete. If profit_mapped_total is also 0, no account has one either; if it is above 0 the dimension has been CLOSED and that many accounts still carry a saved policy pointing at a deactivated centre, which you must report rather than calling the entity profit-mapped.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id'], 'properties': {'page': {'type': 'integer', 'minimum': 1, 'description': '1-based page number (default 1).'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'page_size': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'Rows per page (default 100, max 200).'}, 'name_patterns': {'type': 'array', 'items': {'type': 'string', 'maxLength': 100, 'minLength': 1}, 'maxItems': 20, 'description': 'Return accounts whose code or name contains at least one of these case-insensitive patterns.'}, 'unmapped_only': {'type': 'boolean', 'description': 'Return only accounts that still need a COST-centre policy. It does not filter on the profit dimension â\x80\x94 use profit_unmapped_only for that.'}, 'balance_bearing_only': {'type': 'boolean', 'description': 'Return only accounts that carry a balance, without returning the balance itself.'}, 'profit_unmapped_only': {'type': 'boolean', 'description': 'Return only accounts that still need a PROFIT-centre policy â\x80\x94 the rows behind profit_unmapped_total. Combine with unmapped_only to get accounts that need both.'}}, 'additionalProperties': False}
list_allocation_runs
List allocation runs
MANAGEMENT data class. Discover persisted allocation runs and their separate cost-centre and profit-centre reconciliations; do not add them together. This does not generate or recompute allocation. Money is decimal-string rupees. Choose one allocation_dimension in a detail read. Results are ordered period, version, then run id, and the signed page_token is pinned to the complete filtered source: if it reports source_changed, restart at page 1. current_only means latest generated version, not source freshness; known_stale and not_assessed are both warnings, never a claim that the source is fresh. Raw stale reasons and warning context are not returned.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id'], 'properties': {'period': {'type': 'string', 'pattern': '^\\d{4}-(0[1-9]|1[0-2])$', 'description': 'Optional management month in YYYY-MM.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'page_size': {'type': 'integer', 'maximum': 50, 'minimum': 1, 'description': 'Rows per source-pinned page (default 20, max 50).'}, 'page_token': {'type': 'string', 'maxLength': 4096, 'minLength': 1, 'description': 'Signed continuation from the prior page; restart without it if source_changed.'}, 'current_only': {'type': 'boolean', 'description': 'Return only the latest generated version per period (default true); this is not a freshness claim.'}}, 'additionalProperties': False}
list_budgets
List budgets
MANAGEMENT data class. Discover budget ids and versions without identity fields. Locked FX rate and all money-valued fields are decimal strings. Filter status or fiscal-year start before paging. The signed page_token is pinned to the complete filtered source; restart at page 1 if source_changed. This lists budget headers only, not cells, approvals identities, or a recalculated budget.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id'], 'properties': {'status': {'enum': ['draft', 'active', 'archived'], 'type': 'string', 'description': 'Optional budget status.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'page_size': {'type': 'integer', 'maximum': 50, 'minimum': 1, 'description': 'Rows per source-pinned page (default 20, max 50).'}, 'page_token': {'type': 'string', 'maxLength': 4096, 'minLength': 1, 'description': 'Signed continuation from the prior page; restart without it if source_changed.'}, 'fiscal_year_start': {'type': 'string', 'pattern': '^\\d{4}-(0[1-9]|1[0-2])-01$', 'description': 'Optional fiscal-year first-of-month date, e.g. 2026-04-01.'}}, 'additionalProperties': False}
list_chart_rebaselines
Uploads not yet counted as identity evidence
List the uploads Datavrn is NOT counting as evidence of which entity a file belongs to. This happens when an entityâs chart of accounts grew or changed faster than Datavrn can vouch for from what it already holds â typically an acquisition, a migration, or a year-end restructure. NOTHING WAS REJECTED, BLOCKED OR CHANGED: the figures in those uploads are landed and live. What has not advanced is the evidence Datavrn compares FUTURE uploads against, so wrong-entity detection for this entity is working from a smaller picture than the entityâs real chart. Each row reports how many distinctive ledger names Datavrn already held (trusted_considered), how many the upload carries (incoming_considered), how many are on both sides (matched), and the two coverage ratios. Show your user those numbers in their own terms. `shortfall` names WHICH direction fell short, and it is the part to say out loud, because the three cases are different situations to an accountant: "incoming" means most of the file is ledger names Datavrn does not already treat as evidence â the chart in the file is much larger than what Datavrn holds; "trusted" means much of what Datavrn holds is missing from the file; "both" means the two charts barely overlap either way. It is null when there was nothing to compare against at all, which the row reports as reason "empty_trust_recovery". This call only lists. To confirm one of these uploads, call preview_chart_rebaseline for that upload â it re-reads the figures and issues the approval confirm_complete_chart needs. An empty list means nothing is waiting: for almost every entity that is the normal state.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}}, 'additionalProperties': False}
list_clients
List entities
List the entities (companies) this credential can work with. Call this first to resolve the client_id every other tool needs. Returns each entity id and name.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}}
list_cost_centres
List cost centres
List the cost centres for an entity. Use this before proposing account mappings so you can group the proposal by target name and distinguish operating from support centres. This is status-only: it returns names, short codes, kinds and each centreâs parent_cost_centre_id, never rupee amounts and never an ownerâs name. Read parent_cost_centre_id (null at the top level) to show the user the hierarchy that create_cost_centre wrote, so a wrong parent can be seen and corrected. is_active false means the centre is DEACTIVATED: it is not an available target, never propose a mapping onto one, and never count it when you tell the user how many targets exist. Check the returned codes before choosing a code for create_cost_centre â a code must be unique among live centres. Tell the user what the existing structure means before suggesting a change.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id'], 'properties': {'page': {'type': 'integer', 'minimum': 1, 'description': '1-based page number (default 1).'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'page_size': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'Rows per page (default 100, max 200).'}}, 'additionalProperties': False}
list_grouping_suggestions
List grouping suggestions
List ungrouped accounts with DETERMINISTIC grouping suggestions (curated rules + name/group-path matching â no AI is involved; Datavrn never applies a suggestion itself). Paginated. Each row carries a reason and a confidence tier: present them to your user GROUPED BY CONFIDENCE, and call out low-confidence and balance-bearing rows for individual attention â a single blanket approval is not a review of the low-confidence tail. Confirm only what your user approves via confirm_groupings. Returns a summary (counts by confidence tier) plus one page of suggestion rows â fetch tier by tier with the confidence filter instead of everything at once; pass include='confirmed' to see already-confirmed groupings.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id'], 'properties': {'limit': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'Page size (default 50, max 200).'}, 'offset': {'type': 'integer', 'minimum': 0, 'description': 'Rows to skip (default 0).'}, 'include': {'enum': ['suggestions', 'confirmed', 'both'], 'type': 'string', 'description': "Which rows to page: 'suggestions' (default), 'confirmed' (already-grouped accounts), or 'both'."}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid', 'description': 'The reporting period id â\x80\x94 from list_periods.'}, 'confidence': {'enum': ['high', 'medium', 'low', 'none'], 'type': 'string', 'description': "Keep only suggestion rows in this confidence tier ('none' = accounts with no deterministic suggestion). Filters rows only â\x80\x94 the summary counts stay over the whole population."}, 'has_balance': {'type': 'boolean', 'description': 'Keep only suggestion rows whose account carries a live balance (true) or not (false).'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': "The statement template id (e.g. 'schedule3_v1' Division I; see list_snapshots/workspace)."}}, 'additionalProperties': False}
list_periods
List reporting periods
List the reporting periods a Schedule III statement can be prepared for (periods with a live Trial Balance). Returns period ids for get_schedule3_workspace, save_py_values, and generate_schedule_iii.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}}, 'additionalProperties': False}
list_profit_centres
List profit centres
List the profit centres for an entity. Use this to explain available targets before a user confirms any explicit mapping. This is status-only: it returns names and hierarchy, never rupee amounts.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id'], 'properties': {'page': {'type': 'integer', 'minimum': 1, 'description': '1-based page number (default 1).'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'page_size': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'Rows per page (default 100, max 200).'}}, 'additionalProperties': False}
list_replacements
List what automatic syncs replaced
List what a connected data sourceâs AUTOMATIC syncs have REPLACED for one entity â each one showing what was overwritten, how many records, and whether it can still be undone. Call this when a user says figures for a past period look wrong or changed on their own, and after any surprise in a period a connector covers. Datavrn keeps the replaced data for 30 days from the moment it was replaced: within that window state is "restorable" and preview_replacement_restore/restore_replacement can put it back; after it, state is "lapsed" â the record of what happened is kept and is still listed here, but it can no longer be undone from this connection, so tell the user to contact Datavrn support if they need that data recovered. "restored" means it has already been put back. Only syncs that ran UNATTENDED are listed: a replacement someone on the team previewed and confirmed themselves is not offered for undo, by design. window_closes_at is the date the undo window shuts. If connection_attributed is false, Datavrn can no longer prove which connection made that replacement â say so rather than naming this one. To find these without a connection id, call get_pending_work: it lists every still-undoable replacement across the entities you can see, with the entity and connection to use here.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'connection_id'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'connection_id': {'type': 'string', 'format': 'uuid', 'description': 'The connected data sourceâ\x80\x99s id â\x80\x94 from get_pending_workâ\x80\x99s restorable_replacements rows, or from the entityâ\x80\x99s data-sources page in the web app.'}}, 'additionalProperties': False}
list_reporting_lines
Review reporting-line mappings
Review reporting-line classification status and deterministic suggestions for an entity and reporting period. This is status-only: it returns names, line labels, confidence, reasons, and balance-bearing booleans, but never debit, credit, balance, or any rupee amount. Present suggestions grouped by confidence tier and target, with exact counts and both unmapped_total and unmapped_with_balance; do not call either count pending.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'period_id'], 'properties': {'page': {'type': 'integer', 'minimum': 1, 'description': '1-based page number (default 1).'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'page_size': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'Rows per page (default 100, max 200).'}, 'period_id': {'type': 'string', 'format': 'uuid', 'description': 'The reporting period id from list_periods.'}, 'name_patterns': {'type': 'array', 'items': {'type': 'string', 'maxLength': 100, 'minLength': 1}, 'maxItems': 20, 'description': 'Return accounts whose code or name contains at least one of these case-insensitive patterns.'}, 'unmapped_only': {'type': 'boolean', 'description': 'Return only accounts without a confirmed reporting line.'}}, 'additionalProperties': False}
list_snapshots
List statement versions
List the frozen Schedule III workbook versions for an entity (newest first), including each versionâs period, template, and unclassified count at build time.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': 'Filter to one template.'}}, 'additionalProperties': False}
list_statement_policy_choices
Review policy and affirmation choices
List every Significant Accounting Policy and Other Regulatory Information affirmation for this statement, with the text that will print, whether a template choice is still unresolved, and what was answered LAST YEAR. This is what makes two rules actionable rather than decorative: never resolve a bracketed choice for your user, and always tell them when an answer differs from last year. CHECK THE ROWâS captured FLAG BEFORE YOU CALL ANYTHING A POLICY CHANGE. differs_from_prior is true in two different situations and only one of them is a change: with captured true the wording was set this year and genuinely differs, which IS a change in accounting policy requiring disclosure under AS-5 / Ind AS 8; with captured false nothing has changed â last year was answered, this year has not been, and the text shown is Datavrnâs generic template wording, which is what will PRINT unless last yearâs wording is entered again. Warn your user about that second case explicitly: it silently replaces a policy they wrote. The summary gives you both numbers separately â changed_total (real AS-5 changes) and not_carried_forward_total (answered last year, not yet this year); differs_from_prior_total is simply the two added together. An unresolved choice blocks finalisation, so work through them with your user before generating the version you intend to finalise. "Last year" means the SAME MONTH ONE YEAR EARLIER â the same comparative period the statement itself reports â not the period immediately before this one. The summary names it: prior_period_label is the year that was compared against, and prior_period_found tells you whether Datavrn holds that year at all. A blank last-year answer means nothing was recorded for that year â when prior_period_found is false it means Datavrn has no such reporting period, so there is nothing to compare. Either way it does NOT mean last year matched this year; say which of the two it is.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id'], 'properties': {'limit': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'Page size (default 50, max 200).'}, 'offset': {'type': 'integer', 'minimum': 0, 'description': 'Rows to skip (default 0).'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid', 'description': 'The reporting period id â\x80\x94 from list_periods.'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': "The statement template id (e.g. 'schedule3_v1' Division I; see list_snapshots/workspace)."}}, 'additionalProperties': False}
preview_chart_rebaseline
Show one uploadâs figures and get the approval
Show ONE uploadâs figures as they stand right now, and get the approval confirm_complete_chart needs. Call this after list_chart_rebaselines, for the one upload your user is considering. It reports the same counts the list does â how many distinctive ledger names Datavrn already treats as evidence (trusted_considered), how many this upload adds (incoming_considered), how many are on both sides (matched), the two coverage ratios, and which direction fell short (shortfall) â re-read at this moment rather than when you listed. Read them to your user in their own terms and ask them plainly whether that upload is the entityâs whole book now. NEVER decide this from the numbers yourself â a large jump, a round number or a long gap is a reason to ASK, never a reason to conclude. Only the person who knows the clientâs books can answer it. The approval is single-use, expires in 15 minutes, and is tied to this entity, this upload, the member you name, and the exact figures returned here. If the entityâs uploads change in between â including a later clean file that resolves this on its own â the approval is spent and you start again from this call. Datavrn refuses and changes nothing if this upload is not awaiting a complete-chart confirmation: it was never held out of the evidence, someone already confirmed it, or it is one Datavrn asked about directly â for that last one, answering that question is what settles it.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'source_snapshot_id'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}, 'source_snapshot_id': {'type': 'string', 'format': 'uuid', 'description': 'The uploadâ\x80\x99s id â\x80\x94 the `snapshot_id` field of a list_chart_rebaselines row.'}}, 'additionalProperties': False}
preview_replacement_restore
Preview undoing an automatic sync
Show EXACTLY what undoing one automatic sync would do, counted at this moment, and get the approval restore_replacement needs. destroy_count is how many records undoing it would DESTROY â everything currently held for that period, whoever or whatever put it there, including data a colleague uploaded since. restore_count is how many records would be put back. READ BOTH NUMBERS TO YOUR USER IN THEIR OWN TERMS AND GET THEIR EXPLICIT GO-AHEAD BEFORE CALLING restore_replacement. Undoing a sync is itself a destructive act. If blocked_reason comes back non-null, the period is locked by a finalised statement or a sealed run: read that reason out, do not call restore_replacement, and no approval is issued. The approval is single-use, expires in 15 minutes, and is tied to this entity, this sync, this connection, the member you name AND the exact destroy_count returned here. Send that same number back as expected_destroy_count â never a number you adjusted. If the periodâs data changes in between, the approval is spent and you start again from here.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'connection_id', 'event_id'], 'properties': {'event_id': {'type': 'string', 'format': 'uuid', 'description': 'The replacementâ\x80\x99s id â\x80\x94 the `id` field of a list_replacements row.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}, 'connection_id': {'type': 'string', 'format': 'uuid', 'description': 'The connected data sourceâ\x80\x99s id â\x80\x94 from list_replacements or get_pending_work.'}}, 'additionalProperties': False}
restore_replacement
Undo an automatic sync
Undo one automatic sync: destroy what is currently held for that period and put back the records the sync replaced, recorded as authorised by the member you name. THIS DESTROYS DATA. Everything currently held in that period goes â including anything uploaded or synced since â and is replaced by what was there before. Datavrn keeps a record of what this destroys, but it is NOT offered back on this surface; recovering from an undo is a support operation. Call preview_replacement_restore first, read both of its numbers to your user, get their explicit go-ahead, and send back the confirm_token it gave you with the EXACT destroy_count it returned as expected_destroy_count. Datavrn refuses and changes nothing if: the periodâs data moved after you were shown those numbers, the period is locked by a finalised statement or a sealed run, someone already undid this sync, the 30-day window has closed, or the replacement was one a person previewed and confirmed themselves. On success it reports how many records were destroyed, how many were put back, and â under soft_reference_relink â how many links to the restored documents could not be re-established; tell your user that residual number rather than presenting the undo as complete.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'connection_id', 'event_id', 'expected_destroy_count', 'confirm_token'], 'properties': {'event_id': {'type': 'string', 'format': 'uuid', 'description': 'The replacementâ\x80\x99s id â\x80\x94 the same one you previewed.'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}, 'confirm_token': {'type': 'string', 'maxLength': 200, 'minLength': 20, 'description': 'The approval from preview_replacement_restore. Call it first and present both of its numbers to your user.'}, 'connection_id': {'type': 'string', 'format': 'uuid', 'description': 'The connected data sourceâ\x80\x99s id â\x80\x94 the same one you previewed with.'}, 'expected_destroy_count': {'type': 'integer', 'minimum': 0, 'description': 'The destroy_count preview_replacement_restore returned and you showed your user. Send it back unchanged â\x80\x94 a different number is refused, because the approval covers the act your user actually saw.'}}, 'additionalProperties': False}
revoke_capture_declaration
Withdraw a recorded capture answer
Withdraw a recorded capture answer or review confirmation. What happens next depends on what answers the section: withdrawing a ânothing to recordâ/âdoes not applyâ answer or a review confirmation makes Statement readiness show the section as UNANSWERED again; withdrawing a leftover earlier note from a section that is answered by its saved rows removes the record and the section STAYS answered. A version you have already generated is NOT affected â if you do not want that version finalised, answer the section again and generate a fresh version. Nothing is deleted: the withdrawn answer stays on the record with who recorded it and who withdrew it, and recording a new answer afterwards creates a new entry rather than overwriting the old one. One thing on this connection is affected immediately: if you already called get_finalise_readiness and hold an approval for that version, withdrawing an answer invalidates it, and the next finalise_statement will refuse and ask you to review the current state again.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id', 'capture_kind'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'capture_kind': {'enum': ['adjustments', 'prior_year_values', 'asset_movements', 'provision_movements', 'reserves_movements', 'share_capital', 'partner_capital', 'settings', 'disclosures'], 'type': 'string'}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}}, 'additionalProperties': False}
save_accounting_policies
Save significant accounting policies
Save the Significant Accounting Policies text (Note 2) your user has chosen, one policy per title. SEND THE COMPLETE SET EVERY TIME: this replaces all of Note 2, so any title you leave out of this call is removed â including one someone answered in the Datavrn app. Call list_statement_policy_choices first and send back every title. If your call would drop a saved policy, Datavrn saves nothing and returns an approval request naming how many would be dropped â show your user, and send the approval back only if they mean to drop them. A complete resend drops nothing and saves straight away. Use the exact policy headings this statement format carries; a heading Datavrn does not recognise is refused and nothing is saved. Resolving a bracketed template choice such as "[FIFO / weighted average]" is an ACCOUNTING POLICY DECISION SPECIFIC TO THIS ENTITY: get your userâs explicit choice, and never pick one because it is the common answer. If a policy was set this year and differs from last yearâs answer, that is a CHANGE IN ACCOUNTING POLICY requiring disclosure under AS-5 / Ind AS 8 â tell your user before you save it. Check list_statement_policy_choices first: a row that differs from last year while its captured flag is false is NOT a change â last yearâs wording has simply not been carried forward, and unless you send it again this note prints Datavrnâs generic template wording in its place. Saving here re-opens the disclosure review â after your last change, confirm the disclosure review again with confirm_capture_review before generating. Recorded as authorised by the member you name. Generate a fresh version after your last capture change â finalisation checks the versionâs frozen capture state, not todayâs.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id'], 'properties': {'policies': {'type': 'object', 'default': {}, 'propertyNames': {'maxLength': 200, 'minLength': 1}, 'additionalProperties': {'type': 'string', 'maxLength': 10000}}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}, 'removal_count': {'type': 'integer', 'maximum': 2000, 'minimum': 1}, 'removal_token': {'type': 'string', 'maxLength': 200, 'minLength': 20}}, 'additionalProperties': False}
save_adjustments
Save adjustment entry
Save one balanced adjustment journal entry (debits = credits) as an atomic whole entry. Creating a new entry proceeds immediately. Replacing an existing entry first returns an approval request; nothing changes then. Review the existing entry in the Schedule III workspace, then resend the unchanged request with the approval details to proceed. Amounts are strings in rupees.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id', 'entry_no', 'lines'], 'properties': {'lines': {'type': 'array', 'items': {'type': 'object', 'required': ['leaf_code', 'narration', 'debit', 'credit'], 'properties': {'debit': {'type': 'string', 'pattern': '^\\d{1,16}(\\.\\d{1,2})?$'}, 'credit': {'$ref': '#/properties/lines/items/properties/debit'}, 'leaf_code': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'narration': {'type': 'string', 'maxLength': 400, 'minLength': 1}}, 'additionalProperties': False}, 'maxItems': 200, 'minItems': 2}, 'entry_no': {'type': 'integer', 'maximum': 9999, 'minimum': 1}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'removal_count': {'type': 'integer', 'maximum': 2000, 'minimum': 1}, 'removal_token': {'type': 'string', 'maxLength': 200, 'minLength': 20}}, 'additionalProperties': False}
save_asset_movements
Save asset movements
Save fixed-asset movements (additions, deletions, depreciation charge, depreciation on deletions) per gross-block line for the PPE schedule.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id', 'movements'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'movements': {'type': 'array', 'items': {'type': 'object', 'required': ['gross_leaf_code', 'additions', 'deletions_gross', 'dep_charge', 'dep_on_deletions'], 'properties': {'additions': {'type': 'string', 'pattern': '^\\d{1,16}(\\.\\d{1,2})?$'}, 'dep_charge': {'$ref': '#/properties/movements/items/properties/additions'}, 'deletions_gross': {'$ref': '#/properties/movements/items/properties/additions'}, 'gross_leaf_code': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'dep_on_deletions': {'$ref': '#/properties/movements/items/properties/additions'}}, 'additionalProperties': False}, 'maxItems': 500, 'minItems': 1}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}}, 'additionalProperties': False}
save_disclosures
Save disclosures
Save the notes/disclosures sections the user provides for the statement. Some of these sections IDENTIFY PEOPLE BY NAME â shareholders, promoters and related parties â so send only what your user has given you, exactly as they gave it. SECTIONS YOU DO NOT SEND ARE LEFT ALONE. Send only the sections you are changing; every other section keeps exactly what is saved. Within a section you DO send, the rows you send REPLACE every row saved for that section â there is no row-level merge, so always send that section complete. To CLEAR a section, send it explicitly with its own empty value: [] for corporateInfo, contingent, shareholders5pct, promoters, relatedParties and msmeAmounts; {} for ratioReasons; null for auditorPayments, csr, proposedDividend and the DSCR amounts. The three ageing sections take [] or null. Clearing removes saved content, so Datavrn saves nothing and returns an approval request naming the sections and how many rows each holds. Show your user exactly what would be cleared; only if they mean to, resend the identical call adding removal_token and removal_count from that response. The approval is single-use and lapses after five minutes â if it lapses, call again for a fresh one. Saving here re-opens the disclosure review â after your last change, confirm the disclosure review again with confirm_capture_review before generating. ratioReasons is keyed by the ratio IDENTIFIER, never its display label: current_ratio | debt_equity | dscr | roe | inv_turnover | tr_turnover | tp_turnover | ncap_turnover | net_profit | roce | roi. msmeAmounts is a POSITIONAL list of exactly five items, in this statutory order: 1. Principal amount and interest due thereon remaining unpaid at the year end (shown separately) | 2. Interest paid under section 16 of the MSMED Act, with the payment made beyond the appointed day | 3. Interest due and payable for delay in payment (paid beyond the appointed day), excluding MSMED-specified interest | 4. Interest accrued and remaining unpaid at the year end | 5. Further interest remaining due and payable in succeeding years (section 23 disallowance) â send all five, using {"currentPaise": null, "previousPaise": null} for an item with nothing to report. Dashes and capitalisation are forgiven when matching a row label (a hyphen for an en dash is fine) and Datavrn stores the prescribed spelling; the wording itself is not forgiven. PRESCRIBED ROWS BY STATEMENT FORMAT â a row label or sub-head that is not one of these is refused rather than stored (a value already saved on this statement stays editable): Division I (Non-Ind AS) ("schedule_iii_div1") â trAgeing: 6 buckets in this order [Not due | < 6 months | 6 months â 1 year | 1 â 2 years | 2 â 3 years | > 3 years], rows [Undisputed â considered good | Undisputed â considered doubtful | Disputed â considered good | Disputed â considered doubtful | Unbilled dues]; tpAgeing: 5 buckets in this order [Not due | < 1 year | 1 â 2 years | 2 â 3 years | > 3 years], rows [MSME | Others | Disputed dues â MSME | Disputed dues â Others | Unbilled dues]; cwipAgeing: 4 buckets in this order [< 1 year | 1 â 2 years | 2 â 3 years | > 3 years], rows [Projects in progress | Projects temporarily suspended]. contingent.subhead â contingent liabilities [Claims against the company not acknowledged as debt | Guarantees | Other money for which the company is contingently liable] or commitments [Estimated amount of contracts remaining to be executed on capital account (net of advances) | Uncalled liability on shares and other investments partly paid | Other commitments] â set group to "contingent" or "commitment" to match, or the row is totalled under contingent liabilities (or leave subhead out and the row prints as its own line under its group). Division II (Ind AS) ("schedule_iii_div2") â trAgeing: 6 buckets in this order [Not due | < 6 months | 6 months â 1 year | 1 â 2 years | 2 â 3 years | > 3 years], rows [Undisputed â considered good | Undisputed â significant increase in credit risk | Undisputed â credit impaired | Disputed â considered good | Disputed â significant increase in credit risk | Disputed â credit impaired | Unbilled dues]; tpAgeing: 5 buckets in this order [Not due | < 1 year | 1 â 2 years | 2 â 3 years | > 3 years], rows [MSME | Others | Disputed dues â MSME | Disputed dues â Others | Unbilled dues]; cwipAgeing: 4 buckets in this order [< 1 year | 1 â 2 years | 2 â 3 years | > 3 years], rows [Projects in progress | Projects temporarily suspended]. contingent.subhead â contingent liabilities [Claims against the company not acknowledged as debt | Guarantees excluding financial guarantees | Other money for which the company is contingently liable] or commitments [Estimated amount of contracts remaining to be executed on capital account (net of advances) | Uncalled liability on shares and other investments partly paid | Other commitments] â set group to "contingent" or "commitment" to match, or the row is totalled under contingent liabilities (or leave subhead out and the row prints as its own line under its group). Non-Corporate Entity ("icai_nce") and LLP ("icai_llp") â no ageing tables at all â trAgeing/tpAgeing/cwipAgeing are refused. contingent.subhead â contingent liabilities [Claims against the entity not acknowledged as debt | Guarantees given on behalf of others | Other money for which the entity is contingently liable] or commitments [Estimated amount of contracts remaining to be executed on capital account (net of advances) | Uncalled liability on investments partly paid | Other commitments] â set group to "contingent" or "commitment" to match, or the row is totalled under contingent liabilities (or leave subhead out and the row prints as its own line under its group).
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id', 'payload'], 'properties': {'payload': {'type': 'object', 'properties': {'csr': {'anyOf': [{'type': 'object', 'required': ['requiredPaise', 'spentPaise'], 'properties': {'nature': {'anyOf': [{'type': 'string', 'maxLength': 1000}, {'type': 'null'}]}, 'reason': {'anyOf': [{'type': 'string', 'maxLength': 1000}, {'type': 'null'}]}, 'spentPaise': {'anyOf': [{'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, {'type': 'null'}]}, 'requiredPaise': {'anyOf': [{'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, {'type': 'null'}]}, 'spentPreviousPaise': {'anyOf': [{'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, {'type': 'null'}]}, 'requiredPreviousPaise': {'anyOf': [{'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'tpAgeing': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items'}, 'maxItems': 50}, {'type': 'null'}], 'default': None}, 'trAgeing': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'required': ['label', 'bucketsPaise'], 'properties': {'label': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'py_buckets': {'type': 'array', 'items': {'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, 'maxItems': 10, 'minItems': 1}, 'bucketsPaise': {'type': 'array', 'items': {'type': 'string', 'pattern': '^-?\\d{1,18}$'}, 'maxItems': 10, 'minItems': 1}}, 'additionalProperties': False}, 'maxItems': 50}, {'type': 'null'}], 'default': None}, 'promoters': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'shares', 'pctTotal', 'pctChange'], 'properties': {'name': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'shares': {'$ref': '#/properties/payload/properties/shareholders5pct/items/properties/shares'}, 'pctTotal': {'type': 'string', 'maxLength': 20, 'minLength': 1}, 'pctChange': {'type': 'string', 'maxLength': 20, 'minLength': 1}}, 'additionalProperties': False}, 'default': [], 'maxItems': 100}, 'contingent': {'type': 'array', 'items': {'type': 'object', 'required': ['label', 'currentPaise', 'previousPaise'], 'properties': {'group': {'enum': ['contingent', 'commitment'], 'type': 'string'}, 'label': {'type': 'string', 'maxLength': 400, 'minLength': 1}, 'subhead': {'type': 'string', 'maxLength': 400}, 'currentPaise': {'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, 'previousPaise': {'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}}, 'additionalProperties': False}, 'default': [], 'maxItems': 100}, 'cwipAgeing': {'anyOf': [{'type': 'array', 'items': {'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items'}, 'maxItems': 20}, {'type': 'null'}]}, 'msmeAmounts': {'type': 'array', 'items': {'type': 'object', 'required': ['currentPaise', 'previousPaise'], 'properties': {'currentPaise': {'anyOf': [{'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, {'type': 'null'}]}, 'previousPaise': {'anyOf': [{'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, {'type': 'null'}]}}, 'additionalProperties': False}, 'maxItems': 10}, 'ratioReasons': {'type': 'object', 'default': {}, 'propertyNames': {'maxLength': 80}, 'additionalProperties': {'type': 'string', 'maxLength': 1000}}, 'corporateInfo': {'type': 'array', 'items': {'type': 'string', 'maxLength': 1000}, 'default': [], 'maxItems': 50}, 'relatedParties': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'relationship'], 'properties': {'name': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'relationship': {'type': 'string', 'maxLength': 200, 'minLength': 1}}, 'additionalProperties': False}, 'maxItems': 200}, 'auditorPayments': {'anyOf': [{'type': 'object', 'required': ['asAuditorPaise', 'taxationMattersPaise', 'companyLawMattersPaise', 'managementServicesPaise', 'otherServicesPaise', 'reimbursementPaise'], 'properties': {'asAuditorPaise': {'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, 'otherServicesPaise': {'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, 'reimbursementPaise': {'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, 'taxationMattersPaise': {'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, 'companyLawMattersPaise': {'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, 'managementServicesPaise': {'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}}, 'additionalProperties': False}, {'type': 'null'}], 'default': None}, 'proposedDividend': {'anyOf': [{'type': 'string', 'maxLength': 1000}, {'type': 'null'}], 'default': None}, 'shareholders5pct': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'shares', 'pct'], 'properties': {'pct': {'type': 'string', 'maxLength': 20, 'minLength': 1}, 'name': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'shares': {'type': 'string', 'pattern': '^\\d{1,18}$'}}, 'additionalProperties': False}, 'default': [], 'maxItems': 100}, 'dscrPrincipalRepaidCurrentPaise': {'anyOf': [{'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, {'type': 'null'}], 'default': None}, 'dscrPrincipalRepaidPreviousPaise': {'anyOf': [{'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, {'type': 'null'}], 'default': None}, 'dscrLeasePrincipalRepaidCurrentPaise': {'anyOf': [{'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, {'type': 'null'}]}, 'dscrLeasePrincipalRepaidPreviousPaise': {'anyOf': [{'$ref': '#/properties/payload/properties/trAgeing/anyOf/0/items/properties/bucketsPaise/items'}, {'type': 'null'}]}}, 'additionalProperties': False}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'removal_count': {'type': 'integer', 'maximum': 2000, 'minimum': 1}, 'removal_token': {'type': 'string', 'maxLength': 200, 'minLength': 20}}, 'additionalProperties': False}
save_partner_capital
Save partner or owner capital schedule
Save the partner or owner capital schedule for an LLP or other non-corporate entity â Note 3a (capital account) or Note 3b (current account), one section per call. Send the COMPLETE schedule for the section you name: anyone you leave out is removed, and a renamed partner reads as one removal plus one addition. If your request would remove anyone, would change the figures of a partner who stays â including their profit-sharing ratio â or would repeat a personâs name that is not already repeated on file, this returns an approval request first and changes NOTHING; tell your user exactly what would change and get their go-ahead before resending with the approval. Two rows with the same person name are both kept: Datavrn never merges them, because two partners may genuinely share a name. A repeated name is therefore saved as a separate row each time it appears, and every one of those rows adds to that personâs balance on the note, so check with your user that there really are that many people before you send a schedule that repeats a name. Adding a partner with a new, different name needs no approval. share_pct is the profit-sharing ratio stated in the LLP or partnership agreement at the reporting date. A ratio that changed part-way through the year cannot be represented here, and a partner who joined or left mid-year cannot be dated â record the position at the reporting date and tell your user the note cannot explain a mid-year change. These figures come from the agreement; Datavrn does not verify them. Datavrn warns about ratios that do not total 100% only when at least TWO capital-account rows carry a ratio, so a partly-filled schedule gets no warning at all â check the total yourself with get_partner_capital. This is your userâs data about named people, recorded as authorised by them. After a successful save, read the section back with get_partner_capital and show your user the new closing balances â this replaces the whole section, and a schedule they cannot see afterwards is a schedule they cannot check. Generate a fresh version after your last capture change â finalisation checks the versionâs frozen capture state, not todayâs.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id', 'account_kind', 'rows'], 'properties': {'rows': {'type': 'array', 'items': {'type': 'object', 'required': ['person_name'], 'properties': {'opening': {'type': 'string', 'default': '0', 'pattern': '^-?\\d{1,16}(\\.\\d{1,2})?$'}, 'interest': {'$ref': '#/properties/rows/items/properties/agreed_contribution/anyOf/0', 'default': '0'}, 'share_pct': {'anyOf': [{'type': 'string', 'pattern': '^\\d{1,3}(\\.\\d{1,4})?$'}, {'type': 'null'}], 'default': None}, 'introduced': {'$ref': '#/properties/rows/items/properties/agreed_contribution/anyOf/0', 'default': '0'}, 'person_name': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'share_of_pl': {'$ref': '#/properties/rows/items/properties/opening', 'default': '0'}, 'withdrawals': {'$ref': '#/properties/rows/items/properties/agreed_contribution/anyOf/0', 'default': '0'}, 'remuneration': {'$ref': '#/properties/rows/items/properties/agreed_contribution/anyOf/0', 'default': '0'}, 'agreed_contribution': {'anyOf': [{'type': 'string', 'pattern': '^\\d{1,16}(\\.\\d{1,2})?$'}, {'type': 'null'}], 'default': None}}, 'additionalProperties': False}, 'maxItems': 200}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'account_kind': {'enum': ['capital', 'current'], 'type': 'string'}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}, 'removal_count': {'type': 'integer', 'maximum': 2000, 'minimum': 1}, 'removal_token': {'type': 'string', 'maxLength': 200, 'minLength': 20}}, 'additionalProperties': False}
save_provision_movements
Save provision movements
Upsert provision movements (additions, amounts utilised) per provision line. Omitted saved lines stay unchanged. To remove selected saved lines, pass remove_leaf_codes; to remove the entire saved set, pass clear_all (never both). An actual removal first returns an approval request; nothing changes then. Review current movements in the Schedule III workspace, then resend the unchanged request with the approval details to proceed.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id', 'movements'], 'properties': {'clear_all': {'type': 'boolean'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'movements': {'type': 'array', 'items': {'type': 'object', 'required': ['leaf_code', 'additions', 'utilised'], 'properties': {'utilised': {'$ref': '#/properties/movements/items/properties/additions'}, 'additions': {'type': 'string', 'pattern': '^\\d{1,16}(\\.\\d{1,2})?$'}, 'leaf_code': {'type': 'string', 'maxLength': 80, 'minLength': 1}}, 'additionalProperties': False}, 'maxItems': 500}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'removal_count': {'type': 'integer', 'maximum': 2000, 'minimum': 1}, 'removal_token': {'type': 'string', 'maxLength': 200, 'minLength': 20}, 'remove_leaf_codes': {'type': 'array', 'items': {'$ref': '#/properties/movements/items/properties/leaf_code'}, 'maxItems': 500}}, 'additionalProperties': False}
save_py_values
Save prior-year comparatives
Override the prior-year comparative for one or more statement lines with an audited figure. The prior-year column fills itself automatically from the previous year's Trial Balance read through the current groupings, so use this only when the audited financial statements differ from that figure (for example appropriations booked outside the ledger), or when there is no previous-year Trial Balance to derive from â ask your user for the audited figures in those cases.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id', 'values'], 'properties': {'values': {'type': 'array', 'items': {'type': 'object', 'required': ['leaf_code', 'amount'], 'properties': {'amount': {'type': 'string', 'pattern': '^-?\\d{1,16}(\\.\\d{1,2})?$'}, 'leaf_code': {'type': 'string', 'maxLength': 80, 'minLength': 1}}, 'additionalProperties': False}, 'maxItems': 2000, 'minItems': 1}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}}, 'additionalProperties': False}
save_regulatory_affirmations
Save regulatory affirmations
Save the CARO / Other Regulatory Information affirmations your user has confirmed, one per title. SEND THE COMPLETE SET EVERY TIME: this replaces the whole Other Regulatory Information note, so any title you leave out of this call is removed â including one someone answered in the Datavrn app. Call list_statement_policy_choices first and send back every title. If your call would drop a saved affirmation, Datavrn saves nothing and returns an approval request naming how many would be dropped â show your user, and send the approval back only if they mean to drop them. A complete resend drops nothing and saves straight away. Use the exact affirmation headings this statement format carries; a heading Datavrn does not recognise is refused and nothing is saved. Some statement formats â the ICAI formats for LLPs and non-corporate entities â carry no Other Regulatory Information note at all, and this tool refuses for them. Each affirmation is a REGULATORY REPRESENTATION made in the entityâs name â for example whether any proceedings for benami property are pending, or whether the entity has been declared a wilful defaulter. Put each one to your user individually and record their answer. Never affirm one because it is the usual answer, never infer one from a template default, and never confirm a batch of them in one go. If an affirmation differs from last yearâs answer, tell your user â call list_statement_policy_choices to see what was answered last year. Saving here re-opens the disclosure review â after your last change, confirm the disclosure review again with confirm_capture_review before generating. Recorded as authorised by the member you name. Generate a fresh version after your last capture change â finalisation checks the versionâs frozen capture state, not todayâs.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'affirmations': {'type': 'object', 'default': {}, 'propertyNames': {'maxLength': 400, 'minLength': 1}, 'additionalProperties': {'type': 'string', 'maxLength': 4000}}, 'on_behalf_of': {'type': 'string', 'format': 'email', 'maxLength': 320, 'description': 'The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection â\x80\x94 ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member.'}, 'removal_count': {'type': 'integer', 'maximum': 2000, 'minimum': 1}, 'removal_token': {'type': 'string', 'maxLength': 200, 'minLength': 20}}, 'additionalProperties': False}
save_reserves_movements
Save reserves movements
Upsert reserves/equity movements (transfers in/out, dividends, other changes) per reserves line. Omitted saved lines stay unchanged. To remove selected saved lines, pass remove_leaf_codes; to remove the entire saved set, pass clear_all (never both). An actual removal first returns an approval request; nothing changes then. Review current movements in the Schedule III workspace, then resend the unchanged request with the approval details to proceed.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id', 'movements'], 'properties': {'clear_all': {'type': 'boolean'}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'movements': {'type': 'array', 'items': {'type': 'object', 'required': ['leaf_code', 'transfers_in', 'transfers_out', 'dividends'], 'properties': {'dividends': {'$ref': '#/properties/movements/items/properties/transfers_in'}, 'leaf_code': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'transfers_in': {'type': 'string', 'pattern': '^\\d{1,16}(\\.\\d{1,2})?$'}, 'other_changes': {'anyOf': [{'type': 'string', 'pattern': '^-?\\d{1,16}(\\.\\d{1,2})?$'}, {'type': 'null'}]}, 'transfers_out': {'$ref': '#/properties/movements/items/properties/transfers_in'}}, 'additionalProperties': False}, 'maxItems': 500}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'removal_count': {'type': 'integer', 'maximum': 2000, 'minimum': 1}, 'removal_token': {'type': 'string', 'maxLength': 200, 'minLength': 20}, 'remove_leaf_codes': {'type': 'array', 'items': {'$ref': '#/properties/movements/items/properties/leaf_code'}, 'maxItems': 500}}, 'additionalProperties': False}
save_share_capital
Save share capital
Save the share-capital reconciliation for the period: the opening share count, the shares issued and bought back during the year, and the amount issued and the amount bought back.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id', 'opening_shares', 'shares_issued', 'shares_bought_back', 'amount_issued', 'amount_bought_back'], 'properties': {'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'amount_issued': {'type': 'string', 'pattern': '^\\d{1,16}(\\.\\d{1,2})?$'}, 'shares_issued': {'anyOf': [{'$ref': '#/properties/opening_shares/anyOf/0'}, {'type': 'null'}]}, 'opening_shares': {'anyOf': [{'type': 'string', 'pattern': '^\\d{1,18}$'}, {'type': 'null'}]}, 'amount_bought_back': {'$ref': '#/properties/amount_issued'}, 'shares_bought_back': {'anyOf': [{'$ref': '#/properties/opening_shares/anyOf/0'}, {'type': 'null'}]}}, 'additionalProperties': False}
save_statement_settings
Save statement settings
Save statement settings (rounding unit, signatory details, company information used on the statement face).
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'template_id', 'period_id', 'entity_name_override', 'cin', 'registered_office', 'unit_label', 'unit_divisor', 'weighted_equity_shares', 'weighted_potential_equity_shares', 'weighted_equity_shares_py', 'weighted_potential_equity_shares_py', 'equity_face_value'], 'properties': {'cin': {'anyOf': [{'type': 'string', 'maxLength': 40, 'minLength': 1}, {'type': 'null'}]}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'font_name': {'enum': ['Calibri', 'Arial', 'Times New Roman'], 'type': 'string', 'default': 'Calibri'}, 'period_id': {'type': 'string', 'format': 'uuid'}, 'unit_label': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'include_cfs': {'type': ['boolean', 'null'], 'default': None}, 'template_id': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'entity_class': {'anyOf': [{'type': 'string', 'maxLength': 40, 'minLength': 1}, {'type': 'null'}], 'default': None}, 'rounding_off': {'type': 'boolean', 'description': 'Whole-unit value rounding. When true (the default), every figure is rounded to the presentation unit and each CA-read total (profit, total assets, equity and liabilities) equals the rounded exact figure. A computed "Rounding off" line under Other expenses is only the profit adjustment; remaining Balance-Sheet rounding is disclosed under reserves / other current assets. false renders exact two-decimal figures.'}, 'unit_divisor': {'enum': [1, 1000, 100000, 10000000], 'type': 'number'}, 'equity_face_value': {'anyOf': [{'type': 'string', 'pattern': '^\\d{1,16}(\\.\\d{1,2})?$'}, {'type': 'null'}]}, 'registered_office': {'anyOf': [{'type': 'string', 'maxLength': 400, 'minLength': 1}, {'type': 'null'}]}, 'suppress_nil_lines': {'type': 'boolean', 'default': False}, 'entity_name_override': {'anyOf': [{'type': 'string', 'maxLength': 200, 'minLength': 1}, {'type': 'null'}]}, 'weighted_equity_shares': {'anyOf': [{'type': 'string', 'pattern': '^\\d{1,18}$'}, {'type': 'null'}]}, 'weighted_equity_shares_py': {'anyOf': [{'$ref': '#/properties/weighted_equity_shares/anyOf/0'}, {'type': 'null'}]}, 'weighted_potential_equity_shares': {'anyOf': [{'$ref': '#/properties/weighted_equity_shares/anyOf/0'}, {'type': 'null'}], 'description': 'Weighted average potential equity shares (dilutive â\x80\x94 options, convertibles). ADDITIONAL shares from options/convertibles only â\x80\x94 not the total diluted share count. Enter 0 if the company has none. Do not repeat the basic share count.'}, 'weighted_potential_equity_shares_py': {'anyOf': [{'$ref': '#/properties/weighted_equity_shares/anyOf/0'}, {'type': 'null'}], 'description': 'Weighted average potential equity shares â\x80\x94 previous year (dilutive). ADDITIONAL shares from options/convertibles only â\x80\x94 not the total diluted share count. Enter 0 if the company has none. Do not repeat the basic share count.'}}, 'additionalProperties': False}
set_header_row
Set header row
Correct the detected header row of a staged upload (1-based). Only needed when get_upload/upload_trial_balance shows the wrong row was detected.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['upload_id', 'header_row'], 'properties': {'upload_id': {'type': 'string', 'format': 'uuid', 'description': 'The upload session id returned by upload_trial_balance.'}, 'header_row': {'type': 'integer', 'maximum': 10000, 'exclusiveMinimum': 0}}, 'additionalProperties': False}
upload_trial_balance
Upload trial balance
Stage a Trial Balance spreadsheet (xlsx or csv, max 4 MB) for an entity by INLINING its bytes as base64. This path is ONLY for programmatic callers (a script, Claude Code, an automation) that already have the raw file on disk. If a HUMAN has the file â e.g. they attached it to this chat â do NOT use this tool and do NOT base64-encode the file: call create_upload_link instead and give them the link to upload it in their browser. File size does not change this: even a small attached file goes through create_upload_link â inlining a human-supplied file is unreliable and its bytes routinely truncate. Even for a file you hold on disk, prefer create_upload_link once the file is larger than about 10 KB: base64 through a model context mutates a token often enough that the damage lands as a PLAUSIBLE trial balance, not as an obvious error. VERIFY THE HASH BEFORE YOU CONFIRM ANYTHING: this tool returns received_file_hash, the sha256 of the bytes the server actually received. Compute the sha256 of the file on your disk and compare the two. If they differ, the bytes changed in transit â do NOT call confirm_column_mapping on this session; re-send the file with create_upload_link instead. A mismatched file can still parse cleanly and still show sensible columns, so the hash is the only reliable check. Returns the upload session with detected columns and mapping SUGGESTIONS â nothing is ingested yet. Next: verify received_file_hash, then review the suggested column mapping with your user, then call confirm_column_mapping.
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client_id', 'file_name', 'file_base64'], 'properties': {'format': {'type': 'string', 'description': 'Leave unset â\x80\x94 the assistant handles Trial Balances only; any other format is refused (use the Datavrn web app).'}, 'source': {'type': 'string', 'description': "Set 'tally_file' when the file is a Tally xlsx export; omit otherwise."}, 'client_id': {'type': 'string', 'format': 'uuid', 'description': 'The entity (client) id â\x80\x94 from list_clients.'}, 'file_name': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': "The file's name, e.g. 'tb-2026-03.xlsx'."}, 'file_base64': {'type': 'string', 'minLength': 1, 'description': 'The file bytes, base64-encoded.'}}, 'additionalProperties': False}
verify_connection
Verify connection
Confirm the Datavrn connection is working and report what it can do. Call this first â or whenever the user asks whether Datavrn is connected â to get back the organization, the access profile (what this connection may see and do), and the next step. Running it successfully also marks the connection healthy in the userâs Datavrn settings.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}}
Historial
Cambios recientes en herramientas
Modificado
save_statement_settings
23 de September de 2026 a las 02:53
Modificado
save_statement_settings
21 de September de 2026 a las 02:59
Añadido
get_help
17 de September de 2026 a las 12:34
Añadido
verify_connection
17 de September de 2026 a las 12:34
Añadido
confirm_complete_chart
17 de September de 2026 a las 12:34
Añadido
preview_chart_rebaseline
17 de September de 2026 a las 12:34
Añadido
list_chart_rebaselines
17 de September de 2026 a las 12:34
Añadido
restore_replacement
17 de September de 2026 a las 12:34
Añadido
preview_replacement_restore
17 de September de 2026 a las 12:34
Añadido
list_replacements
17 de September de 2026 a las 12:34
Añadido
get_setup_status
17 de September de 2026 a las 12:34
Añadido
confirm_reporting_lines
17 de September de 2026 a las 12:34
Añadido
list_reporting_lines
17 de September de 2026 a las 12:34
Añadido
confirm_centre_mappings
17 de September de 2026 a las 12:34
Añadido
list_account_mappings
17 de September de 2026 a las 12:34
Añadido
create_profit_centre
17 de September de 2026 a las 12:34
Añadido
list_profit_centres
17 de September de 2026 a las 12:34
Añadido
create_cost_centre
17 de September de 2026 a las 12:34
Añadido
list_cost_centres
17 de September de 2026 a las 12:34
Añadido
get_consolidated_statements
17 de September de 2026 a las 12:34
Añadido
get_variance_report
17 de September de 2026 a las 12:34
Añadido
get_budget
17 de September de 2026 a las 12:34
Añadido
list_budgets
17 de September de 2026 a las 12:34
Añadido
get_spreading_reconciliation
17 de September de 2026 a las 12:34
Añadido
get_allocation_target_figures
17 de September de 2026 a las 12:34
Añadido
get_allocation_account_figures
17 de September de 2026 a las 12:34
Añadido
list_allocation_runs
17 de September de 2026 a las 12:34
Añadido
get_pending_work
17 de September de 2026 a las 12:34
Añadido
get_tb_rows
17 de September de 2026 a las 12:34
Añadido
get_statement_notes
17 de September de 2026 a las 12:34
Descubrir
Servidores MCP similares
FalaZuki Finance BR
com.falazuki/finance-br
Provides Brazil-focused financial calculations and rules for investments, credit, taxes, payroll, labor costs, debt, budgeting, a…
XBOSS
kr.xdata/xdata-mcp
Accesses Korean tax, social insurance, payroll, cash receipt, e-tax invoice, and certificate filing services.
Sirenic
eu.sirenic/sirenic
Provides European company registry, financial, procurement, sanctions, regulatory, insolvency, ownership, and ongoing due-diligen…
Xearno Tools
tools.xearno/calculators
Provides financial, tax, employment-benefit, lending, pricing, and business calculators using jurisdiction-specific rules and cur…
HelpMyAgent
io.github.helpmyagent/helpmyagent
Provides French company intelligence including profiles, financials, directors, procurement, public funding, KYB, compliance chec…
Cobalt
io.github.pipeworx-io/cobalt
Searches U.S. business registrations, verifies business tax identifiers, and retrieves UCC lien filings for company due diligence…
Imperio — Italian Tax & Compliance Tools
com.imperioutils/fisco-it
Provides deterministic Italian tax, invoicing, identity, payment-detail validation, anti-fraud, INTRASTAT, NIS2, and compliance c…
AdvBox
io.github.mcp-dir/advbox-mcp
Manages legal practice customers, lawsuits, movements, publications, notes, settings, and related financial transactions.