Javadocs

The DonorPoint Javadoc reference documents every entity, field, and service in the platform. It is the authoritative source for field names, entity relationships, and the complete data model.

DonorPoint Javadocs → https://docs.donorpoint.com/javadoc

What the Javadocs Cover

  • Every record type (entity) in DonorPoint with all its fields and their data types
  • Entity relationships — what each record links to and owns
  • Service classes — the operations available on each record type
  • API endpoints — the REST paths available for each entity
  • Field-level documentation including allowed values, constraints, and descriptions

Using the Javadocs

The Javadocs are most useful when:

  • Writing scripts or expressions and you need to know an exact field name (for example, contact.firstName, purchaseOrder.amount, recurringDonationInstance.status)
  • Designing a report query and need to know what fields are available on a record type
  • Integrating with the REST API and need to understand the response structure for a given entity
  • Building an event handler and need to know what properties are accessible on the triggered record

System Names vs. Display Names

DonorPoint uses plain-English labels in the admin interface, but the underlying system names (used in scripts, expressions, and the API) sometimes differ. Key examples:

What You See in the Admin System Name
Form / Page / Campaign campaign
Transaction purchaseOrder
Recurring Donation recurringDonationInstance
Volunteer Record volunteerInstance
Segment contactGroup

When in doubt, the Javadocs show the system name you need to use.