> ## 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.

# Read QuickBooks service item field mappings

> Returns the configured program form fields, QuickBooks Name/Description/UnitPrice/Sku target options and saved mappings. Program-specific reads also return provider item categories when available; lookup errors produce an empty category list. Without a program, program_hysform_id is interpreted as a program id. Requires permission: one of programs_view, manage_programs, program-all.



## OpenAPI

````yaml get /admin/program_fields_to_sync
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/program_fields_to_sync:
    get:
      tags:
        - Integrations
      summary: Read QuickBooks service item field mappings
      description: >-
        Returns the configured program form fields, QuickBooks
        Name/Description/UnitPrice/Sku target options and saved mappings.
        Program-specific reads also return provider item categories when
        available; lookup errors produce an empty category list. Without a
        program, program_hysform_id is interpreted as a program id. Requires
        permission: one of programs_view, manage_programs, program-all.
      operationId: integrationLegacyQuickBooksProgramFieldsToSync
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/IntegrationLegacyQuickBooksProgramMappings
        '400':
          description: A global program assignment has not been configured.
        '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: QuickBooks integration or program is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationLegacyQuickBooksError'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    IntegrationLegacyQuickBooksProgramMappings:
      properties:
        program_fields:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationLegacyQuickBooksProgramField'
        quickbooks_fields:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationLegacyQuickBooksFieldOption'
        program_mappings:
          description: >-
            Field mapping keyed by source field, with nonempty string target
            values.
          oneOf:
            - type: object
              additionalProperties:
                type: string
            - type: array
              items: {}
              maxItems: 0
        item_categories:
          type: array
          items:
            properties:
              id:
                type: string
                example: '42'
              name:
                description: Serialized value.
                type: string
                example: Example
                nullable: false
              fully_qualified_name:
                description: Serialized value.
                type: string
                example: Example
                nullable: false
            type: object
        selected_item_category_id:
          type: string
          nullable: true
      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
    IntegrationLegacyQuickBooksError:
      description: >-
        Legacy QuickBooks error envelope; needs_reauth is added for expired
        authorization.
      required:
        - error
      properties:
        error:
          type: string
          example: QuickBooks integration not found
        needs_reauth:
          type: boolean
          example: true
      type: object
    IntegrationLegacyQuickBooksProgramField:
      description: >-
        Raw stored form-field record; optional flags/configuration depend on the
        field.
      properties:
        id:
          description: Organization record identifier.
          type: integer
          example: 42
          nullable: false
        client_id:
          description: Organization record identifier.
          type: integer
          example: 42
          nullable: false
        hysform_id:
          description: Organization record identifier.
          type: integer
          example: 42
          nullable: false
        field_key:
          type: string
          example: name
        field_label:
          type: string
          example: Name
        field_type:
          type: string
          example: text
        field_data:
          type: string
          nullable: true
        required:
          oneOf:
            - type: boolean
            - type: integer
            - type: string
        visibility_classification:
          type: string
          enum:
            - private
            - public_eligible
          example: private
        field_order:
          type: integer
          example: 1
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
      type: object
      additionalProperties: {}
    IntegrationLegacyQuickBooksFieldOption:
      description: >-
        Provider mapping option. Custom fields use
        CustomField.<definition_id>.<StringValue|BooleanValue|DateValue|NumberValue>.
        Group, parent_field, readonly and definition_id depend on the field.
      properties:
        field_key:
          type: string
          example: PrimaryEmailAddr.Address
        field_label:
          type: string
          example: Primary Email Address
        field_type:
          type: string
          example: email
        required:
          description: Enabled state.
          type: boolean
          example: false
        group:
          type: string
          example: Primary Email Address
        parent_field:
          type: string
          example: PrimaryEmailAddr
        readonly:
          description: Enabled state.
          type: boolean
          example: false
        definition_id:
          type: string
          example: '1'
      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.