changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": {},
+ "properties": {
+ "asOf": {
+ "description": "Time the forecast was computed.",
+ "type": "string"
+ },
+ "nextOffset": {
+ "description": "Offset for the next page, or null when this is the last page.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "opportunities": {
+ "description": "This page of opportunities, most urgent first.",
+ "items": {
+ "additionalProperties": {},
+ "properties": {
+ "amount_minor": {
+ "description": "Value in minor currency units, or null when unknown.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "company": {
+ "additionalProperties": {},
+ "description": "The company this deal belongs to.",
+ "properties": {
+ "archived_at": {
+ "description": "When the company was archived, or null if active.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "domain": {
+ "description": "Website domain, or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "id": {
+ "description": "Company ID; pass it as company_id to the other CRM tools.",
+ "type": "string"
+ },
+ "last_contact_at": {
+ "description": "Latest recorded meeting, reply or product engagement, or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "lifecycle": {
+ "description": "Team-assessed stage: prospect, onboarding, active, at_risk or churned.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Company name.",
+ "type": "string"
+ },
+ "next_review_on": {
+ "description": "Next account review date, or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "owner": {
+ "description": "Responsible teammate, or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "revision": {
+ "description": "Current revision; pass it as expected_revision when editing with save_company.",
+ "type": "number"
+ },
+ "success_plan": {
+ "description": "Customer success plan text, or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "revision"
+ ],
+ "type": "object"
+ },
+ "company_id": {
+ "description": "Company this deal belongs to.",
+ "type": "string"
+ },
+ "currency": {
+ "description": "Currency code of amount_minor.",
+ "type": "string"
+ },
+ "expected_close_on": {
+ "description": "Expected close date, or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "forecast": {
+ "additionalProperties": {},
+ "description": "Explicit stage or team estimate, not a calibrated prediction.",
+ "properties": {
+ "basis": {
+ "description": "stage_estimate, team_estimate or outcome (closed deals).",
+ "type": "string"
+ },
+ "overdue": {
+ "description": "true when the next step's due date has passed.",
+ "type": "boolean"
+ },
+ "probability": {
+ "description": "Estimated win probability in percent.",
+ "type": "number"
+ },
+ "reasons": {
+ "description": "Plain-language reasons behind the probability.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "stale": {
+ "description": "true when there is no recorded contact for 14 or more days.",
+ "type": "boolean"
+ },
+ "weighted_minor": {
+ "description": "Value times probability, or null when the value is unknown.",
+ "type": [
+ "number",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "probability",
+ "basis",
+ "reasons",
+ "overdue",
+ "stale",
+ "weighted_minor"
+ ],
+ "type": "object"
+ },
+ "id": {
+ "description": "Opportunity ID.",
+ "type": "string"
+ },
+ "next_step": {
+ "description": "Next agreed action, or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "next_step_due_on": {
+ "description": "Due date of the next step, or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "probability_override": {
+ "description": "Team-supplied win probability, or null when the stage estimate applies.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "revision": {
+ "description": "Current revision; pass it as expected_revision when editing with save_opportunity.",
+ "type": "number"
+ },
+ "stage": {
+ "description": "new, qualified, meeting, proposal, negotiation, won or lost.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Deal name.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "company_id",
+ "title",
+ "stage",
+ "amount_minor",
+ "currency",
+ "revision",
+ "company",
+ "forecast"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "opportunityCount": {
+ "description": "Number of matching opportunities across all pages.",
+ "type": "number"
+ },
+ "totals": {
+ "additionalProperties": {
+ "additionalProperties": {},
+ "properties": {
+ "pipeline_minor": {
+ "description": "Open deal value.",
+ "type": "number"
+ },
+ "unvalued": {
+ "description": "Open or won deals with no value set.",
+ "type": "number"
+ },
+ "weighted_minor": {
+ "description": "Open deal value weighted by probability.",
+ "type": "number"
+ },
+ "won_minor": {
+ "description": "Value recorded as won (not proof of payment).",
+ "type": "number"
+ }
+ },
+ "required": [
+ "pipeline_minor",
+ "weighted_minor",
+ "won_minor",
+ "unvalued"
+ ],
+ "type": "object"
+ },
+ "description": "Totals keyed by currency code, in minor units, for every matching deal (not only this page).",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "asOf",
+ "totals",
+ "opportunityCount",
+ "opportunities",
+ "nextOffset"
+ ],
+ "type": "object"
+}