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

# Import donations

> Records up to 2,000 gifts at once, from rows you have read out of a spreadsheet. Every row is checked before any is written: if one is wrong, nothing is recorded and the answer lists every problem by line. Send `dry_run: true` first to see the same answer without recording anything. Donors are matched by email and campaigns by name, capitals ignored; an email or a campaign name that matches nothing is an error, and no person is created. A row whose `external_id` is already on one of your gifts is skipped. Without an `external_id` column there is nothing to recognize a repeat by, so importing the same rows twice records them twice. Imported gifts start no workflows. Needs **write** on Fundraising.



## OpenAPI

````yaml /api-reference/openapi.json post /api/fundraising/donations/import
openapi: 3.1.0
info:
  title: RescueConsole API
  version: '2026-09-19'
  description: >-
    Your own organization's records, from your own software. There is no
    sandbox: every request goes to your live organization.
servers:
  - url: https://{organization}.rescueconsole.com
    description: Your own organization's address, the one you sign in at.
    variables:
      organization:
        default: your-rescue
        description: >-
          The first part of the address you sign in at. A key only works at the
          address of the organization it was made in.
security:
  - apiKey: []
tags:
  - name: Animals
    description: The animals in your care, and the ones you have placed.
  - name: Animal notes
    description: Notes written on an animal's record.
  - name: Animal weights
    description: An animal's weight readings, one per weighing.
  - name: Animal medical records
    description: >-
      Vaccines, treatments, procedures, tests, exams and other medical records
      on one animal.
  - name: Animal placements
    description: The people an animal came from or has been placed with, over time.
  - name: Animal nutrition
    description: 'What an animal eats: its feeding list and its diet.'
  - name: Animal relationships
    description: Siblings, parents, offspring and bonded pairs.
  - name: Animal tags
    description: Your own short labels on an animal.
  - name: Breeds
    description: The breed or kind lists your intake form offers for each species.
  - name: Litters
    description: Litters, and the animals born into them.
  - name: Locations and housing
    description: >-
      The places animals are housed at each of your locations: campuses,
      buildings, rooms and cages, the tunnels that join cages into one space,
      and who is in each.
  - name: Foster homes
    description: >-
      The people who foster for you, what each home can take, and the animals
      offered to and placed with them.
  - name: Intakes
    description: >-
      How each animal arrived: the route in, who brought it, why it was given up
      and the state it came in.
  - name: Medical due
    description: >-
      Medical work that is outstanding across all your animals, and one medical
      record added to many animals at once.
  - name: Transports
    description: >-
      Transport runs: a chain of drives, each leg with its own driver, that
      moves animals from one place to another.
  - name: Animal calendar
    description: >-
      The dated things in animal care on one calendar: medical work due,
      adoptions, foster placements starting and ending, arrivals, and meet and
      greets.
  - name: Animal reports
    description: >-
      The operations report: intakes, outcomes, live release rate and the
      animals in your care, each figure with its own definition.
  - name: Adoption applications
    description: >-
      Applications to adopt or foster, from first draft to a decision, and the
      adoption contract signed on an approved one.
  - name: Adoptions
    description: >-
      Animals that went home, what each adopter owes and has paid, and closing
      or reversing the adoption.
  - name: Signed contracts
    description: >-
      Contracts signed on an adoption, a foster placement or an intake, each
      kept exactly as it read when it was signed.
  - name: Contract templates
    description: >-
      The contracts your organization has people sign, with the merge fields
      that fill them in.
  - name: Reconciliations
    description: >-
      A payment processor's settlement lines, matched against the adoption
      payments you recorded.
  - name: Animal custom fields
    description: >-
      The extra fields your organization adds to animals, housing units and
      adoption applications.
  - name: Age groups
    description: >-
      What counts as a baby, an adult or a senior, per species, which fee rules
      and discounts read.
  - name: Animal statuses
    description: >-
      Your organization's status vocabulary for animal records, and what kind of
      status each one is.
  - name: Application stages
    description: >-
      The steps an adoption or foster application moves through before it is
      decided, in your organization's words.
  - name: Behaviour attributes
    description: >-
      The catalogue of behavioural traits, and where a trait with each name may
      be shown beyond the record.
  - name: Cage card templates
    description: >-
      The layouts your organization prints for the kennel door: paper, fields,
      photo and QR code.
  - name: Adoption fee schedules
    description: >-
      The rules that suggest an animal's adoption fee, and the discounts laid
      over them.
  - name: Medical catalogue
    description: >-
      The diagnoses, tests, vaccines, treatments, procedures, conditions and
      medications your medical records pick from.
  - name: People
    description: >-
      The people your organization deals with: adopters, donors, volunteers,
      fosters and everybody else.
  - name: Person notes
    description: Notes written on a person's record.
  - name: Person contacts
    description: >-
      A person's phone numbers and email addresses, one of each kind marked
      primary.
  - name: Person addresses
    description: A person's addresses, one of them primary.
  - name: Person tags
    description: Free-text labels on a person, added and removed one at a time.
  - name: People duplicates
    description: People who look like the same person entered twice, and merging them.
  - name: People custom fields
    description: The fields a person's record carries beyond the standard ones.
  - name: Organizations
    description: >-
      The outside organizations your rescue deals with: veterinary practices,
      partner rescues, shelters, suppliers, employers and agencies.
  - name: Organization locations
    description: An organization's places, one of them the main one.
  - name: Affiliations
    description: >-
      Who works at, volunteers for or otherwise belongs to an organization, now
      or in the past.
  - name: Forms
    description: >-
      The forms your organization publishes, such as an adoption application or
      a volunteer sign-up, and the questions on them.
  - name: Submissions
    description: >-
      What people sent through your forms, and what your team does with each
      one.
  - name: Tasks
    description: >-
      To-dos, on a record or for the whole organization, narrowed to the records
      your key may read.
  - name: Calendar
    description: >-
      The dated work across your organization in one list, narrowed to the areas
      your key may read.
  - name: Activity
    description: >-
      What was created, changed and deleted in your organization, narrowed to
      the areas your key may read.
  - name: Shift schedules
    description: >-
      Schedules: the occasions shifts are grouped under, such as an adoption day
      or Saturday kennel cover.
  - name: Shift windows
    description: >-
      Shifts: a stretch of time at a place, with the volunteer roles it needs
      and how many of each (the address calls a shift a window).
  - name: Shift bookings
    description: >-
      Sign-ups: a person taking a role on a shift, giving it up, and the hours
      they worked.
  - name: Volunteers
    description: >-
      The people who volunteer: where each stands, what they have done, and
      where they would rather work.
  - name: Volunteer roles
    description: >-
      The jobs a volunteer can sign up for, such as Dog walker or Adoption
      counselor.
  - name: Volunteer qualifications
    description: 'Approvals: who may take which role, and at which location.'
  - name: Shift policies
    description: The rules you set for sign-ups and cancellations.
  - name: Shift calendar
    description: Schedules and shifts as calendar items for a date range.
  - name: Shift custom fields
    description: Your own fields on schedules, shifts and sign-ups.
  - name: Events
    description: >-
      The occasions your rescue hosts: adoption days, fundraisers, clinics and
      the rest.
  - name: Events calendar
    description: Your events between two days, as calendar entries.
  - name: Campaigns
    description: >-
      Appeals you raise money for, each with its goal and what it has raised so
      far.
  - name: Donations
    description: 'Gifts of money: how much, from whom, and what they were given to.'
  - name: Donors
    description: The people who have given, with what each has given in all.
  - name: Wish list
    description: The things your rescue needs, and the deliveries that met them.
  - name: Fundraising custom fields
    description: Your organization's own fields on donations and campaigns.
  - name: Message templates
    description: >-
      Saved wording your organization sends again and again, with merge fields
      filled from your records.
  - name: Sending
    description: >-
      Everything here sends real email from your organization, and none of it
      can be unsent.
  - name: Message log
    description: >-
      The email your organization has sent or tried to send, and what became of
      each message.
  - name: Conversations
    description: >-
      The email conversations in your organization's inboxes, and the records
      each one is about.
  - name: Inboxes
    description: >-
      The addresses your organization receives email at, and who may read each
      one.
  - name: Contact preferences
    description: >-
      Whether a person has asked not to be emailed, altogether or about one kind
      of message.
  - name: Suppressions
    description: >-
      Addresses no email goes to, because mail to them bounced or their owner
      asked not to be written to.
  - name: Sender and deliverability
    description: Who your organization's email goes out as, and how much of it arrives.
  - name: Registry flags
    description: >-
      Safety flags your organization files about a person or an animal, which
      other organizations using RescueConsole can see once the flag is vetted
      and shared.
  - name: Registry reviews
    description: >-
      Another organization's vote on a flag it did not file, which decides
      whether the flag becomes active or disputed.
  - name: Registry search
    description: >-
      The lookup by microchip number that anybody may make, with or without a
      key.
