iPify

Stages cases as a reusable import that simulator_run and simulator_requirements read through the import_reference it returns. Use it for a file of cases, with csv_text for a small one or without csv_text to receive a single-use upload URL for a large one, whose upload response carries the import_reference; or with planned_filings for a filing plan whose cases do not exist yet. A blank date cell is unknown; state a date that has not happened yet through known_absent in a run override. The import stays usable until expires_at while its pricing_data_version is current.

simulator_import_cases

Renders a completed run as the interactive iPify simulation component and returns a compact summary. Use it after simulator_run completes, to show the user the result. For one case with one work it shows the official deadline, the ordinary, grace and other legal periods on a timeline, and the cost at the work's pricing date; for several works or cases it shows totals, cost charts and each case's works, deadlines and fees, which the user can inspect. The component covers most reporting needs; for a tailored analysis or report, read the results through simulator_query. On hosts without Apps support the compact summary still returns.

simulator_present

Reads a run's retained results and your selections: progress, summary, cases, works with their deadlines and fees and, on detail=full, their legal periods, assumptions, open parameters, grouped totals, and a comparison of two runs; also lists earlier runs, staged imports, pricing profiles, white-label end customers, and the entity's onboarded cases. Use it when the user wants figures or details beyond the presented component, an earlier run or import, or a profile, end customer or onboarded case reference to run with. Official fees are stated in the office's currency and quoted prices in the invoicing currency; a run with a report currency also states converted totals. Row views return bounded pages behind a cursor. view=comparison needs two runs over the same cases and settings; compare other runs by reading each one's summary, totals or works. view=onboarded_cases searches live cases by case_search and returns the case_reference values that simulator_run.case_references accepts. To show a completed run to the user, call simulator_present. This account has no linked iPify entity, so view=onboarded_cases answers with no cases. Give simulator_run the case details instead, and simulator_requirements states what each service needs.

simulator_query

Called by the iPify simulation component as the user opens cases; not part of the agent's workflow. Reads one page of a presented run's cases, with their works, deadlines and fees. When the run pinned a report currency, each fee line also states its amount in that currency at the rate recorded with the run. The server sizes each page to its response budget.

simulator_present_cases

Calculates the works due on cases and what they cost for services currently listed by simulator_coverage, each with its official deadline, official fees and, under an agreement with iPify, its quoted price. Authorized onboarded cases retain access to their services even when those services are unavailable for public simulation. Use it when the user asks what a renewal, validation or entry will cost or when it is due, or to budget a case or a portfolio; the cases come from any of the sources named together, stated in full, staged imports, or held on iPify by portfolio or case reference, and are simulated as one portfolio. Show a completed run to the user with simulator_present and read its details with simulator_query.

simulator_run

Lists what the simulator can simulate. Without arguments it indexes the case jurisdictions and the IP-right types served there; with jurisdiction_code or item_code it lists each served case/destination combination with its item codes and names. Use it when the user asks whether a country, right or activity is supported, or before choosing item codes and destinations for a case's services. With jurisdiction_code and ipr_type it describes one renewal context instead: its filing routes and the dates and sources of its recorded official fees. Deadlines and amounts come from simulator_run.

simulator_coverage

Lists the parameters a simulation accepts and the ones it still needs: for a renewal context, for stated cases and their services, or for staged imports. Use it before a run when the case data may be incomplete, to learn the parameter codes with their types, options and defaults, or to see which imported cases still need input. Use one scope per call: jurisdiction_code with ipr_type, cases, or import_references; parameters, known_absent and filing_route refine the jurisdiction_code scope only. The answer depends on the supplied data, intent and dates; each open parameter says whether it blocks the calculation or only refines it. Use the same simulation_intent as the intended run.

simulator_requirements

Returns iPify's guide: who iPify is and how to reach it, the shared concepts (case, item, service, work, official fee, quoted price) and, per topic, how the simulator behaves. Use it before the first iPify task, or when a term or a result is unclear.

ipify_guide