> ## 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. # Preview a historical QuickBooks sync > Builds a frozen zero-provider-write plan for selected customers, service items and/or sales receipts, at most500 total records. Program ids must belong to this organization. Eligibility, existing mappings and missing dependencies choose create/update/link/skip/conflict; stores source fingerprints and snapshot_hash. Requires a connected QuickBooks company for mutations. Current user/group permissions must include manage_settings, access_account_settings or group_all in addition to route access. Requires the integration platform global/configured client feature gate (normally integration_platform_foundation). Requires permission: one of access_account_settings. ## OpenAPI ````yaml post /integrations/hub/connections/{connection_id}/quickbooks/historical/preview 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: /integrations/hub/connections/{connection_id}/quickbooks/historical/preview: post: tags: - Integrations summary: Preview a historical QuickBooks sync description: >- Builds a frozen zero-provider-write plan for selected customers, service items and/or sales receipts, at most500 total records. Program ids must belong to this organization. Eligibility, existing mappings and missing dependencies choose create/update/link/skip/conflict; stores source fingerprints and snapshot_hash. Requires a connected QuickBooks company for mutations. Current user/group permissions must include manage_settings, access_account_settings or group_all in addition to route access. Requires the integration platform global/configured client feature gate (normally integration_platform_foundation). Requires permission: one of access_account_settings. operationId: integrationQuickBooksHistoricalSyncPreview parameters: - name: connection_id in: path description: Connection 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: - object_types properties: program_ids: description: 'Program ids. Validation: nullable, array, max:100.' type: array items: description: 'Program ids item. Validation: integer, min:1.' type: integer minimum: 1 example: 1 maxItems: 100 nullable: true object_types: description: 'Object types. Validation: required, array, min:1.' type: array items: description: >- Object types item. Validation: string; allowed values: customer, service_item, sales_receipt. type: string enum: - customer - service_item - sales_receipt example: customer minItems: 1 date_from: description: 'Date from. Validation: nullable, date_format:Y-m-d.' type: string format: date example: '2026-10-20' nullable: true date_to: description: >- Date to. Validation: nullable, date_format:Y-m-d, after_or_equal:date_from. type: string format: date example: '2026-10-20' nullable: true type: object responses: '201': description: Operation result. content: application/json: schema: properties: status: type: string example: success data: $ref: '#/components/schemas/IntegrationHistoricalQuickBooksRun' 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 feature, organization connection, run or checkpoint is unavailable. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '422': description: >- The selected provider, filters, frozen approval or current execution state is invalid. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: IntegrationHistoricalQuickBooksRun: description: >- Stored historical preview/execution workspace. Provider processing is checkpointed and can remain running/reviewable after a202 receipt. properties: id: description: Organization-owned record identifier. type: integer example: 42 nullable: false run_type: type: string enum: - dry_run - backfill - correction example: dry_run status: description: Serialized workflow value. type: string example: Example nullable: false object_types: type: array items: type: string enum: - customer - service_item - sales_receipt example: customer counters: description: >- Counters differ between preview action counts and execution checkpoint statuses. properties: total: description: Record count. type: integer example: 2 create: description: Record count. type: integer example: 2 update: description: Record count. type: integer example: 2 link: description: Record count. type: integer example: 2 skip: description: Record count. type: integer example: 2 conflict: description: Record count. type: integer example: 2 pending: description: Record count. type: integer example: 2 queued: description: Record count. type: integer example: 2 processing: description: Record count. type: integer example: 2 failed: description: Record count. type: integer example: 2 needs_review: description: Record count. type: integer example: 2 skipped: description: Record count. type: integer example: 2 processed: description: Record count. type: integer example: 2 type: object summary: properties: snapshot_hash: description: Return this exact hash when approving a preview. type: string example: Example nullable: true record_count: description: Record count. type: integer example: 2 zero_provider_writes: description: True for previews. type: boolean example: true requires_approval: description: Workflow state. type: boolean example: true checkpointed: description: Workflow state. type: boolean example: true resumable: description: Workflow state. type: boolean example: true provider_complete: description: >- True when no pending/queued/processing checkpoint remains; reviewable checkpoints can still exist. type: boolean example: true reviewable_count: description: Record count. type: integer example: 2 type: object additionalProperties: {} context: properties: purpose: description: Serialized workflow value. type: string example: Example nullable: true filters: properties: program_ids: type: array items: description: Organization-owned record identifier. type: integer example: 42 nullable: false object_types: type: array items: type: string date_from: type: string format: date nullable: true date_to: type: string format: date nullable: true source_run_id: description: Organization-owned record identifier. type: integer example: 42 nullable: false type: object additionalProperties: {} plan_version: description: Record count. type: integer example: 2 cursor: properties: strategy: type: string example: frozen_plan_v1 record_count: description: Record count. type: integer example: 2 objects: type: object additionalProperties: properties: last_hys_object_id: description: Organization-owned record identifier. type: integer example: 42 nullable: false count: description: Record count. type: integer example: 2 type: object type: object realm_key: description: Serialized workflow value. type: string example: Example nullable: true zero_provider_writes: description: Workflow state. type: boolean example: true snapshot_hash: description: Serialized workflow value. type: string example: Example nullable: true preview_run_id: description: Organization-owned record identifier. type: integer example: 42 nullable: false source_run_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true approved_by: description: Organization-owned record identifier. type: integer example: 42 nullable: false approved_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true requires_approval: description: Workflow state. type: boolean example: true type: object additionalProperties: {} created_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true started_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true finished_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true events: description: >- Present in detailed show and mutations; omitted from the latest20 index. type: array items: $ref: '#/components/schemas/IntegrationHistoricalQuickBooksEvent' 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 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 IntegrationHistoricalQuickBooksEvent: properties: id: description: Organization-owned record identifier. type: integer example: 42 nullable: false status: description: Serialized workflow value. type: string example: Example nullable: false hys_object_type: description: Serialized workflow value. type: string example: Example nullable: true hys_object_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true provider_object_type: description: Serialized workflow value. type: string example: Example nullable: true retryable: description: Workflow state. type: boolean example: true error_code: description: Serialized workflow value. type: string example: Example nullable: true plan: $ref: '#/components/schemas/IntegrationHistoricalQuickBooksPlan' outbox_event_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true 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 IntegrationHistoricalQuickBooksPlan: properties: hys_object_type: description: >- Historical QuickBooks approval/checkpoint and SAP setup/review contracts. type: string enum: - donor - entity - donation example: donor hys_object_id: description: Organization-owned record identifier. type: integer example: 42 nullable: false provider_object_type: type: string enum: - customer - item - sales_receipt example: customer action: type: string enum: - create - update - link - skip - conflict example: create reason_code: description: Serialized workflow value. type: string example: Example nullable: true source_fingerprint: description: >- Frozen source fingerprint checked again before approval and execution. type: string example: Example nullable: false accounting_projection: description: >- Sales-receipt eligibility/accounting projection; present for donation plans. type: object additionalProperties: {} destructive_or_corrective: description: >- True only when an approved correction will update a previously processed record. type: boolean example: 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.