> ## 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. # List organization recognition credits > Returns active soft credits with organization-bound donations, donor/type relations, designation and donor-name summaries, ordered newest first. date_from/date_to filter the donation’s creation date, not the credit date. pageIndex is one-based and at least1; pageSize is clamped1–100. Requires permission: one of donations, reports_view, reports_manage. ## OpenAPI ````yaml get /admin/soft-credits 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/soft-credits: get: tags: - Donations summary: List organization recognition credits description: >- Returns active soft credits with organization-bound donations, donor/type relations, designation and donor-name summaries, ordered newest first. date_from/date_to filter the donation’s creation date, not the credit date. pageIndex is one-based and at least1; pageSize is clamped1–100. Requires permission: one of donations, reports_view, reports_manage. operationId: reference_Admin_SoftCreditController_getClientSoftCredits parameters: - name: date_from in: query description: Optional donation creation-date lower bound. required: false schema: type: string format: date example: '2026-01-01' - name: date_to in: query description: >- Optional donation creation-date upper bound, inclusive through23:59:59. required: false schema: type: string format: date example: '2026-12-31' - name: pageIndex in: query description: One-based page index; values below1 become1. required: false schema: type: integer example: 1 - name: pageSize in: query description: Page size, clamped1–100. required: false schema: type: integer example: 10 responses: '200': description: Operation result. content: application/json: schema: properties: soft_credits: type: array items: $ref: '#/components/schemas/DonationSoftCredit' total_count: type: integer example: 25 page_index: type: integer example: 1 page_size: type: integer example: 10 total_pages: type: integer example: 3 status: type: string example: success 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. '422': description: Request validation failed. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] servers: - url: https://api.gratona.com/v1 description: Gratona API components: schemas: DonationSoftCredit: properties: id: type: integer example: 42 client_id: type: integer example: 12 donation_id: type: integer example: 84 donor_id: type: integer example: 21 amount: description: >- Stored recognition amount; database serialization may return a decimal string. anyOf: - type: number example: 25 - type: string example: '25.00' soft_credit_type_id: type: integer example: 2 notes: type: string example: Recognized for the community introduction. nullable: true relationship_role_override: type: string enum: - relationship_giving - influence_only - recognition_only - excluded - null example: recognition_only nullable: true relationship_role_context: type: object nullable: true additionalProperties: true created_at: type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true updated_at: type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true deleted_at: type: string format: date-time nullable: true donor: description: Recognition donor relation, including archived donors. oneOf: - $ref: '#/components/schemas/Donor' - type: string enum: - null nullable: true soft_credit_type: $ref: '#/components/schemas/DonationSoftCreditType' donation: $ref: '#/components/schemas/Donation' designation: description: Designation resolver output on the organization-wide list. anyOf: - type: object additionalProperties: true - type: array items: type: object additionalProperties: true maxItems: 0 donor_name: properties: id: type: integer example: 21 hysform_id: anyOf: - type: integer example: 1 - type: string example: '' name: type: string example: Jane Donor email: type: string example: jane@example.org type: object additionalProperties: true type: object additionalProperties: true 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 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 Donor: title: Donor description: >- A donor record. Donors give one-time donations and recurring commitments, and may be linked to entities (recipients) via sponsorships. Standardized profile columns (first_name, phone, address, etc.) coexist with arbitrary custom fields stored in `json_fields` and defined per `hysform_id`. The `username`/`email`/`password` columns also let donors sign in to the donor portal. required: - id - client_id properties: id: description: Internal donor ID. type: integer format: int64 example: 12345 client_id: description: >- Owning Gratona client (multi-tenant scope). All donor queries MUST filter by this. type: integer format: int64 example: 207 hysform_id: description: >- HysForm that defines this donor's profile fields (custom + standardized) — controls which keys appear in `json_fields`. type: integer format: int64 example: 42 nullable: true donorprogram_id: description: >- Program the donor signed up under, if applicable. Mostly informational. type: integer format: int64 example: 11 nullable: true household_id: description: >- Household this donor is linked to, when joint giving / partner records are tracked together. type: integer format: int64 example: 88 nullable: true type: description: >- Canonical donor identity type is INDIVIDUAL or ORGANIZATION. Compatibility serializers/callers may retain the lower-case aliases. type: string enum: - INDIVIDUAL - ORGANIZATION - individual - organization - null example: INDIVIDUAL nullable: true username: description: >- Login username for the donor portal. Must be unique across donors when set. type: string example: janedoe nullable: true email: description: Donor email — used for receipts, statements, and donor-portal login. type: string format: email example: jane@example.com nullable: true organization_name: description: >- For `type=organization` donors. Standardized field; mirrored in `json_fields.organization` for legacy clients. type: string example: Acme Foundation nullable: true first_name: description: Donor first / given name. Standardized field. type: string example: Jane nullable: true last_name: description: Donor last / family name. Standardized field. type: string example: Doe nullable: true preferred_contact_method: description: How the donor prefers to be contacted. type: string enum: - email - phone - sms - mail - null example: email nullable: true phone: description: Phone number as entered by the user (display format). type: string example: (555) 123-4567 nullable: true phone_e164: description: >- Phone normalized to E.164 for SMS/dialing. Populated by the phone normalization pipeline. type: string example: '+15551234567' nullable: true can_receive_sms: description: Whether SMS opt-in is granted for this donor. type: boolean example: true street: description: Street address line 1 (standardized). type: string example: 123 Main St nullable: true address_line2: description: Street address line 2 (apartment, unit, suite). type: string example: Apt 4B nullable: true city: description: City. type: string example: Springfield nullable: true state: description: State / region (free-form display value). type: string example: IL nullable: true zip: description: Postal / ZIP code. type: string example: '62704' nullable: true country: description: Country display name. type: string example: United States nullable: true country_code: description: ISO 3166-1 alpha-2 country code. type: string example: US nullable: true subdivision_code: description: ISO 3166-2 country subdivision code. type: string example: US-IL nullable: true json_fields: description: >- Custom profile/record fields. Raw model responses retain the encoded JSON string; projection endpoints may return a decoded map or list. Use the record form definition to interpret field keys. anyOf: - type: string nullable: true - type: object additionalProperties: true - type: array items: {} year_to_date: description: >- Cached YTD giving totals (per year and per program), refreshed by background jobs. type: object nullable: true additionalProperties: true has_artifacts: description: Whether the donor has any uploads/photos attached. type: boolean example: false batch_id: description: >- Set when the donor was created via a CSV import batch; ties together donors imported in the same run. type: integer format: int64 example: null nullable: true created_at: type: string format: date-time example: '2025-03-15T19:42:00Z' updated_at: type: string format: date-time example: '2026-01-02T08:11:00Z' deleted_at: description: >- Soft-delete timestamp; donors with a non-null value are excluded from default queries. type: string format: date-time example: null nullable: true type: object DonationSoftCreditType: properties: id: type: integer example: 2 key: type: string example: in_honor_of name: type: string example: In Honor Of description: type: string example: Recognition for a gift. nullable: true active: description: Saved type activation flag. anyOf: - type: boolean example: true - type: integer example: 1 type: object additionalProperties: true Donation: title: Donation description: >- An individual donation transaction. Donations may be one-time or part of a recurring `Commitment`. Despite the name, the `designation` column actually stores the recipient `entity_id` (it predates entities and was never renamed). Tax/refund/QuickBooks state lives on the donation row alongside the gateway transaction id. required: - id - client_id - donor_id - amount - currency properties: id: description: Internal donation ID. type: integer format: int64 example: 983221 client_id: description: Owning Gratona client (multi-tenant scope). type: integer format: int64 example: 207 donor_id: description: Donor who gave this donation. type: integer format: int64 example: 12345 designation: description: >- Recipient entity ID — see `Entity` schema. Historical naming: this is NOT an accounting designation, it is the entity / sponsorship target. Null for unrestricted gifts. type: integer format: int64 example: 4711 nullable: true type: description: >- Donation type code (gateway / source family). Internal enum; values include cash, check, credit card, ACH, in-kind, etc. type: integer example: 1 method: description: >- Payment method code: 1=cash, 2=check, 3=Stripe, 6=PayPal, 8=Stripe-Connect, 9=Flutterwave, 10=Flutterwave-standard, 11=QPayPro, 12=ACH-direct-debit, 13=in-kind. See `config/constants.php` for canonical mapping. type: integer example: 3 nullable: true frequency: description: >- Recurrence cadence: 1=every-month, 2=every-3-months, 3=every-6-months, 4=every-year, 5=one-time, 6=bi-weekly, 7=every-2-months. type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - null example: 5 nullable: true one_time: description: >- True for one-off gifts; false when the donation is part of a recurring commitment. type: boolean example: true duration: description: Optional end date for time-bounded recurring donations. type: string format: date example: '2027-01-15' nullable: true amount: description: >- Persisted donation-line allocation, including any donor-covered processing fee. Existing amounts are preserved. type: number format: float example: 51.5 processing_fee: description: >- Total allocated collection cost in processor_fee_currency: Stripe processing fee plus any Connect platform fee. Eligible fee-free cash/check records return zero; unverified fees remain null. type: number format: float example: 2 nullable: true platform_fee: description: >- Connect application fee breakdown already included in processing_fee. Do not subtract it again from net. Display only when positive. type: number format: float example: 0.5 nullable: true amount_excluding_fee: description: >- Net amount after the inclusive processing_fee, in processor_fee_currency. Original Stripe settlement net, or gross for eligible fee-free cash/check records. Stable compatibility key; later refunds are separate. type: number format: float example: 49.5 nullable: true processor_net_amount: description: Same original settlement net as amount_excluding_fee. type: number format: float example: 49.5 nullable: true processor_fee_currency: description: >- Currency of actual fee and net amounts: Stripe settlement currency (which may differ from donation currency), or donation currency for eligible fee-free cash/check records. type: string example: USD nullable: true donor_covered_fee: description: >- Donor's optional added contribution in the original donation currency, separate from actual gateway expense. type: number format: float example: 1.5 nullable: true processing_fee_known: description: >- Whether valid original Stripe settlement evidence or an eligible fee-free cash/check record establishes fee and net amounts. type: boolean example: true actual_charged_amount: description: >- Total amount the gateway captured for the payment. Shared charges repeat this total on each allocation; it is not a per-line fee. type: number format: float example: 103 nullable: true currency: description: ISO 4217 currency code. type: string example: USD in_kind_category: description: Set only when `method` is in-kind (13). type: string enum: - stocks - goods - services - cryptocurrency - other - null example: goods nullable: true result: description: >- Free-form gateway result (e.g. successful, failed, pending). Gateway-specific values are common. type: string example: successful nullable: true transaction_id: description: >- External payment-gateway transaction ID (Stripe charge id, PayPal capture id, etc.). type: string example: ch_3OqXXXXX nullable: true transaction_status: description: External gateway status string. type: string example: succeeded nullable: true refunded: description: True if the donation has been at least partially refunded. type: boolean example: false refunded_amount: description: Amount refunded so far (in `currency`). type: number format: float example: 0 nullable: true refundable: description: >- Whether the gateway integration believes this donation can still be refunded. type: boolean example: true is_tax_deductible: description: Whether the donation is reportable as tax-deductible giving. type: boolean example: true tags: description: Free-form donor / admin tags. type: array items: type: string example: - matching-gift - year-end nullable: true notes: description: Plaintext notes attached to the donation (memo line, admin remarks). type: string example: 'Memo: in honor of John Doe' nullable: true quickbooks_receipt_id: description: QuickBooks receipt id, if synced. type: string example: qbo_5512 nullable: true receipt_sent_at: description: When the donation receipt email was last sent (null if never). type: string format: date-time example: '2026-01-02T08:30:00Z' nullable: true acknowledged_at: description: >- When this gift was acknowledged for stewardship tracking. Null means pending acknowledgement. type: string format: date-time example: '2026-01-03T10:15:00Z' nullable: true acknowledged_by_user_id: description: Admin user who last acknowledged the gift, when known. type: integer format: int64 example: 42 nullable: true acknowledgement_source: description: How the gift was acknowledged. type: string enum: - manual - auto_email - receipt - mailing - interaction - import - null example: manual nullable: true acknowledgement_context_json: description: >- Lightweight acknowledgement metadata such as note, previous state, or receipt context. type: object nullable: true additionalProperties: true json_fields: description: >- Custom profile/record fields. Raw model responses retain the encoded JSON string; projection endpoints may return a decoded map or list. Use the record form definition to interpret field keys. anyOf: - type: string nullable: true - type: object additionalProperties: true - type: array items: {} batch_id: description: Set when imported via CSV; groups donations imported together. type: integer format: int64 example: null nullable: true is_csv_import: description: >- True when the row was created from a CSV import (vs. live gateway charge). type: boolean example: false created_at: type: string format: date-time example: '2026-01-02T08:25:00Z' updated_at: type: string format: date-time example: '2026-01-02T08:30:00Z' deleted_at: type: string format: date-time example: null 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 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.