every.ai

{
  "type": "object",
  "properties": {
    "from_business": {
      "type": "object",
      "description": "The sender — the guest's own business (who is proposing). Omit on create to reuse the sender saved in this browser; required on update.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The sender Required.",
          "maxLength": 120
        },
        "email": {
          "type": "string",
          "description": "Email address shown on the document, if provided.",
          "maxLength": 320
        },
        "address": {
          "type": "string",
          "description": "Mailing address shown on the document, if provided.",
          "maxLength": 400
        },
        "phone": {
          "type": "string",
          "description": "Phone number shown on the document, if provided.",
          "maxLength": 40
        }
      },
      "required": [
        "name"
      ],
      "additionalProperties": false
    },
    "to_client": {
      "type": "object",
      "description": "The recipient — the prospective client this proposal is for.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The recipient Required.",
          "maxLength": 120
        },
        "email": {
          "type": "string",
          "description": "Email address shown on the document, if provided.",
          "maxLength": 320
        },
        "address": {
          "type": "string",
          "description": "Mailing address shown on the document, if provided.",
          "maxLength": 400
        },
        "phone": {
          "type": "string",
          "description": "Phone number shown on the document, if provided.",
          "maxLength": 40
        }
      },
      "required": [
        "name"
      ],
      "additionalProperties": false
    },
    "title": {
      "type": "string",
      "description": "Proposal title, e.g. \"Brand Refresh — Statement of Work\". Required.",
      "maxLength": 200
    },
    "scope": {
      "type": "string",
      "description": "The scope of work: what will be delivered. Required. Markdown supported, no links.",
      "maxLength": 6000
    },
    "summary": {
      "type": "string",
      "description": "Optional short executive summary shown near the top of the proposal.",
      "maxLength": 2000
    },
    "deliverables": {
      "type": "array",
      "description": "Optional bullet list of concrete deliverables, rendered as a scope checklist.",
      "maxItems": 20,
      "items": {
        "type": "string",
        "maxLength": 300
      }
    },
    "line_items": {
      "type": "array",
      "description": "Optional priced line items for the proposal, e.g. milestones or deliverable pricing.",
      "minItems": 0,
      "maxItems": 50,
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "description": "What this line item is for, shown to the recipient.",
            "maxLength": 300
          },
          "quantity": {
            "type": "number",
            "description": "Quantity or hours for this line item. Defaults to 1.",
            "exclusiveMinimum": 0
          },
          "unit_price": {
            "type": "number",
            "description": "Price per unit, in the document currency.",
            "minimum": 0
          },
          "discount_applied": {
            "type": "number",
            "description": "Optional discount to subtract from this line item.",
            "minimum": 0
          },
          "discount_type": {
            "type": "string",
            "enum": [
              "percentage",
              "fixed"
            ],
            "description": "Whether discount_applied is a percentage of the line total or a fixed currency amount."
          },
          "sales_tax_applied": {
            "type": "number",
            "description": "Optional sales tax percentage applied to this line item.",
            "minimum": 0
          }
        },
        "required": [
          "description"
        ],
        "additionalProperties": false
      }
    },
    "proposal_notes": {
      "type": "string",
      "description": "Optional internal-facing notes shown on the proposal.",
      "maxLength": 2000
    },
    "client_message": {
      "type": "string",
      "description": "Optional personal message to the client shown at the top of the proposal.",
      "maxLength": 2000
    },
    "issue_date": {
      "type": "string",
      "format": "date",
      "description": "ISO 8601 date (YYYY-MM-DD) the proposal is issued. Defaults to today."
    },
    "expiry_date": {
      "type": "string",
      "format": "date",
      "description": "ISO 8601 date (YYYY-MM-DD) the proposal expires. Defaults to 30 days from issue."
    },
    "currency": {
      "type": "string",
      "description": "Currency of the document — USD or CAD only, defaults to USD. If asked for another currency, say it isn't supported yet rather than guessing.",
      "enum": [
        "USD",
        "CAD"
      ],
      "default": "USD"
    },
    "proposal_number": {
      "type": "string",
      "description": "Optional proposal number. Auto-assigned if omitted.",
      "maxLength": 40
    },
    "client_request_id": {
      "type": "string",
      "description": "Optional idempotency key: reusing the same value on a retry returns the original, not a duplicate — set only when resending an already-sent call.",
      "maxLength": 80
    }
  },
  "required": [
    "to_client",
    "title",
    "scope"
  ],
  "additionalProperties": false
}