Generated Service Contracts

This page is generated from LeafEnterprise/service_contracts.py and is part of the source-of-truth contract layer for agents and humans.

Do not edit this file by hand. Run:

python scripts\generate_docs_api_reference.py

API Endpoints

Method	Path	Module	Required request fields	Response sections	Purpose
GET	/api/client-report/context	audit_savings	pbm, tpa, start_date, end_date	client_context, linked_packets, readiness	Return resolved report scope plus linked contract and pricing identifiers.
GET	/api/contracts/oversight	contract_oversight	pbm, tpa, start_date, end_date	guarantee_monitor, variance_summary, recommended_actions	Return live contract oversight state derived from claims, audits, and guarantee monitors.
GET	/api/contracts/review	contract_oversight	pbm, tpa, start_date, end_date	contract_packet, negotiation_issues, guarantee_monitors	Return normalized contract packet, negotiation issues, and guarantee monitors for a scope.
GET	/api/partners/programs	delivery_ops	-	partner_programs, templates, active_deliverables	Return partner-channel program metadata and active deliverable templates.
GET	/api/renewals/status	delivery_ops	pbm, tpa, start_date, end_date	renewal_event, deliverables, partner_programs	Return renewal windows, due dates, and deliverable readiness for the selected scope.
GET	/api/market-checks/qualitative	market_checks	rfp_project_id	qualitative_scorecard, criteria, recommendation	Return qualitative PBM scorecard and fit assessment for a market-check project.
GET	/api/clinical-hub/opportunities	medical_rx_clinical_hub	pbm, tpa, start_date, end_date	opportunities, target_prices, clinical_hub_cases	Return medical-Rx, J-code, site-of-care, and sourcing opportunities for a scope.
POST	/api/pricing/compare	pricing_registry	current_pricing_term_set_id, candidate_pricing_term_set_id	comparison, assumptions, evidence	Compare incumbent and challenger pricing term sets.
GET	/api/pricing/coverage	pricing_registry	pbm, tpa, start_date, end_date	coverage_summary, top_missing_pricing_keys, top_gap_slices, artifact_coverage	Return pricing coverage gaps, linkage rates, and missing pricing-key concentrations for the selected scope.
GET	/api/pricing/registry	pricing_registry	pbm, tpa, start_date, end_date	pricing_term_sets, pricing_assignments, coverage_summary, effective_dates, entity_links	Return pricing term sets by PBM, TPA, client, group, and effective date.
GET	/api/rebates/manufacturers	rebates_hcpcs	pbm, tpa	manufacturer_programs, program_rules, reporting	Return manufacturer-linked program context for rebate and medical-Rx workflows.
GET	/api/rebates/status	rebates_hcpcs	pbm, tpa, start_date, end_date	submission_jobs, deadlines, reconciliation	Return medical rebate and HCPCS submission status for the selected scope.

Queue Actions

Action type	Module	Required scope	Required metadata	Optional metadata	Description
contract_oversight_refresh	contract_oversight	pbm, tpa, group_name, start_date, end_date	product_module, contract_packet_id	guarantee_monitor_id, renewal_event_id	Measure live claims and audit outputs against contracted guarantees and fee terms.
contract_review	contract_oversight	pbm, tpa, group_name, start_date, end_date	product_module, source_artifact_ids	contract_packet_id, pricing_term_set_id, renewal_event_id	Extract or refresh normalized contract packets for the selected scope.
partner_deliverable_generation	delivery_ops	pbm, tpa, group_name, start_date, end_date	product_module, deliverable_template_id	partner_program_id, renewal_event_id, queue_request_parent_id	Generate co-branded or partner-program deliverables for broker, captive, or underwriting channels.
renewal_checkup	delivery_ops	pbm, tpa, group_name, start_date, end_date	product_module, renewal_event_id	partner_program_id, deliverable_commitment_id	Run a renewal-timed PBM checkup workflow and stage repricing deliverables.
market_check	market_checks	pbm, tpa, group_name, start_date, end_date	product_module, pricing_term_set_id	contract_packet_id, rfp_project_id, qualitative_scorecard_id	Build incumbent-versus-alternative PBM market-check output for the selected scope.
qualitative_scorecard_refresh	market_checks	pbm, tpa, group_name, start_date, end_date	product_module, rfp_project_id	response_packet_ids, qualitative_scorecard_id	Refresh structured qualitative PBM scorecards used alongside pricing comparisons.
clinical_hub_review	medical_rx_clinical_hub	pbm, tpa, group_name, start_date, end_date	product_module, opportunity_id	clinical_hub_case_id, provider_packet_id	Run a medical-Rx or Clinical Hub review for specialty, J-code, or site-of-care opportunities.
site_of_care_analysis	medical_rx_clinical_hub	pbm, tpa, group_name, start_date, end_date	product_module, opportunity_id	provider_packet_id, manufacturer_program_id	Evaluate site-of-care or infusion routing opportunities for medical-benefit claims.
sourcing_followup	medical_rx_clinical_hub	pbm, tpa, group_name, start_date, end_date	product_module, opportunity_id	case_owner, quote_packet_id	Continue sourcing coordination, white-bagging checks, or partner follow-up.
sourcing_quote	medical_rx_clinical_hub	pbm, tpa, group_name, start_date, end_date	product_module, opportunity_id	target_price_id, partner_vendor_ids	Generate quote packets for specialty or J-code sourcing opportunities.
pricing_refresh	pricing_registry	pbm, tpa, group_name, start_date, end_date	product_module, source_artifact_ids	pricing_term_set_id, entity_crosswalk_id	Ingest or refresh pricing and rosetta mappings from curated workbook sources.
manufacturer_rebate_reconciliation	rebates_hcpcs	pbm, tpa, group_name, start_date, end_date	product_module, submission_job_id, manufacturer_program_id	packet_id, quarter_label, reporting_period_start, reporting_period_end, latest_deadline_date, program_type, cycle_count	Compare expected manufacturer or program rebate outcomes against paid outcomes using a packet-backed manufacturer program context.
medical_rebate_reconciliation	rebates_hcpcs	pbm, tpa, group_name, start_date, end_date	product_module, submission_job_id	manufacturer_program_id, payment_reconciliation_id, quarter_label, reporting_period_start, reporting_period_end, latest_deadline_date, program_type	Compare expected manufacturer or program rebate outcomes against paid outcomes.
medical_rebate_submission	rebates_hcpcs	pbm, tpa, group_name, start_date, end_date	product_module, submission_job_id	manufacturer_program_id, reconciliation_id	Execute the quarter-bound medical rebate submission workflow.
medical_rebate_validation	rebates_hcpcs	pbm, tpa, group_name, start_date, end_date	product_module, submission_job_id	manufacturer_program_id, file_layout_id	Validate medical rebate or HCPCS layout readiness before submission.