| A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 | Workbook | RENXT_core_data_dictionary_v4_3.xlsx | ||||||||||||||||||||||||
6 | Scope | Core constituent-related tables, gifts, and opportunities based on public Blackbaud Raiser's Edge NXT SKY API product pages and entity documentation. | ||||||||||||||||||||||||
7 | Entity groups | Constituent, 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 note | This 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 | Generated | 2026-07-10 (v4.5) | ||||||||||||||||||||||||
10 | Source URL | https://developer.blackbaud.com/skyapi/products/renxt | ||||||||||||||||||||||||
11 | ||||||||||||||||||||||||||
12 | Key updates in v3 | |||||||||||||||||||||||||
13 | Action sheet | New entity sheet with 23 fields documenting category, status, dates, fundraisers, opportunity link, and audit timestamps from the Constituent API Action entity. | ||||||||||||||||||||||||
14 | Relationship sheet | New 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 sheet | New 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 sheet | New entity sheet with 26 fields including UK-specific fields (class_of_degree, department, faculty, registration_number, subject_of_study) and three FuzzyDate columns. | ||||||||||||||||||||||||
17 | EntityRelationships | Renamed from 'Relationships' (the FK map sheet). Eight new FK rows added linking Action, Relationship, Membership, and Education back to Constituent. | ||||||||||||||||||||||||
18 | SKYAPIEndpoints sheet | New reference sheet listing 34 REST endpoints (operations + code tables) across all four newly documented modules. | ||||||||||||||||||||||||
19 | BreakingChanges sheet | New 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.5 | |||||||||||||||||||||||||
22 | 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. | ||||||||||||||||||||||||
23 | 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). | ||||||||||||||||||||||||
24 | EntityRelationships (+11 FK rows) | New foreign-key relationships for all Prospect entities linking back to Constituent, User, ProspectFinancialDataType, and ProspectInformationSource. | ||||||||||||||||||||||||
25 | 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. | ||||||||||||||||||||||||
26 | No changes to prior sheets | All v4.5 additions are additive. Existing sheets, endpoints, and relationships from v4.4 are unchanged. | ||||||||||||||||||||||||
27 | #Appeal!A1 | |||||||||||||||||||||||||
28 | ||||||||||||||||||||||||||
29 | ||||||||||||||||||||||||||
30 | Key updates in v4.4 | |||||||||||||||||||||||||
31 | 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. | ||||||||||||||||||||||||
32 | PaymentConfiguration sheet (NEW) | 8 fields for the merchant account / payment configuration resource used to route transactions to a specific BBMS merchant account. | ||||||||||||||||||||||||
33 | SKYAPIEndpoints | Added 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). | ||||||||||||||||||||||||
34 | BreakingChanges | Added '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. | ||||||||||||||||||||||||
35 | No breaking changes to existing entities | All v4.4 updates are additive. Existing sheets, endpoints, and relationships are unchanged. | ||||||||||||||||||||||||
36 | #Appeal!A1 | |||||||||||||||||||||||||
37 | #VolunteerJob!A1 | |||||||||||||||||||||||||
38 | #VolunteerTimesheet!A1 | |||||||||||||||||||||||||
39 | #Relationships!A1 | |||||||||||||||||||||||||
40 | Key updates in v4.3 | |||||||||||||||||||||||||
41 | ⚠ 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. | ||||||||||||||||||||||||
42 | 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. | ||||||||||||||||||||||||
43 | Existing entity additions | Education: +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. | ||||||||||||||||||||||||
44 | 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. | ||||||||||||||||||||||||
45 | 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. | ||||||||||||||||||||||||
46 | Background process & Query v2 | Added Shared API background-process endpoints (GetBackgroundProcessResult, GetBackgroundProcessStatus) to SKYAPIEndpoints. Noted Query API v2 (GetQueryListV2) pagination change in BreakingChanges. | ||||||||||||||||||||||||
47 | Sources | RE NXT API Changelog, Blackbaud Community SKY Developer Announcements blog, June 2026 Product Update Briefing, bbdevdays 2026 announcements, Microsoft Learn connector references. | ||||||||||||||||||||||||
48 | #VolunteerAvailability!A1 | |||||||||||||||||||||||||
49 | Key updates in v4.2 | |||||||||||||||||||||||||
50 | 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. | ||||||||||||||||||||||||
51 | Alias | 4 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. | ||||||||||||||||||||||||
52 | CommunicationPreference | 5 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. | ||||||||||||||||||||||||
53 | ConstituentCode | 15 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. | ||||||||||||||||||||||||
54 | 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. | ||||||||||||||||||||||||
55 | Sheet ordering | Constituent sub-entities now flow: Address → EmailAddress → Phone → OnlinePresence → Alias → CommunicationPreference → ConstituentCode → ConstituentAttachment → Note → ConstituentCustomFields. ActionAttachment sits right after ActionCustomFields. | ||||||||||||||||||||||||
56 | #VolunteerJob!A1 | |||||||||||||||||||||||||
57 | Key updates in v4.1 | |||||||||||||||||||||||||
58 | Field coverage audit | Audited 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. | ||||||||||||||||||||||||
59 | Constituent sheet expanded | Grew 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. | ||||||||||||||||||||||||
60 | Sheets rebuilt | Constituent (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. | ||||||||||||||||||||||||
61 | Constituent type | Constituent sheet now merges Individual and Organization variants. Each row indicates 'Applies to: Individual only / Organization only / Individual + Organization' in the Lineage / Notes column. | ||||||||||||||||||||||||
62 | Schema sources | Microsoft Learn connector references: blackbaudraisersedge, blackbaudconstituent, blackbaudfundraising, blackbaudgifts. Membership API supplemented from Blackbaud community announcement posts. | ||||||||||||||||||||||||
63 | 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. | ||||||||||||||||||||||||
64 | #Appeal!A1 | |||||||||||||||||||||||||
65 | Key updates in v4 | |||||||||||||||||||||||||
66 | 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). | ||||||||||||||||||||||||
67 | Custom Fields scope | Only entities with documented SKY API custom field endpoints are included. Event, Membership, Education, and Relationship do NOT have custom field endpoints in SKY API. | ||||||||||||||||||||||||
68 | Custom Field API preview | Added rows in SKYAPIEndpoints for the new Custom Field API (Public Preview, April 2026) which manages custom field categories themselves at /customfield/v1/customfieldcategories. | ||||||||||||||||||||||||
69 | EntityRelationships | Added 7 FK rows linking each *CustomFields table back to its parent entity via parent_id. | ||||||||||||||||||||||||
70 | Sheet ordering | Custom Fields sheets are placed immediately after their parent entity sheet for logical browsing. | ||||||||||||||||||||||||
71 | #Appeal!A1 | |||||||||||||||||||||||||
72 | Sheets in this workbook | |||||||||||||||||||||||||
73 | Core constituent entity | Constituent, Address, EmailAddress, Phone, Note | ||||||||||||||||||||||||
74 | Constituent sub-entities (new in v3) | Action, Relationship, Membership, Education | ||||||||||||||||||||||||
75 | Fundraising fact tables | Gift, GiftSplit, GiftFundraiser, SoftCredit, Opportunity, OpportunityFundraiser | ||||||||||||||||||||||||
76 | Fundraising hierarchy | Campaign, Fund, Appeal | ||||||||||||||||||||||||
77 | Events | Event, EventParticipant, EventRegistrant | ||||||||||||||||||||||||
78 | Volunteers | Volunteer, VolunteerAssignment, VolunteerJob, VolunteerTimesheet, VolunteerAvailability, VolunteerEmergencyContact | ||||||||||||||||||||||||
79 | Custom Fields (new in v4) | ConstituentCustomFields, ActionCustomFields, GiftCustomFields, OpportunityCustomFields, CampaignCustomFields, FundCustomFields, AppealCustomFields | ||||||||||||||||||||||||
80 | Reference & metadata | EntityRelationships, FieldMapping, SKYAPIEndpoints, BreakingChanges | ||||||||||||||||||||||||
81 | #VolunteerJob!A1 | |||||||||||||||||||||||||
82 | #Relationships!A1 | |||||||||||||||||||||||||
83 | #FieldMapping!A1 | |||||||||||||||||||||||||
84 | #Event!A1 | |||||||||||||||||||||||||
85 | #EventParticipant!A1 | |||||||||||||||||||||||||
86 | #EventRegistrant!A1 | |||||||||||||||||||||||||
87 | #Volunteer!A1 | |||||||||||||||||||||||||
88 | #VolunteerAssignment!A1 | |||||||||||||||||||||||||
89 | #VolunteerJob!A1 | |||||||||||||||||||||||||
90 | #VolunteerTimesheet!A1 | |||||||||||||||||||||||||
91 | #VolunteerAvailability!A1 | |||||||||||||||||||||||||
92 | #VolunteerEmergencyContact!A1 | |||||||||||||||||||||||||
93 | ||||||||||||||||||||||||||
94 | ||||||||||||||||||||||||||
95 | ||||||||||||||||||||||||||
96 | ||||||||||||||||||||||||||
97 | ||||||||||||||||||||||||||
98 | ||||||||||||||||||||||||||
99 | ||||||||||||||||||||||||||
100 | ||||||||||||||||||||||||||