Skip to main content

Data Model

Introduction​

This article introduces the objects (record types) that Dryad Receipting uses in Salesforce, and the role each one plays in turning gifts into receipts. Some are objects the app adds. Others are standard Salesforce and NPSP objects, such as Account, Contact, Opportunity, Payment and Recurring Donation, that the app adds fields to.

Each object has its own article that describes its fields. The ideas behind them (receipt types, eligibility, tax rules, numbering and so on) are explained in the Core Concepts article. The organization-wide settings are described in the Receipt Settings article.

The Core Objects​

Receipt​

The issued receipt, acknowledgment or giving summary itself. It records who the receipt is for, the amounts, the charity that issued it, the templates used, and how far it has got in delivery. The app creates it from one or more gifts and copies the gift's values onto it at that moment. A receipt is never edited after it's issued. It is voided and replaced instead.

Receipt Item​

One line on a consolidated receipt or giving summary. When a receipt covers several gifts, each gift gets its own Receipt Item, and the template can print them as a table.

Receipt Installment​

The link between a receipt and each Opportunity, Payment or Recurring Donation it covers. Installments show which gifts a receipt covers, and which receipts a gift has had.

Opportunity​

The NPSP record for a donation, and the starting point for every receipt unless your org receipts by payment. The fields Dryad Receipting adds work out whether the gift can be receipted, how much can be receipted, and which template to use. They also hold any overrides for this gift, and a link to the last receipt the gift received.

Payment​

The NPSP record for one payment on a donation. When Enable Receipt by Payment is on, each payment is receipted on its own, and the fields Dryad Receipting adds play the same role as on the Opportunity.

Recurring Donation​

The NPSP record for a recurring gift, whose installments are Opportunities. The fields Dryad Receipting adds control receipting for the whole recurring donation. Its gifts are normally receipted together on a consolidated receipt.

Account​

Accounts play two roles. Organization donors keep their receipt preferences on the Account: email or mail, one receipt per gift or consolidated, language, and whether to receipt them at all. A few Accounts may be Receipting Accounts: other registered charities that you issue receipts for, with their own registration number, logo, signature, templates and numbering.

Contact​

For gifts from a household, the donor is the gift's primary contact. The fields Dryad Receipting adds to Contacts hold that person's receipt preferences, and the result of checking their email address.

Receipt Template​

The design of the receipt .pdf: a page layout with merge fields that are filled in with the receipt's values. Templates are edited in the template editor and chosen in Receipt Settings, on Receipting Accounts, or on individual gifts.

Receipt Field Mapping​

Controls which values are copied from the gift onto a new receipt or receipt item. Each mapping says "copy this field from the Opportunity, Payment or Recurring Donation onto this receipt field". A standard set is installed with the app, covering the donor, the amounts and the chosen templates, and admins can add their own on the field mapping settings pages.

Batch Receipt Log​

A record of one background job: creating receipts, creating .pdfs, merging, emailing, or building a preview report. It shows what the job is doing, how far it has got, and any errors. Records the job works on are stamped with the log's ID, which is how the app later finds the receipts from a given batch.

Batch Receipt Log Segment​

One part of a "Create .pdfs" job. A large run is split into segments that create .pdfs at the same time. Each segment records its own progress and errors, and its Batch Receipt Log adds them up.

Email​

Used only with Dryad Mailer (Amazon SES). One send of receipt emails to a group of recipients, created when receipts are emailed in a batch.

Email Recipient​

Used only with Dryad Mailer. One record for each receipt in a send, tracking whether that email was sent, delivered and opened.

Email Event​

Used only with Dryad Mailer. A record of something Amazon SES reported about an email (sent, delivered, opened, bounced or complaint). Each event updates the matching Email Recipient.

Content Version​

The standard Salesforce record behind each file. Receipt .pdfs are stored as files attached to the receipt, and the field Dryad Receipting adds holds a download link used when many .pdfs are merged into one file for printing.

External File​

A receipt .pdf stored in Amazon S3 instead of as a Salesforce file. This storage option is currently switched off. The object is kept for organizations that used it in the past.