Reference overview

This section contains reference documentation generated directly from the akoyaGO managed solution in Dataverse.

Generated content

Entity reference pages in this section are regenerated from Dataverse metadata by the metadata generator (Phase 2 of the implementation plan). To add narrative context that survives regeneration, edit the override files under docs/overrides/entities/. Direct edits to reference/entities/*.md will be overwritten on the next regeneration.

Tables

Core integration entities (start here)

Logical name	Display name	Purpose
akoya_accountingsettings	Accounting Settings	Organization-level GL-account routing singleton. Read to learn the default GL accounts for gifts, grants, fees, interfund.
contact	Contact	Standard Dataverse; every person (donors, staff, applicants, advisors). akoyaGO extends with akoya_* columns.
akoya_donor	Donor	Donor/prospect lifecycle record. Links to one or two contacts; tracks giving history and cultivation stage.
akoya_fund	Fund	Pool of assets. Central accounting unit — gifts in, grants out, fees calculated against balances.
akoya_gift	Gift	Inbound donation, pledge, bequest, or interfund transfer. Central transactional entity.
akoya_giftpayment	Gift Payment	Payment execution for gifts (check, ACH, CC, stock). Primary entity for AP / ERP integrations.
akoya_request	Request	Grant or scholarship application. Lifecycle from intake through award.
akoya_requestpayment	Request Payment	Disbursement line or requirement attached to a request. Includes external AP-system integration IDs.

Supporting entities

Logical name	Display name	Purpose
akoya_account	GL Account	Chart-of-accounts entity. Not the same as standard account — see the naming-collision callout on the page.
akoya_CriteriaList	Criteria List	Named collection of segmentation criteria.
akoya_donoropportunities	Donor Opportunity	Cultivation pipeline record.
akoya_giftfee	Gift Fee	Reusable fee definition (flat/percent/both).
akoya_interfundgrants	Interfund Grant	Internal transfer between two funds (double-entry).
list	Marketing List	Standard Dataverse segmentation container; used for audience / segmentation sync.

Additional entities exist in the Akoyanet solution but are not currently documented — partners needing access to those should coordinate with the akoyaGO product team.

Global option sets

See Global option sets for choice lists shared across multiple tables.

Conventions used on entity pages

Every entity reference page follows the same structure:

1. At a glance — logical name, entity set name, ownership, change tracking status.
2. Web API — base URLs for the four primary HTTP verbs.
3. Attributes — custom columns with type, required level, constraints, and descriptions.
4. Lookups — quick reference — navigation property names for $expand, separate from the main attribute table.
5. Choice values — option-set labels and integer values.
6. Relationships — 1:N, N:1, and N:N with schema names and navigation properties.
7. Supported messages — Create / Retrieve / Update / Delete / Upsert / etc. akoyaGO entities do not use alternate keys; Upsert is documented as "use GET then PATCH" throughout.
8. Privileges — for sizing S2S security roles.
9. Examples — tabbed Web API and C# samples, including a find-then-update example.