paths:
  /api/fundraising/donations/import:
    post:
      tags:
        - Donations
      summary: Import donations
      description: >-
        Records up to 2,000 gifts at once, from rows you have read out of a
        spreadsheet. Every row is checked before any is written: if one is
        wrong, nothing is recorded and the answer lists every problem by line.
        Send `dry_run: true` first to see the same answer without recording
        anything. Donors are matched by email and campaigns by name, capitals
        ignored; an email or a campaign name that matches nothing is an error,
        and no person is created. A row whose `external_id` is already on one of
        your gifts is skipped. Without an `external_id` column there is nothing
        to recognize a repeat by, so importing the same rows twice records them
        twice. Imported gifts start no workflows. Needs **write** on
        Fundraising.
      operationId: importDonations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DonationImportRequest'
            example:
              dry_run: true
              rows:
                - amount: 2500
                  donated_at: '2026-08-03'
                  donor_email: sam.okafor@contoso.com
                  campaign: Winter kennel appeal
                  payment_gateway: stripe
                  external_id: ch_3PzK8e2eZvKYlo2C1abc
                - amount: 10000
                  donated_at: '2026-08-05'
                  status: completed
      responses:
        '200':
          description: >-
            What was recorded, or on a dry run what would be. A dry run that
            finds problems still answers 200, with the problems in `errors`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DonationImportResult'
        '400':
          description: >-
            A body that is not a list of rows answers with an `error`. Rows with
            problems, when this is not a dry run, answer with the whole summary,
            its `errors` filled in and nothing recorded.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        type: string
                  - $ref: '#/components/schemas/DonationImportResult'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
