ABCDEFGHIJKLMNOPQRSTUVWXYZ
1
2
Blackbaud Raiser's Edge NXT – Core Data Dictionary
3
Spreadsheet dictionary for constituent-related tables, gifts, opportunities, events, volunteers, and constituent sub-entities (Action, Relationship, Membership, Education).
4
5
WorkbookRENXT_core_data_dictionary_v4_3.xlsx
6
ScopeCore constituent-related tables, gifts, and opportunities based on public Blackbaud Raiser's Edge NXT SKY API product pages and entity documentation.
7
Entity groupsConstituent, Address, EmailAddress, Phone, Note, Gift, GiftSplit, GiftFundraiser, SoftCredit, Opportunity, OpportunityFundraiser, Campaign, Fund, Appeal, Action, Relationship, Membership, Education, Event, EventParticipant, EventRegistrant, Volunteer, VolunteerAssignment, VolunteerJob, VolunteerTimesheet, VolunteerAvailability, VolunteerEmergencyContact
8
Modeling noteThis workbook is an ERD-style analytical data dictionary. The Action, Relationship, Membership, and Education sheets were rebuilt against the current SKY API documentation (Constituent API v1 and Membership API v1, post 2025-03-10 endpoint change). The EntityRelationships sheet (formerly 'Relationships') summarizes how every child entity links to Constituent for relational reporting.
9
Generated2026-08-19 (v4.9)
10
Source URLhttps://developer.blackbaud.com/skyapi/products/renxt
11
12
Key updates in v3
13
Action sheetNew entity sheet with 23 fields documenting category, status, dates, fundraisers, opportunity link, and audit timestamps from the Constituent API Action entity.
14
Relationship sheetNew entity sheet with 23 fields documenting type, reciprocal_type, FuzzyDate start/end, head-of-household and organization-contact flags, and the reciprocal_relationship_id self-reference.
15
Membership sheetNew entity sheet with 21 fields (category/subcategory/program/reason flattened to value+legacy_id pairs). Endpoint paths reflect the 2025-03-10 breaking change that removed '/skyapi/' from Membership API paths.
16
Education sheetNew entity sheet with 26 fields including UK-specific fields (class_of_degree, department, faculty, registration_number, subject_of_study) and three FuzzyDate columns.
17
EntityRelationshipsRenamed from 'Relationships' (the FK map sheet). Eight new FK rows added linking Action, Relationship, Membership, and Education back to Constituent.
18
SKYAPIEndpoints sheetNew reference sheet listing 34 REST endpoints (operations + code tables) across all four newly documented modules.
19
BreakingChanges sheetNew sheet documenting the Membership API '/skyapi/' path removal (announced 2025-02-25, effective 2025-03-10) and confirming no breaking changes for the other three modules.
20
#GiftSplit!A1
21
Key updates in v4.9
22
Membership sheet — rewritten to real SKY schema
Renamed to MembershipDetails field names, added last_renewed_date, last_dropped_date, next_renewal_date, total_years, times_renewed, consec_years, and — the previously-missing — `type` (MembershipType: Joined | Renewal | Rejoined | Upgrade | Downgrade | Dropped).
23
New sheet: MembershipSummary
Current-state read model. Includes the previously-missing **`standing`** field (MembershipStanding: New | Active | Lapsed | Dropped) plus custom_membership_id, expires_on_date, and primary/secondary member IDs & names.
24
New sheet: MembershipTransaction
Row-per-event history from MembershipHistory. Where the 'Transaction Type' properly lives, plus activity_date, category snapshot, reason, comment, and linked gifts[].
25
New sheet: MembershipGiftTransactionGift junction — transaction_gift_id, gift_id, applied_amount for split-gift scenarios.
26
New sheet: MembershipEnums
Reference sheet for MembershipType, MembershipStanding, RenewalType, RejoinType, and 5 other membership-area enums with allowed values and semantics.
27
SKYAPIEndpoints — Membership rebuilt (+40 operations)
All prior Membership rows deleted and replaced with the 40 operations from the live Membership API. Corrects stale verbs (Renew was GET, is POST) and duplicated preview rows.
28
Follow-up scheduled — v4.10 audit
Wider audit of remaining core entity sheets (Constituent, Gift, Opportunity, Action, Relationship, Event, Volunteer, Prospect*, Payment*) against live SKY schemas.
29
Key updates in v4.8
30
Opportunity sheet (+1 field)date_rated (July 31, 2026) — captures when the opportunity's rating was set. Available on get, create, and edit.
31
Opportunity API — DeleteOpportunity endpoint
New DELETE opportunities/{opportunity_id}. Destructive; no soft-delete counterpart. Added to SKYAPIEndpoints.
32
PaymentTransaction sheet (+3 fields)
related_transactions[] (July 28), gateway_result object, and gateway_result.message (August 13). related_transactions is only populated by GetTransaction; gateway_result appears only for direct-debit-return transactions.
33
PaymentConfiguration sheet (+2 fields)
applicationId (August 4) — required when custom fee configuration applies. billing_phone (August 4) — behavior fix so the value consistently flows into the checkout-complete global event payload.
34
WebhookEvent sheet (+1 event)
com.blackbaud.payments.transaction.directdebit.finalized.v1 (July 28). Payload includes id + status (succeeded | failed).
35
SKYAPIEndpoints (+4 rows)1 Opportunity delete + 2 Payments field changes on GetTransaction + 1 OAuth authorization-code-flow behavior row (environment_id / consent skip, July 28).
36
OAuth authorization-code flow (behavior change)
environment_id parameter on /authorization lets already-consented users skip the SKY consent screen for up to 60 days from their original grant. Store environment_id from the token response and pass it on subsequent authorization requests.
37
Key updates in v4.7
38
Prospect API — ID translation (+2 endpoints)
GetProspectIdByConstituentId and GetConstituentIdByProspectId (Public Preview, July 21, 2026). Lets integrations move between the constituent identifier space and the prospect identifier space.
39
Query API — SingleRow result layout
New `result_layout` property on query create/edit (MultiRow | SingleRow). Adds `child_selects`, `node_type` metadata, GET /v2/queries. SingleRow queries return one row per base record with related data flattened into columns — web view equivalent of database view Export. Backfilled from the June 15 announcement (edited July 14).
40
SKYAPIEndpoints (+4 rows)2 Prospect ID translation + 1 Query V2 list + 1 Query result_layout create/edit note.
41
Key updates in v4.6
42
Opportunity sheet (+6 fields)Added summary, reason, original_ask_amount, original_ask_date, instrument, org_contact_id (announced June 24, 2026).
43
OpportunityNote sheet (NEW)9 fields modeling the OpportunityNote object. 4 CRUD endpoints added to SKYAPIEndpoints. Blog did not publish full schema — inferred fields flagged in lineage.
44
GiftNote sheet (NEW)9 fields modeling the Gift V2 API note object. 5 CRUD endpoints (Public Preview) added.
45
PaymentDisbursement + PaymentDisbursementTransaction sheets (NEW)
Reconciliation entities for the BBMS disbursement flow. ListDisbursement and ListDisbursementTransactions endpoints released May 29, 2026 (preview ended).
46
WebhookEvent sheet (NEW)Catalogs Blackbaud CloudEvents-style webhook event types. Three new Opportunity events added June 25, 2026.
47
Query Metadata V2 endpoints (+6)
Public Preview of /v2/ metadata endpoints; both V1 and V2 now expose node_type and node_path properties for tree navigation.
48
SKYAPIEndpoints (+20 rows)4 OpportunityNote + 5 GiftNote + 2 Payments Disbursement + 6 Query Metadata V2 + 3 Webhook events.
49
EntityRelationships (+8 FK rows)
New FKs for OpportunityNote, GiftNote, PaymentDisbursement, PaymentDisbursementTransaction, plus Opportunity.org_contact_id.
50
Key updates in v4.5
51
Prospect API sheets (10 NEW)Added complete Prospect API coverage that was missing in v4.4 and earlier: ProspectClassification, ProspectFinancialDataAsset, ProspectFinancialDataSummary, ProspectFinancialDataType, ProspectInformationSource, ProspectGivingPreferences, ProspectContributionSummary, ProspectOtherGift, ProspectStatus, ProspectStatusHistory.
52
SKYAPIEndpoints (+18 rows)All 18 Prospect API operations added: 2 ProspectClassification, 1 summary + 2 code-table lookups, 4 FinancialDataAsset CRUD, 3 Giving (preferences, contributions, other-gifts), 3 Status (get/patch/list-histories), 3 direct StatusHistory (get/patch/delete).
53
EntityRelationships (+11 FK rows)
New foreign-key relationships for all Prospect entities linking back to Constituent, User, ProspectFinancialDataType, and ProspectInformationSource.
54
BreakingChanges section'Missing API Added (v4.5)' section covers the naming inconsistency in ProspectStatusHistory (read: status_description vs write: status), the FuzzyDate composite type used across Prospect endpoints, and ethical-AI/wealth-scoring implications of will_not_give_to and info_source_id.
55
No changes to prior sheetsAll v4.5 additions are additive. Existing sheets, endpoints, and relationships from v4.4 are unchanged.
56
#Appeal!A1
57
#VolunteerJob!A1
58
#VolunteerTimesheet!A1
59
Key updates in v4.4
60
PaymentTransaction sheet (NEW)
17 fields modeling the TransactionRead object returned by Payments API checkout, capture, refund, and get endpoints. Includes the new reference_transaction_id field (added June 2026) that links related transactions (refunds → charges, captures → authorizations) for easier reconciliation.
61
PaymentConfiguration sheet (NEW)
8 fields for the merchant account / payment configuration resource used to route transactions to a specific BBMS merchant account.
62
SKYAPIEndpointsAdded 8 rows: 7 Payments API endpoints (checkout public-key, payment-configurations, checkout transaction GET/POST, capture, refund, get transaction) and 1 Query API 'Available field search' endpoint (Public Preview).
63
BreakingChangesAdded 'New APIs & Field Additions (v4.4)' section documenting Payments API release, reference_transaction_id addition to TransactionRead, Query available-field-search preview, and new SKY Add-in surfaces for Campaign/Funds/Appeal tabs.
64
No breaking changes to existing entities
All v4.4 updates are additive. Existing sheets, endpoints, and relationships are unchanged.
65
#Appeal!A1
66
#VolunteerJob!A1
67
#VolunteerTimesheet!A1
68
#Relationships!A1
69
Key updates in v4.3
70
⚠ Volunteer API breaking changes
Effective 2026-04-23, four Volunteer endpoints have breaking changes: GetJobById (category and volunteer_type changed from integer ID to string description), GetVolunteerAssignments (start_date/end_date now reflect assignment dates; new job_start_date/job_end_date fields), GetJobVolunteersByJobId (id clarified as assignment ID; new constituent_id, start_date, end_date fields), GetVolunteerEmergencyContact (now returns 200 with empty body instead of 404 when no contact data exists). Full details in BreakingChanges sheet.
71
Membership API — 14 new endpoints
Public-preview endpoints added for lifecycle management (Renewal, Upgrade, Downgrade, Drop, Rejoin), membership cards (Get/Edit/Delete card), custom fields (Edit/Delete), fundraisers (Add/Delete), gift of membership (Edit), and delete membership. New MembershipCard sheet added (9 fields). Endpoint URLs in SKYAPIEndpoints; request body schemas not yet published.
72
Existing entity additionsEducation: +import_id, +notes (5 endpoints affected). Opportunity: +likelihood (Create/Edit), +gift_type (Get/Create/Edit/List). Gift: documentation note clarifying date vs date_added semantics for batch-approved gifts.
73
New API: Gift Aid (UK)Added GiftAidDeclaration sheet (16 fields) for UK tax declaration management. Includes constituent_id, declaration_starts/ends/made, declaration_indicator, declaration_source, confirmation_sent/returned, constituent_pays_tax, tax_payer_status, tax_notes, sequence. Gift Aid claim endpoint schema not yet published.
74
New APIs: Planned Gift Suite (Public Preview)
Added 5 placeholder sheets for the Gift V2 Planned Gift suite: PlannedGift, PlannedGiftAsset, PlannedGiftBeneficiary, PlannedGiftRelationship, RealizedRevenueGift. Endpoints inferred from June 2026 announcement; field schemas pending publication. Watch SKY Developer Announcements for updates.
75
Background process & Query v2Added Shared API background-process endpoints (GetBackgroundProcessResult, GetBackgroundProcessStatus) to SKYAPIEndpoints. Noted Query API v2 (GetQueryListV2) pagination change in BreakingChanges.
76
SourcesRE NXT API Changelog, Blackbaud Community SKY Developer Announcements blog, June 2026 Product Update Briefing, bbdevdays 2026 announcements, Microsoft Learn connector references.
77
#VolunteerAvailability!A1
78
Key updates in v4.2
79
New entity sheets (5)Added Alias, CommunicationPreference, ConstituentCode, ConstituentAttachment, ActionAttachment. All are peer entities to Address/EmailAddress/Phone/OnlinePresence (one-to-many under Constituent), except ActionAttachment which is one-to-many under Action.
80
Alias4 fields: id, constituent_id, name (free-text up to 100 chars — not split first/middle/last), type (logical FK to alias type list). PATCH does not include constituent_id.
81
CommunicationPreference5 fields covering /communicationpreferences endpoints. IMPORTANT: these endpoints are solicit-code-only (e.g. 'Do Not Solicit', 'No Email') and are flagged for deprecation. Full channel-level consent (channel, consent_statement, consent_source, response_date) uses /constituents/{id}/consents — added as a supplementary row in SKYAPIEndpoints.
82
ConstituentCode15 fields including the code value (description), sequence (1 = primary), and fuzzy-date start/end. The description field CANNOT be changed via PATCH — delete and recreate to change the code value.
83
Attachment (split into two)ConstituentAttachment (13 fields) and ActionAttachment (12 fields) share the same shape but have different parents. Both support type='Physical' (uploaded file via CreateDocument) or 'Link' (external URL). ActionAttachment PATCH body allows changing parent_id and type, unlike ConstituentAttachment.
84
Sheet orderingConstituent sub-entities now flow: Address → EmailAddress → Phone → OnlinePresence → Alias → CommunicationPreference → ConstituentCode → ConstituentAttachment → Note → ConstituentCustomFields. ActionAttachment sits right after ActionCustomFields.
85
#VolunteerJob!A1
86
Key updates in v4.1
87
Field coverage auditAudited every primary entity sheet against the official POST request body schema. Previous sheets were built from a high-level summary view and were missing many fields the API actually accepts.
88
Constituent sheet expandedGrew from 12 fields to 69 fields. Now includes birthplace, gender, former_name, marital_status, preferred_name, middle, ethnicity, religion, income, title/suffix 1 & 2, gives_anonymously, fuzzy date_of_birth (day/month/year), primary_addressee and primary_salutation (with custom_format / configuration_id / formatted_name), requests_no_email, is_solicitor, no_valid_address, target, receipt_type, is_memorial, matching_gift_factor, num_employees, plus all matching-gift min/max fields for organizations.
89
Sheets rebuiltConstituent (69), Action (20), Gift (36), Opportunity (19), Campaign (12), Fund (15), Appeal (15), Event (16), Membership (16), Education (30), Relationship (21). 269 total field rows across 11 entities.
90
Constituent typeConstituent sheet now merges Individual and Organization variants. Each row indicates 'Applies to: Individual only / Organization only / Individual + Organization' in the Lineage / Notes column.
91
Schema sourcesMicrosoft Learn connector references: blackbaudraisersedge, blackbaudconstituent, blackbaudfundraising, blackbaudgifts. Membership API supplemented from Blackbaud community announcement posts.
92
OnlinePresence sheet (post-v4.1 add)
Added OnlinePresence sheet with 8 fields (id, constituent_id, type, address, primary, inactive, date_added, date_modified) parallel to Address, EmailAddress, and Phone. Added 6 OnlinePresence REST endpoints to SKYAPIEndpoints and 1 FK row to EntityRelationships.
93
#Appeal!A1
94
Key updates in v4
95
Custom Fields sheets (7)Added ConstituentCustomFields, ActionCustomFields, GiftCustomFields, OpportunityCustomFields, CampaignCustomFields, FundCustomFields, AppealCustomFields. Each documents the shared 9-field schema (id, parent_id, category, type, value, date, comment, date_added, date_modified).
96
Custom Fields scopeOnly entities with documented SKY API custom field endpoints are included. Event, Membership, Education, and Relationship do NOT have custom field endpoints in SKY API.
97
Custom Field API previewAdded rows in SKYAPIEndpoints for the new Custom Field API (Public Preview, April 2026) which manages custom field categories themselves at /customfield/v1/customfieldcategories.
98
EntityRelationshipsAdded 7 FK rows linking each *CustomFields table back to its parent entity via parent_id.
99
Sheet orderingCustom Fields sheets are placed immediately after their parent entity sheet for logical browsing.
100
#Appeal!A1