> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Roll a managed plan into its next period

> Uses the prior plan version. Requires a managed active/paused/completed plan and an annual review. Incomplete moves must all be future-scheduled and explicitly carried, or resolved first. Creates an active managed successor and completes the prior plan. Requires stewardship_major_donor_plans_v1. Relationship-group subjects also require stewardship_relationship_groups_v1. Subject access respects the viewer's donor visibility. Management requires donors_manage/group_all, or donors_view with assignment as this subject's fundraiser; strategy fields follow the same authority.  Requires permission: donors_view; plus one of donors_view, donors_manage.



## OpenAPI

````yaml post /admin/fundraising/stewardship-plans/{plan_id}/roll-forward
openapi: 3.0.0
info:
  title: Gratona API
  description: >-
    REST API for the Gratona fundraising platform, including donor, donation,
    sponsorship, program, event, and integration workflows. Endpoints are
    organized by tag. Most endpoints require either a Passport bearer token or
    an issued API key — see the Security Schemes section.
  contact:
    name: Gratona Engineering
    url: https://gratona.com
    email: devs@gratona.com
  version: 1.0.0
servers:
  - url: https://api.gratona.com/v1
    description: Server Version 1.0.0
security: []
tags:
  - name: Auth
    description: >-
      Login, signup, logout, password reset, and email verification for admin
      users and donors.
  - name: Donors
    description: >-
      Donor records: CRUD, profile fields, household linkage, search, filters,
      merge, and duplicate detection.
  - name: Donations
    description: >-
      Individual donation records, recurring commitments, soft credits, refunds,
      designations, and exports.
  - name: Sponsorships
    description: >-
      Donor-to-entity commitment relationships, lifecycle transitions, and
      commitment-specific filters.
  - name: Entities
    description: >-
      Recipient records (children, families, projects, animals, etc.), their
      status, and entity-level fields.
  - name: Programs
    description: >-
      Program / campaign configuration: hierarchy, settings, and program-level
      metadata.
  - name: Forms
    description: >-
      Custom form builder (HysForm), form fields, standardized donor fields, and
      field migrations.
  - name: Trips
    description: >-
      Mission-trip management: trips, participants, budgets, tasks,
      e-signatures, fundraising milestones, and background checks.
  - name: Communications
    description: >-
      Email templates, SMS, newsletters, donor email manager, and per-donor
      notes.
  - name: Payments
    description: >-
      Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks).
      Excludes inbound webhooks — see the Webhooks tag.
  - name: Reports
    description: Dashboards, analytics, scheduled reports, and exports.
  - name: Admin
    description: >-
      Client-account administration: users, groups/permissions, settings,
      integrations, and account lifecycle.
  - name: Donor Portal
    description: >-
      Endpoints consumed by the donor-facing portal (donor login, dashboard,
      donation history, messages).
  - name: Recipient Portal
    description: Endpoints consumed by the recipient-facing portal.
  - name: Public
    description: >-
      Unauthenticated public endpoints: donor signup, public trip pages,
      peer-to-peer campaigns, public checkout.
  - name: Webhooks
    description: >-
      Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr,
      DropboxSign). Annotated minimally for reference; payload shapes are owned
      by the upstream provider.
  - name: Events
    description: >-
      Event setup, invitations, registration, ticketing, attendance and event
      reporting.
  - name: Journeys
    description: >-
      Journey graphs, activation, enrollment, message templates and event
      follow-up automations.
  - name: Tasks
    description: Workspace tasks, assignments, saved task views and record collaboration.
  - name: Fundraising
    description: >-
      Fundraising portfolios, stewardship plans, giving anniversaries and
      personal donor follow-up.
  - name: Impact Stories
    description: Story intake, review, assets, consent and publication workflows.
  - name: Integrations
    description: Workspace integration connections, mappings, synchronization and recovery.
  - name: Email Calendar
    description: Connected email/calendar accounts and donor interactions.
  - name: Spaces
    description: Workspace Spaces and collaborative Pages.
  - name: Library
    description: Workspace documents, source connections, files and analysis.
  - name: Intelligence
    description: Donor intelligence and Tali workspace workflows.
  - name: Automation
    description: >-
      V3 automation primitive discovery, input validation, invocation and Zapier
      contracts.
  - name: Schema
    description: V3 model, enum, capability and scope discovery.
  - name: Zapier
    description: Zapier automation connections, polling feeds and actions.
  - name: Files
    description: Files
  - name: Client
    description: Client
  - name: Payment Gateways
    description: Payment Gateways
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Recipients
    description: Recipients
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Settings
    description: Settings
  - name: Notifications
    description: Notifications
  - name: Participation
    description: Participation
  - name: Users
    description: Users
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
  - name: Workspace
    description: Workspace