components:
  schemas:
    DonationImportRequest:
      type: object
      required:
        - rows
      properties:
        rows:
          type: array
          minItems: 1
          maxItems: 2000
          description: >-
            One object per gift. Errors name the line as a spreadsheet would:
            the first row is line 2, after the header.
          items:
            $ref: '#/components/schemas/DonationImportRow'
        dry_run:
          type: boolean
          default: false
          description: Check the rows and say what would happen, recording nothing.
    DonationImportResult:
      type: object
      properties:
        dry_run:
          type: boolean
        total_rows:
          type: integer
        would_create:
          type: integer
          description: How many gifts the rows make, leaving out the skipped ones.
        created:
          type: integer
          description: >-
            How many were recorded. 0 on a dry run and whenever there are
            errors.
        skipped:
          type: array
          description: Rows whose `external_id` is already on one of your gifts.
          items:
            type: object
            properties:
              line:
                type: integer
              external_id:
                type: string
              reason:
                type: string
        errors:
          type: array
          items:
            type: object
            properties:
              line:
                type: integer
              message:
                type: string
        total_cents:
          type: integer
          description: The sum of the gifts the rows make, in whole cents.
        can_detect_duplicates:
          type: boolean
          description: >-
            Whether any row has an `external_id`. When false, importing the same
            rows again records them again.
        preview:
          type: array
          description: The first ten gifts the rows make.
          items:
            type: object
            properties:
              line:
                type: integer
              amount_cents:
                type: integer
                description: In whole cents.
              donated_at:
                type: string
              donor_email:
                type:
                  - string
                  - 'null'
              campaign:
                type:
                  - string
                  - 'null'
    DonationImportRow:
      type: object
      required:
        - amount
        - donated_at
      properties:
        amount:
          type: integer
          minimum: 1
          description: >-
            The amount in whole cents: 2500 is $25.00. A string, or a number
            with a fraction such as 25.5, is refused. Take care converting a
            spreadsheet's dollars: the JSON number 25.00 is the same as 25,
            which is 25 cents.
        donated_at:
          type: string
          description: >-
            The day of the gift, beginning YYYY-MM-DD. Anything after the date
            is dropped.
        donor_email:
          type: string
          description: >-
            The donor's email. Must match one of your people. Leave it out for
            an anonymous gift.
        campaign:
          type: string
          description: The campaign's name, as it is in RescueConsole.
        donation_type:
          $ref: '#/components/schemas/DonationType'
          default: one_time
        status:
          $ref: '#/components/schemas/DonationStatus'
          default: completed
        payment_gateway:
          type: string
          enum:
            - stripe
            - paypal
            - square
            - zelle
            - cashapp
            - venmo
            - other
        external_id:
          type: string
          description: >-
            Your payment processor's own ID for the gift. Kept in
            `gateway_reference.external_id`, and how a repeat is recognized.
        currency:
          type: string
          default: usd
    DonationType:
      type: string
      enum:
        - one_time
        - recurring
        - post_adoption_bump
        - upsell
    DonationStatus:
      type: string
      description: >-
        Only completed gifts count towards a campaign, a donor's giving or the
        donors list.
      enum:
        - pending
        - completed
        - failed
        - refunded
  responses:
    Problem:
      description: What is wrong, in one sentence you can show to a person.
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                type: string
          example:
            error: house_trained must be 1, 0 or null (not assessed)
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: An API key from Settings, API keys. It starts with rc_live_.

````