paths:
  /admin/fundraising/stewardship-plans/{plan_id}/roll-forward:
    post:
      tags:
        - Fundraising
      summary: Roll a managed plan into its next period
      description: >-
        Uses the prior plan version. Requires a managed active/paused/completed
        plan and an annual review. Incomplete moves must all be future-scheduled
        and explicitly carried, or resolved first. Creates an active managed
        successor and completes the prior plan. Requires
        stewardship_major_donor_plans_v1. Relationship-group subjects also
        require stewardship_relationship_groups_v1. Subject access respects the
        viewer's donor visibility. Management requires donors_manage/group_all,
        or donors_view with assignment as this subject's fundraiser; strategy
        fields follow the same authority.  Requires permission: donors_view;
        plus one of donors_view, donors_manage.
      operationId: stewardshipPlanRollForward
      parameters:
        - name: plan_id
          in: path
          description: Plan id in the current organization.
          required: true
          schema:
            type: integer
          example: 42
      requestBody:
        description: Validated request fields for this operation.
        required: true
        content:
          application/json:
            schema:
              required:
                - version
                - period_start
                - period_end
                - goal_amount
              properties:
                version:
                  description: >-
                    Current plan version for optimistic concurrency. Stale
                    versions return 409.
                  type: integer
                  minimum: 1
                  example: 1
                period_start:
                  description: 'Period start. Validation: required, date_format:Y-m-d.'
                  type: string
                  format: date
                  example: '2026-10-20'
                period_end:
                  description: >-
                    Period end. Validation: required, date_format:Y-m-d,
                    after_or_equal:period_start.
                  type: string
                  format: date
                  example: '2026-10-20'
                tier:
                  description: 'Tier. Validation: nullable; allowed values: A, B, C.'
                  type: string
                  enum:
                    - A
                    - B
                    - C
                    - null
                  example: A
                  nullable: true
                goal_amount:
                  description: >-
                    Goal amount. Validation: required, numeric, min:0,
                    max:9999999999999.99.
                  type: number
                  maximum: 9999999999999.99
                  minimum: 0
                  example: 25
                target_ask_amount:
                  description: >-
                    Target ask amount. Validation: nullable, numeric, min:0,
                    max:9999999999999.99.
                  type: number
                  maximum: 9999999999999.99
                  minimum: 0
                  example: 25
                  nullable: true
                action_donor_id:
                  description: 'Action donor id. Validation: nullable, integer, min:1.'
                  type: integer
                  minimum: 1
                  example: 1
                  nullable: true
                include_incomplete_future_moves:
                  description: >-
                    Include incomplete future moves. Validation: nullable,
                    boolean.
                  type: boolean
                  example: true
                  nullable: true
              type: object
      responses:
        '201':
          description: Operation result.
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    $ref: '#/components/schemas/StewardshipPlanDetail'
                type: object
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: >-
            The authenticated user lacks access to this workflow or its related
            records.
        '404':
          description: >-
            The stewardship feature, subject, plan, move or related record is
            unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '409':
          description: Plan/move version, scope, lifecycle or projection conflict.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StewardshipPlanConflict'
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestRejection'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    StewardshipPlanDetail:
      description: >-
        Strategy fields, moves and reviews are omitted unless
        permissions.can_view_strategy is true; mutations return the refreshed
        plan workspace unless their response says otherwise.
      properties:
        id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: false
        version:
          description: Optimistic concurrency version.
          type: integer
          example: 2
          nullable: false
        subject:
          $ref: '#/components/schemas/StewardshipPlanSubject'
        stage:
          type: string
          enum:
            - qualifying
            - managed
          example: qualifying
        status:
          type: string
          enum:
            - draft
            - active
            - paused
            - completed
            - archived
          example: draft
        tier:
          type: string
          enum:
            - A
            - B
            - C
            - null
          example: A
          nullable: true
        stage_entered_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        action_donor_id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: true
        period:
          properties:
            start:
              description: Calendar date.
              type: string
              format: date
              example: '2026-10-20'
              nullable: true
            end:
              description: Calendar date.
              type: string
              format: date
              example: '2026-10-20'
              nullable: true
          type: object
        currency:
          description: ISO currency of the plan.
          type: string
          maxLength: 3
          minLength: 3
          example: USD
        goal_amount:
          description: Monetary amount in the plan currency.
          type: number
          example: 1000
          nullable: true
        attributed_actual:
          description: Monetary amount in the plan currency.
          type: number
          example: 1000
          nullable: true
        direct_actual:
          description: Monetary amount in the plan currency.
          type: number
          example: 1000
          nullable: true
        soft_credit_actual:
          description: Monetary amount in the plan currency.
          type: number
          example: 1000
          nullable: true
        variance_amount:
          description: Monetary amount in the plan currency.
          type: number
          example: 1000
          nullable: true
        gift_count:
          description: Count.
          type: integer
          example: 2
          nullable: true
        giving_status:
          type: string
          enum:
            - pending
            - currency_mismatch
            - ready
            - stale
            - failed
          example: pending
        giving_last_successful_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        currency_breakdown:
          type: array
          items:
            properties:
              currency:
                description: Stored workflow value.
                type: string
                example: Example
                nullable: false
              attributed_actual:
                description: Monetary amount in the plan currency.
                type: number
                example: 1000
                nullable: true
              direct_actual:
                description: Monetary amount in the plan currency.
                type: number
                example: 1000
                nullable: true
              soft_credit_actual:
                description: Monetary amount in the plan currency.
                type: number
                example: 1000
                nullable: true
              gift_count:
                description: Count.
                type: integer
                example: 2
                nullable: false
            type: object
        next_move:
          properties:
            id:
              description: Record identifier in this organization.
              type: integer
              example: 42
              nullable: false
            title:
              description: Stored workflow value.
              type: string
              example: Example
              nullable: true
            planned_at:
              description: Timestamp.
              type: string
              format: date-time
              example: '2026-10-20T12:00:00Z'
              nullable: true
          type: object
          nullable: true
        open_move_count:
          description: Count.
          type: integer
          example: 2
          nullable: false
        overdue_move_count:
          description: Count.
          type: integer
          example: 2
          nullable: false
        health:
          properties:
            status:
              description: Stored workflow value.
              type: string
              example: Example
              nullable: false
            reasons:
              type: array
              items:
                type: string
                example: overdue_move
          type: object
        metric_basis:
          type: string
          enum:
            - relationship_attribution
          example: relationship_attribution
        completion_outcome:
          description: Stored workflow value.
          type: string
          example: Example
          nullable: true
        qualification_template_version:
          description: Count.
          type: integer
          example: 2
          nullable: true
        qualification_progress:
          properties:
            completed:
              description: Count.
              type: integer
              example: 2
              nullable: false
            skipped:
              description: Count.
              type: integer
              example: 2
              nullable: false
            total:
              description: Count.
              type: integer
              example: 2
              nullable: false
          type: object
        permissions:
          $ref: '#/components/schemas/StewardshipPlanPermissions'
        strategy_reviewed_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        next_review_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        target_ask_amount:
          description: Monetary amount in the plan currency.
          type: number
          example: 1000
          nullable: true
        expected_giving_month:
          description: Expected giving month; strategy viewers only.
          type: integer
          maximum: 12
          minimum: 1
          example: 10
          nullable: true
        expected_giving_note:
          description: Strategy viewers only.
          type: string
          example: Example
          nullable: true
        closure_reason:
          description: Strategy viewers only.
          type: string
          example: Example
          nullable: true
        strategy_summary:
          description: Strategy viewers only.
          type: string
          example: Example
          nullable: true
        interests_summary:
          description: Strategy viewers only.
          type: string
          example: Example
          nullable: true
        communication_guidance:
          description: Strategy viewers only.
          type: string
          example: Example
          nullable: true
        moves:
          description: Strategy viewers only; ordered by sequence, planned date and id.
          type: array
          items:
            $ref: '#/components/schemas/StewardshipPlanMove'
        reviews:
          description: Strategy viewers only; up to 25 most recent reviews.
          type: array
          items:
            $ref: '#/components/schemas/StewardshipPlanReview'
        warnings:
          description: >-
            Optional after a committed mutation whose derived projection is
            delayed.
          type: array
          items:
            $ref: '#/components/schemas/StewardshipPlanWarning'
      type: object
    UnauthorizedResponse:
      title: UnauthorizedResponse
      description: >-
        Returned with HTTP 401 when the request lacks a valid Passport bearer
        token, a valid `X-HYS-API-Key`, or a valid session. The body is the
        simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`.
      required:
        - message
        - status
      properties:
        message:
          description: >-
            Always the literal string `Unauthorized` from the `auth.api_or_key`
            middleware. Login endpoints return `Invalid Credentials` instead.
          type: string
          example: Unauthorized
        status:
          type: string
          example: error
      type: object
    NotFoundResponse:
      title: NotFoundResponse
      description: >-
        Returned with HTTP 404 when a resource lookup misses (typically because
        the id doesn't exist OR is scoped to a different `client_id`). Note:
        many endpoints intentionally collapse 'not found' and 'forbidden' into a
        single 404 to avoid leaking which records exist in another tenant.
      required:
        - message
      properties:
        message:
          description: >-
            Human-readable message. Often a more specific string like `Donor not
            found` or `Trip not found`.
          type: string
          example: Not Found
        status:
          type: string
          example: error
      type: object
    StewardshipPlanConflict:
      description: >-
        Conflict payload keys depend on the code: stale version, overlapping
        relationship scope, invalid transition, unavailable Work projection or
        unavailable feature decision.
      properties:
        status:
          type: string
          enum:
            - error
          example: error
        code:
          description: Machine-readable conflict code.
          type: string
          example: PLAN_VERSION_CONFLICT
        message:
          description: Stored workflow value.
          type: string
          example: Example
          nullable: false
        data:
          properties:
            latest:
              $ref: '#/components/schemas/StewardshipPlanSummary'
            conflicting_plan:
              description: Header identifying a plan with an overlapping period and scope.
              type: object
              additionalProperties: {}
          type: object
          additionalProperties: {}
      type: object
    RequestRejection:
      description: >-
        Request or workflow rejection. Framework field-validation failures
        contain errors; semantic rejections may contain message without errors;
        legacy/provider failures may use error and error_code. The operation
        description identifies the rejected condition. Domain responses may add
        current revision, limits or other conflict context.
      anyOf:
        - $ref: '#/components/schemas/ValidationErrorResponse'
        - $ref: '#/components/schemas/ErrorResponse'
        - required:
            - error
          properties:
            error:
              description: Legacy or provider-facing error message.
              type: string
              example: The request could not be completed.
            error_code:
              description: Stable domain error code, when provided.
              type: string
              example: WORKFLOW_UNAVAILABLE
          type: object
    StewardshipPlanSubject:
      description: >-
        Resolved relationship and eligible action contacts. Archived subjects
        retain an inert identity with no eligible contacts.
      properties:
        type:
          type: string
          enum:
            - donor
            - household
            - relationship_group
          example: donor
        id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: false
        display_name:
          description: Name of the relationship subject.
          type: string
          example: Example
          nullable: false
        kind:
          description: Relationship-group kind; omitted for donor/household subjects.
          type: string
          example: Example
          nullable: true
        assigned_fundraiser_user_id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: true
        relationship_manager:
          properties:
            id:
              description: Record identifier in this organization.
              type: integer
              example: 42
              nullable: false
            display_name:
              description: Stored workflow value.
              type: string
              example: Example
              nullable: false
          type: object
          nullable: true
        action_donors:
          type: array
          items:
            properties:
              id:
                description: Record identifier in this organization.
                type: integer
                example: 42
                nullable: false
              display_name:
                description: Stored workflow value.
                type: string
                example: Example
                nullable: false
              email:
                description: Contact email.
                type: string
                example: Example
                nullable: true
              do_not_email:
                description: Email preference.
                type: boolean
                example: true
              status:
                description: Donor status.
                type: string
                example: Example
                nullable: true
              role:
                description: Relationship role.
                type: string
                example: Example
                nullable: true
              relationship_label:
                description: Stored workflow value.
                type: string
                example: Example
                nullable: true
              is_primary_contact:
                description: Permission or workflow state.
                type: boolean
                example: true
            type: object
        available:
          description: >-
            False when an authorized historical plan retains an archived
            subject.
          type: boolean
          example: true
        archived:
          description: Present for archived historical subjects.
          type: boolean
          example: true
      type: object
    StewardshipPlanPermissions:
      properties:
        can_manage:
          description: Whether the viewer may manage this relationship plan.
          type: boolean
          example: true
        can_view_strategy:
          description: Whether strategy, moves and review history are disclosed.
          type: boolean
          example: true
      type: object
    StewardshipPlanMove:
      properties:
        id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: false
        version:
          description: Move version, distinct from the plan version.
          type: integer
          example: 2
          nullable: false
        kind:
          type: string
          enum:
            - qualification
            - research
            - cultivation
            - solicitation
            - stewardship
            - other
          example: cultivation
        template_key:
          description: Stored workflow value.
          type: string
          example: Example
          nullable: true
        sequence:
          description: Count.
          type: integer
          example: 2
          nullable: true
        title:
          description: Stored workflow value.
          type: string
          example: Example
          nullable: false
        description:
          description: Stored workflow value.
          type: string
          example: Example
          nullable: true
        planned_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        status:
          type: string
          enum:
            - planned
            - in_progress
            - completed
            - skipped
            - canceled
          example: planned
        action_donor_id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: true
        owner_user_id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: true
        task_id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: true
        completion_source:
          type: string
          enum:
            - manual
            - task
            - interaction
            - null
          example: manual
          nullable: true
        outcome_summary:
          description: Stored workflow value.
          type: string
          example: Example
          nullable: true
        completed_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        status_reason:
          description: Stored workflow value.
          type: string
          example: Example
          nullable: true
        evidence:
          type: array
          items:
            $ref: '#/components/schemas/StewardshipPlanEvidence'
      type: object
    StewardshipPlanReview:
      properties:
        id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: false
        review_type:
          type: string
          enum:
            - strategy
            - periodic
            - annual
            - stage_change
          example: strategy
        outcome:
          description: Stored workflow value.
          type: string
          example: Example
          nullable: true
        summary:
          description: Saved summary, or [Redacted] after authorized privacy erasure.
          type: string
          example: Example
          nullable: true
        redacted_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        reviewed_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        reviewed_by_user_id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: true
      type: object
    StewardshipPlanWarning:
      properties:
        code:
          type: string
          example: work_projection_delayed
        message:
          description: >-
            The mutation committed; derived Work/progress is delayed and
            automatically retried.
          type: string
          example: Example
          nullable: false
      type: object
    StewardshipPlanSummary:
      description: >-
        Summary-safe plan header with relationship-attributed giving and
        operational rollup status.
      properties:
        id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: false
        version:
          description: Optimistic concurrency version.
          type: integer
          example: 2
          nullable: false
        subject:
          properties:
            type:
              type: string
              enum:
                - donor
                - household
                - relationship_group
              example: donor
            id:
              description: Record identifier in this organization.
              type: integer
              example: 42
              nullable: false
          type: object
        stage:
          type: string
          enum:
            - qualifying
            - managed
          example: qualifying
        status:
          type: string
          enum:
            - draft
            - active
            - paused
            - completed
            - archived
          example: draft
        tier:
          type: string
          enum:
            - A
            - B
            - C
            - null
          example: A
          nullable: true
        stage_entered_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        action_donor_id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: true
        period:
          properties:
            start:
              description: Calendar date.
              type: string
              format: date
              example: '2026-10-20'
              nullable: true
            end:
              description: Calendar date.
              type: string
              format: date
              example: '2026-10-20'
              nullable: true
          type: object
        currency:
          description: ISO currency of the plan.
          type: string
          maxLength: 3
          minLength: 3
          example: USD
        goal_amount:
          description: Monetary amount in the plan currency.
          type: number
          example: 1000
          nullable: true
        attributed_actual:
          description: Monetary amount in the plan currency.
          type: number
          example: 1000
          nullable: true
        direct_actual:
          description: Monetary amount in the plan currency.
          type: number
          example: 1000
          nullable: true
        soft_credit_actual:
          description: Monetary amount in the plan currency.
          type: number
          example: 1000
          nullable: true
        variance_amount:
          description: Monetary amount in the plan currency.
          type: number
          example: 1000
          nullable: true
        gift_count:
          description: Count.
          type: integer
          example: 2
          nullable: true
        giving_status:
          type: string
          enum:
            - pending
            - currency_mismatch
            - ready
            - stale
            - failed
          example: pending
        giving_last_successful_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        currency_breakdown:
          type: array
          items:
            properties:
              currency:
                description: Stored workflow value.
                type: string
                example: Example
                nullable: false
              attributed_actual:
                description: Monetary amount in the plan currency.
                type: number
                example: 1000
                nullable: true
              direct_actual:
                description: Monetary amount in the plan currency.
                type: number
                example: 1000
                nullable: true
              soft_credit_actual:
                description: Monetary amount in the plan currency.
                type: number
                example: 1000
                nullable: true
              gift_count:
                description: Count.
                type: integer
                example: 2
                nullable: false
            type: object
        next_move:
          properties:
            id:
              description: Record identifier in this organization.
              type: integer
              example: 42
              nullable: false
            title:
              description: Stored workflow value.
              type: string
              example: Example
              nullable: true
            planned_at:
              description: Timestamp.
              type: string
              format: date-time
              example: '2026-10-20T12:00:00Z'
              nullable: true
          type: object
          nullable: true
        open_move_count:
          description: Count.
          type: integer
          example: 2
          nullable: false
        overdue_move_count:
          description: Count.
          type: integer
          example: 2
          nullable: false
        health:
          properties:
            status:
              description: Stored workflow value.
              type: string
              example: Example
              nullable: false
            reasons:
              type: array
              items:
                type: string
                example: overdue_move
          type: object
        metric_basis:
          type: string
          enum:
            - relationship_attribution
          example: relationship_attribution
      type: object
    ValidationErrorResponse:
      title: ValidationErrorResponse
      description: >-
        Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The
        `errors` map is keyed by the failing field name; each value is an array
        of human-readable error messages for that field. Most controllers also
        include a top-level `status: error`.
      required:
        - errors
      properties:
        errors:
          description: >-
            Map of field name to array of validator error messages. Example:
            `{email: [The email field is required.], amount: [The amount must be
            a number.]}`.
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        status:
          description: Always the literal string `error`.
          type: string
          example: error
        message:
          description: >-
            Optional summary message — present on some endpoints, absent on
            others.
          type: string
          example: The given data was invalid.
          nullable: true
      type: object
    ErrorResponse:
      title: ErrorResponse
      description: >-
        Generic error envelope used by most controllers. Most error responses
        pair a human-readable `message` with `status: error`. Some endpoints
        additionally include `errors` (validator errors), `error` (legacy
        single-error string), `code`, or domain-specific context fields.
      required:
        - message
      properties:
        message:
          description: Human-readable error message.
          type: string
          example: Something went wrong. Please try again.
        status:
          description: >-
            Always the literal string `error` for failures. Some endpoints omit
            this field.
          type: string
          example: error
        error:
          description: Legacy single error code/string used by older endpoints.
          type: string
          example: invalid_request
          nullable: true
        code:
          description: >-
            Optional application-level error code (not all endpoints populate
            this).
          type: string
          example: DONOR_NOT_FOUND
          nullable: true
      type: object
    StewardshipPlanEvidence:
      description: Only evidence visible under interaction/email privacy rules is included.
      properties:
        id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: false
        type:
          type: string
          enum:
            - activity
            - calendar_event
          example: activity
        record_id:
          description: Record identifier in this organization.
          type: integer
          example: 42
          nullable: false
        role:
          type: string
          enum:
            - scheduled
            - completion
          example: completion
        available:
          description: Permission or workflow state.
          type: boolean
          example: true
        is_contact:
          description: Permission or workflow state.
          type: boolean
          example: true
        is_meaningful:
          description: Permission or workflow state.
          type: boolean
          example: true
        meaningful_basis:
          description: Stored workflow value.
          type: string
          example: Example
          nullable: true
        exclusion_reason:
          description: Stored workflow value.
          type: string
          example: Example
          nullable: true
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      description: Passport bearer token authentication for legacy admin sessions.
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      description: Gratona API key sent with the compatibility header X-HYS-API-Key.
      name: X-HYS-API-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.