Getting Started

This page provides a guide to Establishing a Connection to BlackBaud Raiser's Edge NXT in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to BlackBaud Raiser's Edge NXT

Establishing a Connection shows how to authenticate to BlackBaud Raiser's Edge NXT and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from BlackBaud Raiser's Edge NXT through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to BlackBaud Raiser's Edge NXT by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to BlackBaud Raiser's Edge NXT

Before establishing a connection, supply the SubscriptionKey, found in the BlackBaud Raiser's Edge NXT Profile.

Authenticating to BlackBaud Raiser's Edge NXT

BlackBaud Raiser's Edge NXT provides embedded OAuth credentials that simplify connection from a Desktop application . To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

To connect from all authentication flows, you must:

set AuthScheme to OAuth
set the SubscriptionKey to your Subscription Key
enable BlackBaud Raiser's Edge NXT on an authorization account to retrieve results

The following subsections describe how to authenticate to BlackBaud Raiser's Edge NXT from all available OAuth flows. For information about how to create a custom OAuth application to connect via the Web, see Creating a Custom OAuth Application. For a complete list of connection string properties available in BlackBaud Raiser's Edge NXT, see Connection.

Web Applications

When connecting via a Web application, you must create and register a custom OAuth application with BlackBaud Raiser's Edge NXT. You can then use the Cloud to acquire and manage the OAuth token values. For information about how to create a custom OAuth application and set it up so that it connects properly to your BlackBaud Raiser's Edge NXT environment, see Creating a Custom OAuth Application.

Get an OAuth Access Token

To obtain the OAuthAccessToken, set these properties:

OAuthClientId: The Client Id specified in your custom OAuth application settings.
OAuthClientSecret: The Client Secret specified in your custom OAuth application settings.

Then call stored procedures to complete the OAuth exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified when you configured your custom OAuth application. If necessary, set the Permissions parameter to request custom permissions. The stored procedure returns the URL to the OAuth endpoint.
Navigate to the URL that the stored procedure returned in Step 1. Log in to the custom OAuth application and authorize the web application. Once the application has been authenticated, the browser redirects you to the callback URL.
Call the GetOAuthAccessToken stored procedure. Set AuthMode to WEB and the Verifier input to the "code" parameter in the query string of the callback URL. If necessary, set the Permissions parameter to request custom permissions.

To connect to data, set the OAuthAccessToken connection property to the access token returned by the stored procedure. When the access token expires after ExpiresIn seconds, call GetOAuthAccessToken again to obtain a new access token.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you must authenticate on another device that has an internet browser.

Choose one of the following options:
- Option 1: Obtain the OAuthVerifier value as described in Obtain and Exchange a Verifier Code, below.
- Option 2: Install the Cloud on a machine with an Internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in Option 2: Transfer OAuth Settings, below.
Then configure the Cloud to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an Internet browser and obtain the OAuthVerifier connection property.

Choose one of these options:
- If you are using the Embedded OAuth Application click BlackBaud Raiser's Edge NXT OAuth endpoint to open the endpoint in your browser.
- If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
  - InitiateOAuth: Set to OFF.
  - OAuthClientId: Set to the client Id specified in your custom OAuth application.
  - OAuthClientSecret: Set to the client secret specified in your custom OAuth application.
  Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
Log in and grant permissions to the Cloud. You are then redirected to the callback URL, which contains the verifier code.
Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, you must exchange the OAuth verifier code for OAuth refresh and access tokens.

On the headless machine, to obtain the OAuth authentication values, set these connection properties:

InitiateOAuth: REFRESH.
OAuthVerifier: The verifier code.
OAuthSettingsLocation: Persist the encrypted OAuth authentication values to the specified location.
Custom applications only:
- OAuthClientId: The Client Id specified in your custom OAuth application settings.
- OAuthClientSecret: The Client Secret specified in your custom OAuth application settings.

After the OAuth settings file is generated, you must re-set the following properties to connect:

InitiateOAuth: REFRESH.
OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the Cloud to enable the automatic refreshing of the access token.
Custom applications only:
- OAuthClientId: The client Id specified in your custom OAuth application settings.
- OAuthClientSecret: The client secret specified in your custom OAuth application settings.

Option 2: Transfer OAuth Settings

Before you can connect on a headless machine, you need to create and install a connection with the driver on a device that supports an Internet browser. Set the connection properties as described in Desktop Applications, above.

After completing the instructions in Desktop Applications, the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine, then set the following connection properties to connect to data:

InitiateOAuth: REFRESH.
OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the Cloud to enable the automatic refreshing of the access token.
Custom applications only:
- OAuthClientId: The client Id specified in your custom OAuth application settings.
- OAuthClientSecret: The client secret specified in your custom OAuth application settings.

Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to BlackBaud Raiser's Edge NXT via a desktop application or a headless machine.

However, you must create a custom OAuth application to connect to BlackBaud Raiser's Edge NXT via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.

Custom OAuth applications are useful if you want to:

control branding of the authentication dialog;
control the redirect URI that the application redirects the user to after the user authenticates; or
customize the permissions that you are requesting from the user.

The following sections desribe how to create and register a custom OAuth application, and how to connect it to your BlackBaud Raiser's Edge NXT environment.

Create and Register the Custom Application

To create an application to obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret:

Go to BlackBaud Sign Up.
Set up a developer account and get a subscription key, as described in the BlackBaud Getting Started documentation.
Log in at https://app.blackbaud.com/subscriptions.
To request a subscription to an API, select SKY API Standard Edition.
Select Subscribe. A confirmation screen appears.
To submit your request, select Confirm.

BlackBaud sends an email notification when your request is approved. After it is approved, you can view the subscription key within your developer profile.

To register the custom OAuth application:

From My Applications (see https://developer.blackbaud.com/apps), select Register app.
Enter your application details, including the redirect URI:
- For Desktop applications, use http://localhost:33333 or another port of your choice.
- For Web applications, use a URL where you want users to land after granting access to your custom application.
Click Save. Your application details are now available in the Blackbaud Marketplace.

Connect the Custom Application to Your Environment

Once the new application is configured and registered in the Blackbaud Marketplace, an environment administrator must connect it to the environment where it will be used.

They should:

Navigate to the Blackbaud Marketplace at https://app.blackbaud.com/marketplace/.
Visit the Manage page.
Select Connect app and specify the application ID of the custom OAuth application that was just created.
Select Connect.

The new application displays on the Manage page.

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to BlackBaud Raiser's Edge NXT APIs.

Key Features

The Cloud models BlackBaud Raiser's Edge NXT entities like documents, folders, and groups as relational views, allowing you to write SQL to query BlackBaud Raiser's Edge NXT data.
Stored procedures allow you to execute operations to BlackBaud Raiser's Edge NXT.
Live connectivity to these objects means any changes to your BlackBaud Raiser's Edge NXT account are immediately reflected when using the Cloud.

Views

Views describes the available views. Views are statically defined to model Actions, Emails, Events, etc..

Stored Procedures

Stored Procedures are function-like interfaces to BlackBaud Raiser's Edge NXT. Stored procedures allow you to execute operations to BlackBaud Raiser's Edge NXT, including downloading documents and moving envelopes.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Blackbaud Raisers Edge NXT Views


Name	Description
ActionAttachments	Retrieves a list of attachments for an action.
ActionCustomFields	Retrieves custom fields for an action
Actions	Retrieves a list of actions for all constituents and for specified constituent and details of the specified action.
Addresses	Addresses store information about constituent residences and other addresses along with information about where or whether to send mail
Aliases	Retrieves a list of aliases for a constituent
AppealAttachments	Returns a list of attachments for an appeal.
CampaignAttachments	Returns a list of attachments for a campaign.
Campaigns	Campaigns are your organization's overall fundraising efforts or initiatives, such as operating expenses, new buildings, and endowments
ConsentCategories	Returns a list of consent categories.
ConsentChannelCategories	Returns a list of valid consent channel category combinations.
ConsentChannels	Represents the consent channel entity
ConsentSources	Represents the consent source entity
ConstituentAppeals	Returns a list of appeals for a constituent.
ConstituentAttachments	Returns a list of attachments for a constituent.
ConstituentCodes	Constituent codes define the high-level affiliations between constituents and your organization - such as Board member, Vendor, and Volunteer - to provide context for why constituents are in the database
ConstituentConsents	Returns a list of constituent consent records.
ConstituentFundraiserAssignments	Returns a list of fundraiser assignments for a constituent.
Constituents	Returns a paginated list of constituents
ConstituentsCustomFields	Retrieves custom fields for all constituents
ConstituentSolicitCodes	Returns a list of solicit codes for the specified constituent.
Countries	Returns the list of available countries.
Educations	Returns a list of educations for all constituent or a specified constituent
Emails	Returns a list of email addresses of all constituents or a specified constituent
EventCategories	Returns a list of active event categories.
EventFees	Returns a list of fees for an event.
EventParticipantGuests	The participant's basic summary information
EventParticipantMemberships	The individual's membership category
EventParticipantOptions	Returns the participant options for an event.
EventParticipants	Returns a list of participants for an event.
Events	Returns a list of events
FundAttachments	Returns a list of attachments for a fund.
FundraiserAssignments	Returns a list of assignments for a fundraiser.
FundraiserGoals	Returns a list of goals for a fundraiser
FundraisingAppeals	Returns a list of fundraising appeals.
Funds	Returns a list of funds.
GiftAcknowledgements	Returns a list of acknowledgements for a gift
GiftAttachments	Returns a list of attachments for a gift.
GiftBatches	Returns a list of gift batches.
GiftPayments	Returns payments for a gift.
GiftReceipts	Returns receipts for a gift.
Gifts	Returns a paginated list of gifts
GiftsCustomFields	Retrieves custom fields for all gifts
GiftSoftCredits	Returns soft credits for a gift.
GiftSplits	Returns the splits for a gift.
Giving	Returns the first, latest or greatest gift recorded for a constituent.
GivingAppeals	Returns the giving appeals summary for the constituent
GivingCampaigns	Returns the giving campaigns summary for the constituent
GivingFunds	Returns the giving funds summary for the constituent
LifetimeGiving	Returns the lifetime giving information for a constituent.
Lists	Returns a list of lists for the given list type
Members	Returns the list of members.
Memberships	Returns a list of memberships.
Notes	Returns a list of notes that tracks helpful or important details such as specific interests and special instructions for donations
OnlinePresences	Returns a paginated list of online presences that store a constituent's social media accounts, websites.
Opportunities	Retrieves a list of opportunities
OpportunitiesCustomFields	Retrieves custom fields for an opportunity
OpportunityAttachments	Returns a list of attachments for an opportunity
Packages	Returns a list of packages that contains content and other items for the appeals that organizations use to solicit gifts
ParticipantFeePayments	Returns the fee payments for a participant.
ParticipantFees	Returns a list of fees for a participant.
ParticipantLevels	Returns a list of participation levels for all events.
ParticipantOptions	Returns the participant options for a participant.
Phones	Returns a list of phones for all constituents or a specific constituent
RatingCategories	Returns a list of all available rating categories.
Ratings	Returns a list of ratings for a constituent.
RatingSources	Returns a list of all available rating sources.
Relationships	Returns a list of relationships between constituents and other individuals and organizations such as family, friends, and employers

ActionAttachments

Retrieves a list of attachments for an action.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ActionId is required in order to query ActionAttachments.

ActionId supports the '=' operator.

For example:

	SELECT * FROM ActionAttachments WHERE ActionId = '335'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the attachment.
ActionId	String	Actions.Id	The immutable system record ID of the action this attachment is associated to.
ContentType	String		The content type. For physical attachments only.
Date	Datetime		The date of the attachment.
FileId	String		The identifier of the file.
FileName	String		The file name.
FileSize	Integer		The file size in bytes.
Name	String		The name of the attachment.
ParentId	String		The parent object's immutable system record ID.
Tags	String		The parent object's immutable system record ID.
ThumbnailId	String		The identifier of the thumbnail.
ThumbnailUrl	String		The URL for a thumbnail.
Type	String		The attachment type.
Url	String		The URL for the attachment.

ActionCustomFields

Retrieves custom fields for an action

Columns


Name	Type	References	Description
Id	String		The immutable system record ID of the custom field.
ActionId	String		The parent object's immutable system record ID.
Value	String		The value of the custom field.
Date	Datetime		The date on the custom field.
Category	String		The category on the custom field.
Commment	String		The date when the custom field was created.
Type	String		The type of data that the custom field represents.

Actions

Retrieves a list of actions for all constituents and for specified constituent and details of the specified action.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=' operator.
ComputedStatus supports the '=' operator.
ConstituentId supports the '=' operator.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
StatusCode supports the '=,in' operators.

For example:

	
	SELECT * FROM Actions WHERE ConstituentId = '280'
	
	SELECT * FROM Actions WHERE ComputedStatus = 'Completed'
	
	SELECT * FROM Actions WHERE DateAdded >= '2010-06-01 14:03:35'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the action.
Category	String		The channel or intent of the constituent interaction.
Completed	Boolean		Indicates whether the action is complete.
CompletedDate	Datetime		The date when the action was completed.
ComputedStatus	String		The computed action status. The allowed values are Open, Completed, PastDue.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the action.
Date	Date		The action date.
DateAdded	Datetime		The date when the action was created.
DateModified	Datetime		The date when the action was last modified.
Description	String		The detailed explanation that elaborates on the action summary.
Direction	String		The direction of the action.
EndTime	String		The end time of the action.
Fundraisers	String		The set of immutable constituent system record IDs for the fundraisers associated with the action.
Location	String		The location of the action.
OpportunityId	String	Opportunities.Id	The immutable system record ID of the opportunity associated with the action.
Outcome	String		The outcome of the action. Available values are Successful and Unsuccessful.
Priority	String		The priority of the action.
StartTime	String		The start time of the action.
Status	String		The action status.
StatusCode	String		The action status code. This property is only returned when the system is configured to use custom action statuses. The allowed values are Closed, Completed, Pending, Not Completed, Open, Sent, Continuous.
Summary	String		The short description of the action that appears at the top of the record.
Type	String		Additional description of the action to complement the category.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ListId	String		Defines a list identifier used to filter the set of actions to those included in the specified list. If this value is set, other specified filters will be ignored.

Addresses

Addresses store information about constituent residences and other addresses along with information about where or whether to send mail

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=' operator.
ConstituentId supports the '=' operator.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
IncludeInactive supports the '=' operator.

For example:

	
	SELECT * FROM Addresses WHERE ConstituentId = '280'
	
	SELECT * FROM Addresses WHERE DateModified >= '2010-06-01 14:03:35'
	
	SELECT * FROM Addresses WHERE IncludeInactive = true

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the address.
AddressLines	String		The address lines.
City	String		The city of the address.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the address.
Country	String		The country of the address.
County	String		The county of the address.
DateAdded	Datetime		The date when the address was created.
DateModified	Datetime		The date when the address was last modified.
DoNotMail	Boolean		Indicates whether the constituent requests not to be contacted at this address.
End	Datetime		The date when the constituent ceased to reside at this address.
FormattedAddress	String		The date when the constituent ceased to reside at this address.
Inactive	Boolean		This computed field indicates that the address is active if the current date is before any end date.
PostalCode	String		The postal code of the address.
Preferred	Boolean		Indicates whether this is the constituent's preferred address.
SeasonalEndD	Integer		The day of the year ceases to reside at this address.
SeasonalEndM	Integer		The month of the year ceases to reside at this address.
SeasonalEndY	Integer		The year ceases to reside at this address.
SeasonalStartD	Integer		The day of year that the constituent begins residing at this address.
SeasonalStartM	Integer		The month of year that the constituent begins residing at this address.
SeasonalStartY	Integer		The year that the constituent begins residing at this address.
Start	Datetime		The date when the constituent began residing at this address.
State	String		The state of the address.
Suburb	String		The suburb of the address.
Type	String		The address type.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive addresses in the result.

Aliases

Retrieves a list of aliases for a constituent

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ConstituentId is required in order to query Aliases.

ConstituentId supports the '=' operator.

For example:

	SELECT * FROM Aliases WHERE ConstituentId = '280'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the alias.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the alias.
Name	String		The name to use as the constituent's alias.
Type	String		The alias type.

AppealAttachments

Returns a list of attachments for an appeal.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: AppealId is required in order to query AppealAttachments.

AppealId supports the '=' operator.

For example:

	SELECT * FROM AppealAttachments WHERE AppealId = '2'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the attachment.
AppealId	String	FundraisingAppeals.Id	The immutable system record ID of the appeal.
ContentType	String		The content type. For physical attachments only.
Date	Datetime		The date of the attachment.
FileId	String		The identifier of the file.
FileName	String		The file name.
FileSize	Integer		The file size in bytes.
Name	String		The name of the attachment.
ParentId	String		The parent object's immutable system record ID.
Tags	String		The tags associated with the attachment.
ThumbnailId	String		The identifier of the thumbnail.
ThumbnailUrl	String		The URL for a thumbnail.
Type	String		The attachment type.
Url	String		The URL for the attachment.

CampaignAttachments

Returns a list of attachments for a campaign.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: CampaignId is required in order to query CampaignAttachments.

CampaignId supports the '=' operator.

For example:

	SELECT * FROM CampaignAttachments WHERE CampaignId = '2'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the attachment.
CampaignId	String	Campaigns.Id	The immutable system record ID of the campaign.
ContentType	String		The content type. For physical attachments only.
Date	Datetime		The date of the attachment.
FileId	String		The identifier of the file.
FileName	String		The file name.
FileSize	Integer		The file size in bytes.
Name	String		The name of the attachment.
ParentId	String		The parent object's immutable system record ID.
Tags	String		The tags associated with the attachment.
ThumbnailId	String		The identifier of the thumbnail.
ThumbnailUrl	String		The URL for a thumbnail.
Type	String		The attachment type.
Url	String		The URL for the attachment.

Campaigns

Campaigns are your organization's overall fundraising efforts or initiatives, such as operating expenses, new buildings, and endowments

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=' operator.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
IncludeInactive supports the '=' operators.

For example:

	
	SELECT * FROM Campaigns WHERE DateModified >= '2010-06-01 14:03:35'
	
	SELECT * FROM Campaigns WHERE IncludeInactive = true

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the campaign.
Category	String		The category of the campaign.
DateAdded	Datetime		The date when the campaign was created.
DateModified	Datetime		The date when the campaign was last modified.
Description	String		The display name of the campaign.
EndDate	Datetime		The end date of the campaign.
GoalValue	Double		The monetary goal associated with the campaign.
Inactive	Boolean		This computed field indicates that the campaign is active if the current date is after any start_date and before any end_date.
LookupId	String		The user-defined identifier for the campaign.
StartDate	Datetime		The start date of the campaign.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive campaigns in the result.

ConsentCategories

Returns a list of consent categories.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

IncludeInactive supports the '=' operator.

For example:

	
	SELECT * FROM ConsentCategories WHERE IncludeInactive = true

Columns


Name	Type	References	Description
Description	String		The name of the consent category.
Inactive	Boolean		Indicates whether the consent category is inactive.
Sequence	Integer		The placement of the category in the order of category table values, if defined.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive consent categories in the result.

ConsentChannelCategories

Returns a list of valid consent channel category combinations.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Columns


Name	Type	References	Description
Category	String		The name of the category included in the channel/category combination.
Channel	String		The name of the channel included in the channel/category combination.
Sequence	Integer		The placement of the channel/category in the order of channel/category table values, if defined.

ConsentChannels

Represents the consent channel entity

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Columns


Name	Type	References	Description
Description	String		The name of the consent channel.

ConsentSources

Represents the consent source entity

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

IncludeInactive supports the '=' operator.

For example:

	
	SELECT * FROM ConsentSources WHERE IncludeInactive = true

Columns


Name	Type	References	Description
Description	String		The name of the consent source.
Inactive	Boolean		Indicates whether the consent source is inactive.
Sequence	Integer		The placement of the source in the order of source table values, if defined.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive consent sources in the result.

ConstituentAppeals

Returns a list of appeals for a constituent.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

ConstituentId supports the '=' operator.

For example:

	
	SELECT * FROM ConstituentAppeals WHERE ConstituentId = '280'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID.
AppealCategoryDescription	String		The appeal category description.
AppealCategoryId	String		The immutable system record ID of the appeal category.
AppealCategoryInactive	Boolean		Indicates whether the appeal category is inactive.
AppealDescription	String		The appeal description.
AppealId	String		The immutable system record ID of the appeal.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent the appeal is associated to.
Date	Datetime		The date when the appeal was added.
PackageDescription	String		The package description.
PackageId	String		The package Id.

ConstituentAttachments

Returns a list of attachments for a constituent.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ConstituentId is required in order to query ConstituentAttachments.

ConstituentId supports the '=' operator.

For example:

	SELECT * FROM ConstituentAttachments WHERE ConstituentId = '280'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the attachment.
ConstituentId	String		The immutable system record ID of the constituent associated with the attachment.
ContentType	String		The content type.
Date	Datetime		The date of the attachment.
FileId	String		The identifier of the file.
FileName	String		The file name.
FileSize	Integer		The file size in bytes.
Name	String		The name of the attachment.
ParentId	String		The parent object's immutable system record ID.
Tags	String		The tags associated with the attachment.
Type	String		The attachment type.
Url	String		The URL for the attachment.

ConstituentCodes

Constituent codes define the high-level affiliations between constituents and your organization - such as Board member, Vendor, and Volunteer - to provide context for why constituents are in the database

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=' operator.
ConstituentId supports the '=' operator.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
IncludeInactive supports the '=' operator.

For example:

	
	SELECT * FROM ConstituentCodes WHERE Id = '144'

	SELECT * FROM ConstituentCodes WHERE ConstituentId = '280'
	
	SELECT * FROM ConstituentCodes WHERE DateAdded >= '1999-10-26T15:45:27'
	
	SELECT * FROM ConstituentCodes WHERE DateModified >= '1999-10-26T15:45:27'
	
	SELECT * FROM ConstituentCodes WHERE IncludeInactive = true

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the constituent code.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the constituent code.
DateAdded	Datetime		The date when the constituent code was created.
DateModified	Datetime		The date when the constituent code was last modified.
Description	String		The description of the constituent code.
Inactive	Boolean		This computed field indicates that the constituent code is active if the current date is after any start date and before any end date.
StartD	Integer		The start day of the constituent code.
StartM	Integer		The start month of the constituent code.
StartY	Integer		The start year of the constituent code.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		This computed field indicates that the constituent code is active if the current date is after any start date and before any end date.

ConstituentConsents

Returns a list of constituent consent records.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ConstituentId is required in order to query ConstituentConsents.

ConstituentId supports the '=' operator.
Category supports the '=,in' operators.
Channel supports the '=,in' operators.
MostRecentOnly supports the '=' operator.

For example:

	
	SELECT * FROM ConstituentConsents WHERE ConstituentId = '280'
	
	SELECT * FROM ConstituentConsents WHERE ConstituentId = '280' AND Channel IN ('Phone', 'Email')
	
	SELECT * FROM ConstituentConsents WHERE ConstituentId = '280' AND Category IN ('Fundraising', 'Newsletter')

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the consent record.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent the consent is associated to.
Category	String		The category that the consent response applies to.
Channel	String		The channel that the consent response applies to.
ConsentDate	Datetime		The date the consent response was received.
ConsentStatement	String		The statement the constituent responded to when providing consent.
ConstituentConsentResponse	String		How the constituent responded to consent for the specified channel/category.
DateAdded	Datetime		The date the consent response was added.
PrivacyNotice	String		The privacy notice provided to the constituent.
Source	String		The source of the consent response from the constituent.
UserName	String		The user that added the consent response.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
MostRecentOnly	Boolean		If set to true, includes inactive constituent consents in the result.

ConstituentFundraiserAssignments

Returns a list of fundraiser assignments for a constituent.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ConstituentId is required in order to query ConstituentFundraiserAssignments.

ConstituentId supports the '=' operator.
IncludeInactive supports the '=' operator.

For example:

	SELECT * FROM ConstituentFundraiserAssignments WHERE ConstituentId = '280'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the fundraiser assignment.
AmountValue	Double		The goal amount for the fundraiser to solicit from the assigned constituent.
AppealId	String	FundraisingAppeals.Id	The immutable system record ID of the appeal the fundraiser should use to request gifts.
CampaignId	String	Campaigns.Id	The immutable system record ID of the campaign to apply resulting gifts to.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent to apply resulting gifts to.
End	Datetime		The fundraiser assignment end date.
FundId	String	Funds.Id	The immutable system record ID of the fund any resulting gifts should be applied to.
FundraiserId	String		The immutable system record ID of the fundraiser.
Start	Datetime		The fundraiser assignment start date.
Type	String		The type of fundraiser.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive assignments in the result.

Constituents

Returns a paginated list of constituents

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=,in' operators.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
FundraiserStatus supports the '=,in' operators.
ConstituentCode supports the '=' operator.
CustomFieldCategory supports the '=' operator.
Fields supports the '=,in' operators.
IncludeDeceased supports the '=' operator.
ListId supports the '=' operator.
IncludeInactive supports the '=' operator.
PostalCode supports the '=,in' operators.

For example:

	
	SELECT * FROM Constituents WHERE Id = '280'
	
	SELECT * FROM Constituents WHERE ListId = '75e71c26-7288-49db-a767-f9305b704fee'
	
	SELECT * FROM Constituents WHERE FundraiserStatus IN ('Active', 'None')

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID for the constituent.
AddressLines	String		The address lines.
AddressCity	String		The city of the address.
AddressConstituentId	String		The immutable system record ID of the constituent associated with the address.
AddressCountry	String		The country of the address.
AddressCounty	String		The county of the address.
AddressDateAdded	Datetime		The date when the address was created.
AddressDateModified	Datetime		The date when the address was last modified.
AddressDoNotMail	Boolean		Indicates whether the constituent requests not to be contacted at this address.
AddressEnd	Datetime		The date when the constituent ceased to reside at this address.
AddressFormattedAddress	String		This computed field retrieves the formatted address in the configured format of the country.
AddressId	String		The immutable system record ID of the address.
AddressInactive	Boolean		This computed field indicates that the address is active if the current date is before any end date.
AddressPostalCode	String		The postal code of the address.
AddressPreferred	Boolean		Indicates whether this is the constituent's preferred address.
AddressSeasonalEndD	Integer		The day of the year ceases to reside at this address.
AddressSeasonalEndM	Integer		The month of the year ceases to reside at this address.
AddressSeasonalEndY	Integer		The year ceases to reside at this address.
AddressSeasonalStartD	Integer		The day of year that the constituent begins residing at this address.
AddressSeasonalStartM	Integer		The month of year that the constituent begins residing at this address.
AddressSeasonalStarty	Integer		The year that the constituent begins residing at this address.
AddressStart	Date		The date when the constituent began residing at this address.
AddressState	String		The state of the address.
AddressSuburb	String		The suburb of the address.
AddressType	String		The address type.
Age	Integer		This computed field calculates the constituent's age based on the birth date property.
BirthdateD	Integer		The constituent's day of birth.
BirthdateM	Integer		The constituent's month of birth.
BirthdateY	Integer		The constituent's year of birth.
DateAdded	Datetime		The date when the constituent was created.
DateModified	Datetime		The date when the constituent was last modified.
Deceased	String		Indicates whether the constituent is deceased.
DeceasedDateD	Integer		The day of the year when the constituent died.
DeceasedDateM	Integer		The month of year when the constituent died.
DeceasedDateY	Integer		The year when the constituent died.
EmailAddress	String		The email address.
EmailConstituentId	String		The immutable system record ID of the constituent associated with the email address.
EmailDateAdded	Datetime		The date when the email address was created.
EmailDateModified	Datetime		The date when the email address was last modified.
EmailDoNotEmail	Boolean		Indicates whether the constituent requests not to be contacted at this email address.
EmailId	String		The immutable system record ID of the email address.
EmailInactive	Boolean		Indicates whether the email address is inactive.
EmailPrimary	Boolean		Indicates whether this is the constituent's primary email address.
EmailType	String		The type of email address. Available values are the entries in the Phone Types table.
First	String		The constituent's first name.
FormerName	String		The constituent's former name.
FundraiserStatus	String		Indicates whether the constituent is a fundraiser.
Gender	String		The constituent's gender.
GivesAnonymously	Boolean		Indicates whether the constituent gives anonymously.
Inactive	Boolean		Indicates whether the constituent is inactive.
Last	String		The constituent's last name.
LookupId	String		The user-defined identifier for the constituent.
MaritalStatus	String		The constituent's marital status.
Middle	String		The constituent's middle name.
Name	String		If the constituent's type is Individual, this is the full name of the constituent. If the type is Organization, this is the organization's name.
OnlinePresenceAddress	String		The web address for the online presence.
OnlinePresenceConstituentId	String		The immutable system record ID of the constituent associated with the online presence.
OnlinePresenceDateAdded	Datetime		The date when the online presence was created.
OnlinePresenceDateModified	Datetime		The date when the online presence was last modified.
OnlinePresenceId	String		The immutable system record ID of the online presence.
OnlinePresenceInactive	Boolean		Indicates whether the online presence is inactive.
OnlinePresencePrimary	Boolean		Indicates whether this is the constituent's primary online presence.
OnlinePresenceType	String		The online presence type.
PhoneConstituentId	String		The immutable system record ID of the constituent associated with the phone.
PhoneDateAdded	Datetime		The date when the phone was created.
PhoneDateModified	Datetime		The date when the phone was last modified.
PhoneDoNotCall	Boolean		Indicates whether the constituent requests not to be contacted at this number.
PhoneId	String		The immutable system record ID of the phone.
PhoneInactive	Boolean		Indicates whether the phone is inactive.
PhoneNumber	String		The phone number.
PhonePrimary	Boolean		Indicates whether this is the constituent's primary phone.
PhoneType	String		The phone type.
PreferredName	String		The constituent's preferred name.
SpouseFirst	String		This computed field retrieves information about the constituent's spouse using the constituent's relationships.
SpouseId	String		This computed field retrieves information about the constituent's spouse using the constituent's relationships.
SpouseLast	String		This computed field retrieves information about the constituent's spouse using the constituent's relationships.
Suffix	String		The constituent's primary suffix.
Suffix2	String		The constituent's secondary suffix.
Title	String		The constituent's primary title.
Title2	String		The constituent's secondary title.
Type	String		The type of constituent.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ConstituentCode	String		Represents a list of constituent codes. Returns constituents if any of the specified constituent codes match any of their active constituent codes.
CustomFieldCategory	String		Represents a list of custom field categories. Returns constituents if any of the specified custom field categories match any of their active custom fields.
Fields	String		Represents the fields to include on the returned records.
IncludeDeceased	Boolean		Set this parameter to true to include deceased constituents in the response.
IncludeInactive	Boolean		Set this parameter to true to include inactive constituents in the response.
ListId	String		Defines a list identifier used to filter the set of constituents to those included in the specified list. If this value is set, other specified filters will be ignored.
PostalCode	String		Represents a comma-separated list of postal codes. Returns constituents if any of the specified postal codes match the postal code for their preferred address.

ConstituentsCustomFields

Retrieves custom fields for all constituents

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Columns


Name	Type	References	Description
Id	String		The immutable system record ID of the custom field.
ConstituentId	String		The parent object's immutable system record ID.
Name	String		The custom field category.
Value	String		The value of the custom field.
Comment	String		The comment on the custom field.
DateAdded	Datetime		The date when the custom field was created.
DateModified	Datetime		The date when the custom field was last modified.
Type	String		The type of data that the custom field represents.

ConstituentSolicitCodes

Returns a list of solicit codes for the specified constituent.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ConstituentId is required in order to query ConstituentSolicitCodes.

ConstituentId supports the '=' operator.

For example:

 
	SELECT * FROM ConstituentSolicitCodes WHERE ConstituentId = '280'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the constituent solicit code.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the solicit code.
EndDate	Datetime		The end date of the solicit code.
SolicitCode	String		Communication instructions and/or restrictions for a constituent.
StartDate	Datetime		The start date of the solicit code.

Countries

Returns the list of available countries.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the country.
Abbreviation	String		The user-defined abbreviation for the country.
Name	String		The country name.

Educations

Returns a list of educations for all constituent or a specified constituent

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=' operator.
ConstituentId supports the '=' operator.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.

For example:

	
	SELECT * FROM Educations WHERE ConstituentId = '280'
	
	SELECT * FROM Educations WHERE DateAdded >= '2010-06-01 14:03:35'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the education.
Campus	String		The campus.
ClassOf	String		The year the constituent graduated.
ClassOfDegree	String		The class of degree.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the education.
DateAdded	Datetime		The date when the education was created.
DateEnteredD	Integer		The first day of attendance.
DateEnteredM	Integer		The first month of attendance.
DateEnteredY	Integer		The first year of attendance.
DateGraduatedD	Integer		The graduation day.
DateGraduatedM	Integer		The graduation month.
DateGraduatedY	Integer		The graduation year.
DateLeftD	Integer		The last day of attendance.
DateLeftM	Integer		The last month of attendance.
DateLeftY	Integer		The last year of attendance.
DateModified	Datetime		The date when the education was last modified.
Degree	String		The degree received.
Department	String		The name of the education department.
Faculty	String		The name of the faculty.
Gpa	Double		The grade point average.
KnownName	String		The known name.
Majors	String		The major courses of study.
Minors	String		The minor courses of study.
Primary	Boolean		Indicates whether this is the constituent's primary school association.
RegistrationNumber	String		The registration number.
School	String		The school name.
SocialOrganization	String		The social organization.
Status	String		The status of the education.
SubjectOfStudy	String		The subject of study.
Type	String		The type of education.

Emails

Returns a list of email addresses of all constituents or a specified constituent

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

ConstituentId supports the '=,in' operators.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
IncludeInactive supports "=" operator.

For example:

	
	SELECT * FROM Emails WHERE ConstituentId = '280'
	
	SELECT * FROM Emails WHERE DateAdded >= '2010-06-01 14:03:35'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the email address.
Address	String		The email address.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the email address.
DateAdded	Datetime		The date when the email address was created.
DateModified	Datetime		The date when the email address was last modified.
DoNotEmail	Boolean		Indicates whether the constituent requests not to be contacted at this email address.
Inactive	Boolean		Indicates whether the email address is inactive.
Primary	Boolean		Indicates whether this is the constituent's primary email address.
Type	String		The type of email address.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive email addresses in the result.

EventCategories

Returns a list of active event categories.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

IncludeInactive supports the '=' operator.

For example:

	
	SELECT * FROM EventCategories WHERE IncludeInactive = true

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the event category.
Inactive	Boolean		Whether the category is inactive. True if inactive.
Name	String		The name of the event category.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive campaigns in the result.

EventFees

Returns a list of fees for an event.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: EventId is required in order to query EventFees.

EventId supports the '=' operator.

For example:

	SELECT * FROM EventFees WHERE EventId = '2'

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the event fee.
ContributionAmount	Double		The tax deductible amount for this fee.
Cost	Double		The fee's cost.
EventId	String	Events.Id	The ID of the event the fee is linked to.
Name	String		The name of the event fee.
NumberSold	Integer		The number of fees sold.

EventParticipantGuests

The participant's basic summary information

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: EventId is required in order to query EventParticipantGuests.

EventId supports the '=' operator.

For example:

	SELECT * FROM EventParticipantGuests WHERE EventId = '2'

Columns


Name	Type	References	Description
ContactId	String		The ID of the contact attending the event.
EventId	String	Events.Id	The ID of the event which the participant belongs to.
Name	String		The participant's full name.
ParticipantId	String		The ID of the participant.

EventParticipantMemberships

The individual's membership category

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: EventId is required in order to query EventParticipantMemberships.

EventId supports the '=' operator.

For example:

	SELECT * FROM EventParticipantMemberships WHERE EventId = '2'

Columns


Name	Type	References	Description
CategoryId	String		The ID of the membership category.
CategoryName	String		The name of the membership category.
EventId	String	Events.Id	The ID of the event which the participant belongs to.

EventParticipantOptions

Returns the participant options for an event.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: EventId is required in order to query EventParticipantOptions.

EventId supports the '=' operator.

For example:

	SELECT * FROM EventParticipantOptions WHERE EventId = '2'

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the event participant option.
EventId	String	Events.Id	The ID of the event which the participant belongs to.
AddedByService	String		The ID of the service who added this option.
AddedByUser	String		The ID of the user that added this option.
DateAdded	Datetime		The date this option was added.
DateUpdated	Datetime		The date this option was updated.
InputType	String		The available types of event participant options.
ListOptions	String		A event participant option list option.
MultiSelect	Boolean		Only valid for List input type, determines if multiple options can be selected.
Name	String		The name of the event participant option.
ParticipantId	String		The ID of the participant.
UpdatedByService	String		The ID of the service who updated this option.
UpdatedByUser	String		The ID of the user who updated this option.
Version	Integer		The version number of the option.

EventParticipants

Returns a list of participants for an event.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: EventId is required in order to query EventParticipants.

Attended supports the '=' operator.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
EventId supports the '=' operator.
InvitationStatus supports the '=' operator.
IsConstituent supports the '=' operator.
ParticipationLevelName supports the '=,in' operators.
RsvpStatus supports the '=,in' operators.
EmailEligible supports the '=' operator.
PhoneCallEligible supports the '=' operator.
FeesPaid supports the '=' operator.
Fields supports the '=' operator.

For example:

	SELECT * FROM EventParticipants WHERE EventId = '2'
	
	SELECT * FROM EventParticipants WHERE EventId = '2' AND DateAdded >= '2010-06-01 14:03:35'

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the participant.
Attended	Boolean		Whether the participant attended the event.
ClassOf	String		The participant's graduating class.
ContactId	String		The ID of the contact attending the event.
DateAdded	Datetime		The date the participant was created.
DateModified	Datetime		The date when the participant was last modified.
DoNotCall	Boolean		The participant's phone call preference.
DoNotEmail	Boolean		The participant's email preference.
Email	String		The participant's email address.
EventId	String	Events.Id	The ID of the event which the participant belongs to.
FirstName	String		The participant's first name.
FormerName	String		The participant's former name.
HostContactId	String		The ID of the contact attending the event.
HostName	String		The participant's full name.
HostParticipantId	String		The ID of the host participant.
InvitationStatus	String		The possible states for a constituent's invitation to an event.
IsConstituent	Boolean		Indicates whether the participant is a constituent.
LastName	String		The participant's last name.
LookupId	String		The LookupId of the participant.
MiddleName	String		The participant's middle name.
Name	String		The participant's full name.
NameTag	String		The name tag for the participant.
ParticipationLevelId	String		The ID of the participation level.
ParticipationLevelIsInactive	Boolean		Whether the participation level is inactive. True if inactive.
ParticipationLevelName	String		The name of the participation level.
Phone	String		The participant's phone number.
PreferredName	String		The participant's preferred name.
RsvpDateD	Integer		The day in the fuzzy date.
RsvpDateM	Integer		The month in the fuzzy date.
RsvpDateY	Integer		The year in the fuzzy date.
RsvpStatus	String		The possible states for a participant's RSVP for an event.
Seat	String		The seat assignment for the participant.
Suffix	String		The participant's suffix.
Title	String		The participant's title.
TotalPaid	Integer		The sum of the participant's paid gifts with a type of Registration Fees.
TotalRegistrationFees	Integer		The sum of the participant's fee amounts.
SummaryNote	String		summary Notes.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
EmailEligible	Boolean		A filter to include or exclude participants based on whether they have a primary email address that's not marked Do not email.
PhoneCallEligible	Boolean		A filter to include or exclude participants based on whether they have a primary phone number that's not marked Do not call.
FeesPaid	Boolean		A filter to include or exclude participants that have paid or not paid their fees.
Fields	String		Represents a list of fields to include on the returned records.

Events

Returns a list of events

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=' operator.
CategoryName supports the '=' operator.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
Name supports the '=' operator.
StartDate supports the '>=,<=' operators.
IncludeInactive supports the '=' operator.
Fields supports the '=' operator.

For example:

	
	SELECT * FROM Events WHERE Id = '2'
	
	SELECT * FROM Events WHERE StartDate >= '2000-04-06T05:50:00' AND StartDate <= '2020-04-06T06:50:00'
	
	SELECT * FROM Events WHERE DateAdded >= '2010-06-01 14:03:35'

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the event.
AttendedCount	Integer		The number of event attendees.
AttendingCount	Integer		The number of event participants who plan to attend.
CampaignId	String		The ID of the campaign affiliated with the event.
Capacity	Integer		The number of people that can attend the event.
CategoryId	String		The ID of the event category.
CategoryInactive	Boolean		Whether the category is inactive.
CategoryName	String		The name of the event category.
DateAdded	Datetime		The date when the event was created.
DateModified	Datetime		The date when the event was last modified.
EndDate	Datetime		The end date of the event.
EndTime	String		The end time of the event.
FundId	String		The ID of the fund affiliated with the event.
Goal	Double		The monetary goal of the event.
Inactive	Boolean		Whether the event is inactive.
InvitedCount	Integer		The number of event invitees.
LocationName	String		The name of the location.
LocationAddressLines	String		The location's address lines.
LocationPostalCode	String		The location's postal code.
LocationLocalityId	String		The record ID of the locality record.
LocationLocalityName	String		The name of the locality.
LocationAdministrativeAreaId	String		The record ID of the administrative area.
LocationAdministrativeAreaName	String		The name of the administrative area.
LocationAdministrativeAreaShortDesc	String		The short description of the administrative area.
LocationSubAdministrativeAreaId	String		The ID of the sub administrative area.
LocationSubAdministrativeAreaName	String		The name of the sub administrative area.
LocationCountryId	String		The ID of the country record.
LocationCountryDisplayName	String		The display name of the country.
LocationCountryIsoAlpha2Code	String		The ISO 3166-1 alpha-2 code for the country.
LocationFormattedAddress	String		The location's formatted address.
LookupId	String		The lookup ID of the event.
Name	String		The name of the event.
StartDate	Date		The start date of the event.
StartTime	String		The start time of the event.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Fields	String		Represents a list of fields to include on the returned records
IncludeInactive	Boolean		If set to true, includes inactive phones in the result.

FundAttachments

Returns a list of attachments for a fund.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: FundId is required in order to query FundAttachments.

FundId supports the '=' operator.

For example:

	SELECT * FROM FundAttachments WHERE FundId = '4'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the attachment.
FundId	String	Funds.Id	The immutable system record ID of the fund.
ContentType	String		The content type. For physical attachments only.
Date	Datetime		The date of the attachment.
FileId	String		The identifier of the file.
FileName	String		The file name.
FileSize	Integer		The file size in bytes.
Name	String		The name of the attachment.
ParentId	String		The parent object's immutable system record ID.
Tags	String		The tags associated with the attachment.
ThumbnailId	String		The identifier of the thumbnail.
ThumbnailUrl	String		The URL for a thumbnail.
Type	String		The attachment type.
Url	String		The URL for the attachment.

FundraiserAssignments

Returns a list of assignments for a fundraiser.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: FundraiserId is required in order to query FundraiserAssignments.

FundraiserId supports the '=' operator.

For example:

	SELECT * FROM FundraiserAssignments WHERE FundraiserId = '4'

Columns


Name	Type	References	Description
Id	String		The immutable system record ID of the given assignment.
AmountValue	Double		The goal amount for the fundraiser to solicit from the assigned constituent.
AppealId	String	FundraisingAppeals.Id	The immutable system record ID of the appeal the fundraiser should use to request gifts.
CampaignId	String	Campaigns.Id	The immutable system record ID of the campaign to apply resulting gifts to.
ConstituentId	String	Constituents.Id	The immutable system record ID of the target constituent.
End	Datetime		The fundraiser end date.
FundId	String	Funds.Id	The immutable system record ID of the fund any resulting gifts should be applied to.
FundraiserId	String		The immutable system record ID of the fundraiser assigned to the constituent.
Start	Date		The fundraiser start date.
Type	String		The type of fundraiser.

FundraiserGoals

Returns a list of goals for a fundraiser

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: FundraiserId is required in order to query FundraiserGoals.

FundraiserId supports the '=' operator.

For example:

	SELECT * FROM FundraiserGoals WHERE FundraiserId = '4'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the fundraiser goal.
AmountValue	Double		The fundraiser goal amount.
AppealId	String	FundraisingAppeals.Id	The immutable system record ID of the appeal associated with the fundraiser goal.
CampaignId	String	Campaigns.Id	The immutable system record ID of the campaign associated with the fundraiser goal.
FundId	String	Funds.Id	The immutable system record ID of the fund associated with the fundraiser goal.
FundraiserId	String		The immutable system record ID of the fundraiser associated with the fundraiser goal.
Type	String		The fundraiser goal type. Available values are Campaign, Fund, UnspecifiedCategory, and Appeal.
UnspecifiedCategoryName	String		The unspecified category name for the fundraiser goal.

FundraisingAppeals

Returns a list of fundraising appeals.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=,in' operators.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
IncludeInactive supports the '=' operator.

For example:

	
	SELECT * FROM FundraisingAppeals WHERE Id = '4'
	
	SELECT * FROM FundraisingAppeals WHERE IncludeInactive = true

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the appeal.
Category	String		The category of the appeal.
DateAdded	Datetime		The date when the appeal was created.
DateModified	Datetime		The date when the appeal was last modified.
Description	String		The display name of the appeal.
EndDate	Datetime		The end date of the appeal.
GoalValue	Double		The monetary goal associated with the appeal.
Inactive	Boolean		This computed field indicates that the appeal is active if the current date is after any start_date and before any end_date.
LookupId	String		The user-defined identifier for the appeal.
StartDate	Datetime		The start date of the appeal.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive appeals in the result.

Funds

Returns a list of funds.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=,in' operators.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
IncludeInactive supports the '=' operator.

For example:

	
	SELECT * FROM Funds WHERE Id = '4'
	
	SELECT * FROM Funds WHERE IncludeInactive = true

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the fund.
Category	String		The category of the fund.
DateAdded	Datetime		The date when the fund was created.
DateModified	Datetime		The date when the fund was last modified.
Description	String		The display name of the fund.
EndDate	Datetime		The end date of the fund.
GoalValue	Double		The monetary goal associated with the fund.
Inactive	Boolean		This computed field indicates that the fund is active if the current date is after any start_date and before any end_date.
LookupId	String		The user-defined identifier for the fund.
StartDate	Datetime		The start date of the fund.
Type	String		The type of the fund.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive funds in the result.

GetPledgeInstallments

This gets the installments of an existing pledge gift.

Columns


Name	Type	References	Description
Id [KEY]	String		ID
GiftId	String	Gifts.Id	The immutable system record ID of the gift the attachments are associated to.
AmountValue	Double		The Amount Value.
Date	Datetime		Date
Sequence	Integer		Sequence
Year	Integer		Year

GetPledgePayments

This gets the payments of an existing pledge gift.

Columns


Name	Type	References	Description
PaymentGiftId [KEY]	String		The Payment Gift Id.
InstallmentId	String		The Id for the installment.
GiftId	String	Gifts.Id	The immutable system record ID of the gift the attachments are associated to.
AmountAppliedValue	Double		The amount applied value.

GiftAcknowledgements

Returns a list of acknowledgements for a gift

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: GiftId are required in order to query GiftAcknowledgements.

GiftId supports the '=' operator.

For example:

	SELECT * FROM GiftAcknowledgements WHERE GiftId = '476'

Columns


Name	Type	References	Description
GiftId	String	Gifts.Id	The immutable system record ID of the gift associated with the acknowledgement.
Date	Datetime		The date associated with the acknowledgement.
Letter	String		The letter associated with the acknowledgement.
Status	String		The status of the acknowledgement. Available values are: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT, and DONOTACKNOWLEDGE.

GiftAttachments

Returns a list of attachments for a gift.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: GiftId are required in order to query GiftAttachments.

GiftId supports the '=' operator.

For example:

	SELECT * FROM GiftAttachments WHERE GiftId = '476'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the attachment.
GiftId	String	Gifts.Id	The immutable system record ID of the gift the attachments are associated to.
ContentType	String		The content type. For physical attachments only.
Date	Datetime		The date of the attachment.
FileId	String		The identifier of the file.
FileName	String		The file name.
FileSize	Integer		The file size in bytes.
Name	String		The name of the attachment.
ParentId	String		The parent object's immutable system record ID.
Tags	String		The tags associated with the attachment.
ThumbnailId	String		The identifier of the thumbnail.
ThumbnailUrl	String		The URL for a thumbnail.
Type	String		The attachment type.
Url	String		The URL for the attachment.

GiftBatches

Returns a list of gift batches.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

BatchNumber supports the '=' operator.
CreatedBy supports the '=' operator.
HasExceptions supports the '=' operator.
IsApproved supports the '=' operator.
SearchText supports the '=' operator.

Columns


Name	Type	References	Description
Id [KEY]	String		The batch identifier.
ActualAmount	Integer		The actual batch amount.
BatchDescription	String		The batch description.
BatchNumber	String		The batch number.
CreatedBy	String		Created by user name.
AddedBy	String		Added by user name.
CreatedOn	Datetime		The date the batch was created.
DateAdded	Datetime		The date the batch was added.
HasExceptions	Boolean		The has exceptions boolean.
IsApproved	Boolean		Approved boolean.
Approved	Boolean		Approved boolean.
NumberOfGifts	Integer		The number of gifts in the batch.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SearchText	String		If set to true, includes inactive gift batches in the result.

GiftPayments

Returns payments for a gift.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: GiftId are required in order to query GiftPayments.

GiftId supports the '=' operator.

For example:

	SELECT * FROM GiftPayments WHERE GiftId = '476'

Columns


Name	Type	References	Description
GiftId	String	Gifts.Id	The immutable system record ID of the gift associated with the payment.
AccountToken	String		The tokenized account information (e.g. credit card) from the external payment provider. Only applies to payment methods of CreditCard and DirectDebit.
BbpsConfigurationId	String		The bbps configuration ID. Only applies to payment methods of CreditCard and DirectDebit.
BbpsTransactionId	String		The bbps transaction ID. Only applies to payment methods of CreditCard and DirectDebit.
CheckDateD	String		The day of the check date. Only applies to payment method of PersonalCheck.
CheckDateM	String		The month of the check date. Only applies to payment method of PersonalCheck.
CheckDateY	String		The year of the check date. Only applies to payment method of PersonalCheck.
CheckNumber	String		The check number. Only applies to payment method of PersonalCheck.
CheckoutTransactionId	String		The checkout transaction ID. Only applies to payment methods of CreditCard and DirectDebit.
PaymentMethod	String		The payment method.
Reference	String		The reference.
ReferenceDateD	String		The day of the reference date.
ReferenceDateM	String		The month of the reference date.
ReferenceDateY	String		The year of the reference date.

GiftReceipts

Returns receipts for a gift.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: GiftId are required in order to query GiftReceipts.

GiftId supports the '=' operator.

For example:

	SELECT * FROM GiftReceipts WHERE GiftId = '476'

Columns


Name	Type	References	Description
GiftId	String	Gifts.Id	The immutable system record ID of the gift associated with the receipt.
AmountValue	Integer		The amount of the receipt.
Date	Datetime		The date on the receipt.
Number	Integer		The number of the receipt.
Status	String		The status of the receipt. Available values are: RECEIPTED, NEEDSRECEIPT, and DONOTRECEIPT.

Gifts

Returns a paginated list of gifts

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=' operator.
ConstituentId supports the '=,in' operators.
Date supports the '>=,<=' operators.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
PostStatus supports the '=,in' operators.
Type supports the '=' operator.
ListId supports the '=' operator.
AppealId supports the '=,in' operators.
FundId supports the '=,in' operators.
CampaignId supports the '=,in' operators.
AcknowledgmentStatus supports the '=,in' operators.
ReceiptStaus supports the '=,in' operators.

For example:

	
	SELECT * FROM Gifts WHERE ConstituentId IN ('280', '281')
	
	SELECT * FROM Gifts WHERE PostStatus = 'Posted'
	
	SELECT * FROM Gifts WHERE Type IN ('Pledge', 'GiftInKind')

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the gift.
AmountValue	Double		The monetary amount of the gift.
BalanceValue	Double		The balance remaining on the gift.
BatchNumber	String		The batch number associated with this gift.
Constituency	String		The constituency of the gift.
ConstituentId	String		The immutable system record ID of the constituent associated with the gift.
Date	Date		The gift date.
DateAdded	Datetime		The date when the gift was created.
DateModified	Datetime		The date when the gift was last modified.
GiftAidAmountValue	Double		This computed field calculates the total qualified amount of tax reclaimed from Gift Aid across all gift_splits for this gift.
GiftAidQualificationStatus	String		This computed field determines the Gift Aid qualification status based on tax declaration information and the database format. Available values are: Qualified, NotQualified, and PartlyQualified. For the UK only.
GiftStatus	String		The status of the gift. Available values are Active, Held, Terminated, Completed, and Cancelled.
IsAnonymous	Bool		Indicates whether the gift is anonymous.
LinkedGifts	String		The identifiers of other gifts that are linked to this gift.
LookupId	String		The user-defined identifier for the gift.
Origin	String		The origin of the gift.
PostDate	Datetime		The date that the gift was posted to general ledger.
PostStatus	String		The general ledger post status of the gift.
RecurringGiftStatusDateD	Integer		The date (D) that the gift status was last modified.
RecurringGiftStatusDateM	Integer		The date (M) that the gift status was last modified.
RecurringGiftStatusDateY	Integer		The date (Y) that the gift status was last modified.
Reference	String		Notes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind.
Subtype	String		The subtype of the gift.
Type	String		The gift type.
GiftCode	String		The gift Code.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
ListId	String		Defines a list identifier used to filter the set of gifts to those included in the specified list. If this value is set, other specified filters will be ignored.
AppealId	String		Returns gifts if any of the specified appeal identifiers match any of their appeals.
FundId	String		Returns gifts if any of the specified fund identifiers match any of their funds.
CampaignId	String		Returns gifts if any of the specified campaign identifiers match any of their campaigns.
AcknowledgmentStatus	String		Returns gifts if their acknowledgement status matches any specified.
ReceiptStaus	String		Returns gifts if their receipt status matches any specified.

GiftsCustomFields

Retrieves custom fields for all gifts

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Columns


Name	Type	References	Description
Id	String		The immutable system record ID of the custom field.
GiftId	String		The parent object's immutable system record ID.
Name	String		The custom field category.
Value	String		The value of the custom field.
Comment	String		The comment on the custom field.
DateAdded	Datetime		The date when the custom field was created.
DateModified	Datetime		The date when the custom field was last modified.
Type	String		The type of data that the custom field represents.

GiftSoftCredits

Returns soft credits for a gift.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: GiftId are required in order to query GiftSoftCredits.

GiftId supports the '=' operator.

For example:

	SELECT * FROM GiftSoftCredits WHERE GiftId = '476'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the soft credit.
AmountValue	Double		The amount of the soft credit.
ConstituentId	String		The immutable system record ID of the constituent associated with the soft credit.
GiftId	String	Gifts.Id	The immutable system record ID of the gift associated with the soft credit.

GiftSplits

Returns the splits for a gift.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: GiftId are required in order to query GiftSplits.

GiftId supports the '=' operator.

For example:

	SELECT * FROM GiftSplits WHERE GiftId = '476'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the gift split.
GiftId	String	Gifts.Id	The immutable system record ID of the gift associated with the gift split.
AmountValue	Integer		The amount of the gift split.
AppealId	String		The immutable system record ID of the appeal associated with the gift split.
CampaignId	String		The immutable system record ID of the campaign associated with the gift split.
FundId	String		The immutable system record ID of the fund associated with the gift split.
GiftAidAmount	String		The amount of tax reclaimed from gift aid for this gift split. For the UK only.
GiftAidQualificationStatus	String		The gift aid qualification status of the gift split. Available values are: Qualified, and NotQualified. For the UK only.
PackageId	String		The immutable system record ID of the package associated with the gift split.

Giving

Returns the first, latest or greatest gift recorded for a constituent.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ConstituentId and GivingSummaryType are required in order to query Giving.

ConstituentId supports the '=' operator.
GivingSummaryType supports the '=' operator.

For example:

	SELECT * FROM Giving WHERE ConstituentId = '280' AND GivingSummaryType = 'greatest'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the gift.
AmountValue	Double		The gift amount.
Date	Date		The gift date.
Type	String		The gift type.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with this giving.
GivingSummaryType	String		The giving summary type. Available values are First, Latest and Greatest. The allowed values are first, greatest, latest.

GivingAppeals

Returns the giving appeals summary for the constituent

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ConstituentId and GivingSummaryType are required in order to query GivingAppeals.

ConstituentId supports the '=' operator.
GivingSummaryType supports the '=' operator.

For example:

	SELECT * FROM GivingAppeals WHERE ConstituentId = '280' AND GivingSummaryType = 'first'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the appeal.
Description	String		The description.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with this giving.
GivingSummaryType	String		The giving summary type. Available values are First, Latest and Greatest. The allowed values are first, greatest, latest.

GivingCampaigns

Returns the giving campaigns summary for the constituent

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ConstituentId and GivingSummaryType are required in order to query GivingCampaigns.

ConstituentId supports the '=' operator.
GivingSummaryType supports the '=' operator.

For example:

	SELECT * FROM GivingCampaigns WHERE ConstituentId = '280' AND GivingSummaryType = 'greatest'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the campaign.
Description	String		The campaign description.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with this giving.
GivingSummaryType	String		The giving summary type. Available values are First, Latest and Greatest. The allowed values are first, greatest, latest.

GivingFunds

Returns the giving funds summary for the constituent

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ConstituentId and GivingSummaryType are required in order to query GivingFunds.

ConstituentId supports the '=' operator.
GivingSummaryType supports the '=' operator.

For example:

	
	SELECT * FROM GivingFunds WHERE ConstituentId = '280' AND GivingSummaryType = 'latest'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the fund.
Description	String		The fund description.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with this giving.
GivingSummaryType	String		The giving summary type. Available values are First, Latest and Greatest. The allowed values are first, greatest, latest.

LifetimeGiving

Returns the lifetime giving information for a constituent.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ConstituentId are required in order to query LifetimeGiving.

ConstituentId supports the '=' operator.

For example:

	SELECT * FROM LifetimeGiving WHERE ConstituentId = '280'

Columns


Name	Type	References	Description
ConsecutiveYearsGiven	Integer		This computed field calculates the number of consecutive years the constituent has given.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the lifetime giving.
TotalCommittedMatchingGiftsValue	Double		This computed field calculates the total amount of matching gift commitments attributed to the constituent.
TotalGivingValue	Double		This computed field calculates the total amount given by the constituent.
TotalPledgeBalanceValue	Double		This computed field calculates the unpaid pledge balance for the constituent.
TotalReceivedGivingValue	Double		This computed field calculates the total received amount given by the constituent.
TotalReceivedMatchingGiftsValue	Double		This computed field calculates the total amount of payments toward matching gift pledges attributed to the constituent.
TotalSoftCreditsValue	Double		This computed field calculates the total amount of soft credits applied to the constituent.
TotalYearsGiven	Integer		This computed field calculates the total number of years the constituent has given.

Lists

Returns a list of lists for the given list type

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

ListType supports the '=' operator.

For example:

	SELECT * FROM Lists WHERE ListType = 'Constituent'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID for the list.
DateModified	Datetime		The date this list was last modified.
Description	String		The description of the list
IsPublic	Boolean		Indicates whether this is a public or private list.
LastModifiedByUserId	String		The ID of the user that last modified the list.
LastModifiedByUserName	String		The name of the user that last modified the list.
Name	String		The name of the list.
RecordCount	Integer		The total number of records defined by this list based on the last time this list was saved.
ListType	String		Type of the list. The allowed values are Constituent, Gift, Action, Opportunity.

Members

Returns the list of members.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

ConstituentId supports the '=' operator.

For example:

	SELECT * FROM Members WHERE ConstituentId = '280'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the member.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the member.
Primary	Boolean		Indicates whether this is the primary member on the membership.

Memberships

Returns a list of memberships.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

ConstituentId supports the '=' operator.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.

For example:

	
	SELECT * FROM Memberships WHERE ConstituentId = '280'
	
	SELECT * FROM Memberships WHERE DateAdded >= '2010-06-01 14:03:35'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the membership.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the membership.
Category	String		The membership category.
DateAdded	Datetime		The date when the membership was created.
DateModified	Datetime		The date when the membership was last modified.
DuesValue	Integer		The membership dues.
Expires	Datetime		The date when the membership expires.
Joined	Datetime		The date when the membership becomes active.
Program	String		The membership program.
Standing	String		The membership status. Available values are New, Active, Lapsed, and Dropped.
Subcategory	String		The membership subcategory.

Notes

Returns a list of notes that tracks helpful or important details such as specific interests and special instructions for donations

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=' operator.
ConstituentId supports the '=' operator.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.

For example:

	
	SELECT * FROM Notes WHERE ConstituentId = '280'
	
	SELECT * FROM Notes WHERE DateAdded >= '2010-06-01 14:03:35'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the note.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the note.
DateD	Integer		The day of note date.
DateM	Integer		The month of note date.
DateY	Integer		The year of note date.
DateAdded	Datetime		The date when the note was created.
DateModified	Datetime		The date when the note was last modified.
Summary	String		The note summary.
Text	String		The note's contents.
Type	String		The note type.

OnlinePresences

Returns a paginated list of online presences that store a constituent's social media accounts, websites.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

ConstituentId supports the '=' operator.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
IncludeInactive supports the '=' operator.

For example:

	
	SELECT * FROM OnlinePresences WHERE ConstituentId = '280'
	
	SELECT * FROM OnlinePresences WHERE DateAdded >= '2010-06-01 14:03:35'
	
	SELECT * FROM OnlinePresences WHERE IncludeInactive = true

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the online presence.
Address	String		The web address for the online presence.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the online presence.
DateAdded	Datetime		The date when the online presence was created.
DateModified	Datetime		The date when the online presence was last modified.
Inactive	Boolean		Indicates whether the online presence is inactive.
Primary	Boolean		Indicates whether this is the constituent's primary online presence.
Type	String		The online presence type.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive online presences in the result.

Opportunities

Retrieves a list of opportunities

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=' operator.
ConstituentId supports the '=,in' operators.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
IncludeInactive supports the '=' operator.

For example:

	
	SELECT * FROM Opportunities WHERE Id = '4'
	
	SELECT * FROM Opportunities WHERE ConstituentId IN ('255', '266')
	
	SELECT * FROM Opportunities WHERE DateAdded >= '1999-06-01 14:03:35'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the opportunity.
AskAmountValue	Double		The monetary amount solicited from the prospect for the opportunity.
AskDate	Date		The date when the solicitation was made.
CampaignId	String	Campaigns.Id	The immutable system record ID of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the opportunity.
DateAdded	Datetime		The date when the opportunity was created.
DateModified	Datetime		The date when the opportunity was last modified.
Deadline	Datetime		The goal date for the opportunity to result in a gift.
ExpectedAmountValue	Double		The monetary amount that is realistically expected to result from the opportunity.
ExpectedDate	Datetime		The date when the prospect is expected to give in response to the opportunity.
FundId	String	Funds.Id	The immutable system record ID of the fund associated with the opportunity.
FundedAmountValue	Double		The monetary amount that the prospect gave in response to the opportunity.
FundedDate	Datetime		The date when the prospect gave in response to the opportunity.
Fundraisers	String		Fundraiser constituents interact with other constituents and prospects on behalf of your organization to cultivate relationships and advance opportunities to secure major gifts.
Inactive	Boolean		Indicates whether the opportunity is inactive.
LinkedGifts	String		The immutable system record IDs of the gifts related to the opportunity.
Name	String		The name that identifies the opportunity throughout the program, such as in lists or on constituent records.
Purpose	String		The intended use for any money raised as a result of the opportunity.
Status	String		The status that indicates where the opportunity is in the solicitation process.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive opportunities in the response.
ListId	String		Defines a list identifier used to filter the set of opportunities to those included in the specified list. If this value is set, other specified filters will be ignored.

OpportunitiesCustomFields

Retrieves custom fields for an opportunity

Columns


Name	Type	References	Description
Id	String		The immutable system record ID of the custom field.
OpportunityId	String		The parent object's immutable system record ID.
Name	String		The custom field category.
Value	String		The value of the custom field.
Date	Datetime		The date when the custom field was created.
DateAdded	Datetime		The date when the custom field was added.
DateModified	Datetime		The date when the custom field was last modified.
Type	String		The type of data that the custom field represents.

OpportunityAttachments

Returns a list of attachments for an opportunity

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: OpportunityId is required in order to query OpportunityAttachments.

OpportunityId supports the '=' operator.

For example:

	SELECT * FROM OpportunityAttachments WHERE OpportunityId = '4'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the attachment.
OpportunityId	String	Opportunities.Id	The ID of the Opportunity.
Content_type	String		The content type. For physical attachments only.
Date	Datetime		The date of the attachment.
FileId	String		The identifier of the file.
FileName	String		The file name. For physical attachments only.
FileSize	Integer		The file size in bytes. For physical attachments only.
Name	String		The name of the attachment.
ParentId	String		The parent object's immutable system record ID.
Tags	String		The tags associated with the attachment.
ThumbnailId	String		The identifier of the thumbnail. For physical attachments that are images only.
ThumbnailUrl	String		The URL for a thumbnail.
Type	String		The attachment type. Available values are Link and Physical.
Url	String		The URL for the attachment.

Packages

Returns a list of packages that contains content and other items for the appeals that organizations use to solicit gifts

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=' operator.
AppealId supports the '=,in' operators.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.
IncludeInactive supports the '=' operator.

For example:

	
	SELECT * FROM Packages WHERE Id = '1'
	
	SELECT * FROM Packages WHERE AppealId IN ('17', '18')
	
	SELECT * FROM Packages WHERE DateAdded >= '1999-06-01 14:03:35'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the package.
AppealId	String	FundraisingAppeals.Id	The immutable system record ID of the appeal associated with this package.
Category	String		The category of the package.
DateAdded	Datetime		The date when the package was created.
DateModified	Datetime		The date when the package was last modified.
DefaultGiftAmountValue	Double		The default amount for gifts associated with this package.
Description	String		The display name of the package.
End	Datetime		The end date of the package.
GoalValue	Double		The goal of this package.
Inactive	Boolean		This computed field indicates that the package is active if the current date is after any start and before any end.
LookupId	String		The user-defined identifier for the package.
Notes	String		The notes on the package.
RecipientCount	Integer		The amount of recipients of the package.
Start	Datetime		The start date of the package.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive packages in the response.

ParticipantFeePayments

Returns the fee payments for a participant.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ParticipantId is required in order to query ParticipantFeePayments.

ParticipantId supports the '=' operator.

For example:

	SELECT * FROM ParticipantFeePayments WHERE ParticipantId = '197'

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the participant fee.
ParticipantId	String	EventParticipants.Id	The ID of the participant that the participant fee is linked to.
AppliedAmount	Integer		The applied amount of the participant fee payment.
GiftId	String		The ID of the gift that the participant fee is linked to.

ParticipantFees

Returns a list of fees for a participant.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ParticipantId is required in order to query ParticipantFees.

ParticipantId supports the '=' operator.

For example:

	SELECT * FROM ParticipantFees WHERE ParticipantId = '197'

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the participant fee.
ParticipantId	String	EventParticipants.Id	The ID of the record that the participant fee is linked to.
DateD	Integer		The day in the fuzzy date.
DateM	Integer		The month in the fuzzy date.
DateY	Integer		The year in the fuzzy date.
EventFeeContributionAmount	Integer		The tax deductible amount for this fee.
EventFeeCost	Double		The fee's cost.
EventFeeEventId	String		The ID of the event the fee is linked to.
EventFeeId	String		The ID of the event fee.
EventFeeName	String		The name of the event fee.
EventFeeNumberSold	Integer		The number of fees sold.
FeeAmount	Double		The amount of the participant fee.
Quantity	Integer		The quantity purchased.
TaxReceiptableAmount	Integer		The tax receiptable amount of the participant fee.

ParticipantLevels

Returns a list of participation levels for all events.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

IncludeInactive supports the '=' operator.

For example:

	
	SELECT * FROM ParticipantLevels WHERE IncludeInactive = true

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the participation level.
IsInactive	Boolean		Whether the participation level is inactive. True if inactive.
Name	String		The name of the participation level.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive participation levels in the result.

ParticipantOptions

Returns the participant options for a participant.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ParticipantId is required in order to query ParticipantOptions.

ParticipantId supports the '=' operator.

For example:

	SELECT * FROM ParticipantOptions WHERE ParticipantId = '197'

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the participant option.
ParticipantId	String	EventParticipants.Id	The ID of the participant.
AddedByService	String		The name of the service that added this participant option.
AddedByUser	String		The ID of the user that added the participant option.
DateAdded	Datetime		The date the participant option was added.
DateUpdated	Datetime		The date the participant option was updated.
EventId	String		The ID of the event.
EventParticipantOptionId	String		The ID of the event participant option.
OptionValue	String		The participant's response to the option.
UpdatedByService	String		The name of the service that updated this participant option.
UpdatedByUser	String		The ID of the user who updated the participant option.

Phones

Returns a list of phones for all constituents or a specific constituent

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=' operator.
ConstituentId supports the '=,in' operators.
DateAdded supports the '>=' operators.
DateModified supports the '>=' operators.
IncludeInactive supports the '=' operators.

For example:

	
	SELECT * FROM Phones WHERE Id = '1'
	
	SELECT * FROM Phones WHERE ConstituentId IN ('280', '281')
	
	SELECT * FROM Phones WHERE DateAdded >= '2010-06-01 14:03:35'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the phone.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the phone.
DateAdded	Datetime		The date when the phone was created.
DateModified	Datetime		The date when the phone was last modified.
DoNotCall	Boolean		Indicates whether the constituent requests not to be contacted at this number.
Inactive	Boolean		Indicates whether the phone is inactive.
Number	String		The phone number.
Primary	Boolean		Indicates whether this is the constituent's primary phone.
Type	String		The phone type.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive phones in the result.

RatingCategories

Returns a list of all available rating categories.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

IncludeInactive supports the '=' operator.
SourceName supports the '=' operator.

For example:

	
	SELECT * FROM RatingCategories WHERE SourceName = 'Econometrics'
	
	SELECT * FROM RatingCategories WHERE IncludeInactive = true

Columns


Name	Type	References	Description
Inactive	Boolean		Indicates whether the category is inactive.
Name	String		The name of the rating category.
SourceName	String		The source of the category.
Type	String		The type of the rating category.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive rating categories in the result.

Ratings

Returns a list of ratings for a constituent.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ConstituentId is required in order to query Ratings.

ConstituentId supports the '=' operator.
IncludeInactive supports the '=' operator.
MostRecentlyUsed supports the '=' operator.

For example:

	
	SELECT * FROM Ratings WHERE ConstituentId = '280'
	
	SELECT * FROM Ratings WHERE IncludeInactive = true
	
	SELECT * FROM Ratings WHERE MostRecentlyUsed = true

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the rating.
Category	String		The category of the rating.
Comment	String		A comment about the rating.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the rating.
Date	Datetime		The date of the rating.
Inactive	Boolean		This computed field indicates that the rating is active if the category is active.
Source	String		The source of the rating.
Type	String		This computed field indicates the type of data that the rating represents based on the category property.
Value	String		The value of the rating.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive ratings in the result.
MostRecentOnly	Boolean		If set to true, includes only most recent ratings in the result.

RatingSources

Returns a list of all available rating sources.

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

IncludeInactive supports the '=' operator.

For example:

	
	SELECT * FROM RatingSources WHERE IncludeInactive = true

Columns


Name	Type	References	Description
Inactive	Boolean		Indicates whether the rating source is inactive.
Name	String		The name of the rating source.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
IncludeInactive	Boolean		If set to true, includes inactive rating sources in the result.

Relationships

Returns a list of relationships between constituents and other individuals and organizations such as family, friends, and employers

Table Specific Information

Select

The Cloud will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

Id supports the '=' operator.
ConstituentId supports the '=' operator.
DateAdded supports the '>=,>' operators.
DateModified supports the '>=,>' operators.

For example:

	SELECT * FROM Relationships WHERE Id = '1'
	
	SELECT * FROM Relationships WHERE ConstituentId = '280'

Columns


Name	Type	References	Description
Id [KEY]	String		The immutable system record ID of the relationship.
Comment	String		The comment on the relationship.
ConstituentId	String	Constituents.Id	The immutable system record ID of the constituent associated with the relationship.
DateAdded	Datetime		The date when the relationship was created.
DateModified	Datetime		The date when the relationship was last modified.
EndD	Integer		The end day for the relationship.
EndM	Integer		The end month for the relationship.
EndY	Integer		The end year for the relationship.
IsOrganizationContact	Boolean		Indicates whether the related individual represents the organization as a contact.
IsPrimaryBusiness	Boolean		Indicates whether the related organization is the individual's primary business.
IsSpouse	Boolean		Indicates whether the related constituent is the constituent's spouse.
Name	String		The name of the related constituent.
OrganizationContactType	String		Provides context for interactions with the related individual who represents the organization as a contact.
Position	String		The individual's position in the organization.
ReciprocalRelationshipId	String		The identifier for the reciprocal relationship record.
ReciprocalType	String		Describes the constituent's relationship to the related constituent.
RelationId	String		The immutable system record ID of the related individual or organization.
StartD	Integer		The start day for the relationship.
StartM	Integer		The start month for the relationship.
StartY	Integer		The start year for the relationship.
Type	String		The type of relation that the relationship represents.

Tributes

Returns a list of tributes.

Table Specific Information

Select

All the filters are executed client side within the Cloud. For example:

	
	SELECT * FROM Tributes
	
	SELECT * FROM Tributes WHERE Id = 2

Columns


Name	Type	References	Description
Id [KEY]	Integer		The tribute ID.
ConstituentRecordId	Integer		The system record ID of the constituent.
DefaultFundId	Integer		The default fund ID.
Description	String		The tribute description.
EndDateD	Integer		The day of the end date.
EndDateM	Integer		The month of the end date.
EndDateY	Integer		The year of the end date.
IsActive	Boolean		The active status of the tribute.
Notes	String		The tribute notes.
StartDateD	Integer		The day of the start date.
StartDateM	Integer		The month of the start date.
StartDateY	Integer		The year of the start date.
TributeTypeId	Integer		The tribute type code ID.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with BlackBaud Raiser's Edge NXT.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from BlackBaud Raiser's Edge NXT, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Blackbaud Raisers Edge NXT Stored Procedures


Name	Description
AutomateRecurringGift	Converts a manual recurring gift to an automated recurring gift in the web view
UpdateGiftReceipt	Edits a gift receipt
UpdateGiftStatus	Edit the status of a recurring gift.

AutomateRecurringGift

Converts a manual recurring gift to an automated recurring gift in the web view

Input


Name	Type	Required	Description
GiftId	String	True	The immutable system record ID of the recurring gift to convert.
BBPSConfigurationId	String	True	BBPS Configuration Id to put on the gift.

Result Set Columns


Name	Type	Description
Success	String	Execution status of the stored procedure.

SellStockGift

This updates a stock gift to sold with the given details.

Input


Name	Type	Required	Description
GiftId	String	True	The immutable system record ID of the recurring gift to convert.
BrokerFee	String	False	The Broker Fee.
PostDate	String	False	The Post Date.
PostStatus	String	False	The Post Status.
StockIssuerIssuer	String	False	StockIssuerIssuer.
StockIssuerSymbol	String	False	StockIssuerSymbol.
StockIssuerUnits	String	False	StockIssuerUnits.
StockIssuerUnitPrice	String	False	StockIssuerUnitPrice.
Notes	String	False	Notes.
StockSaleDate	String	False	StockSaleDate.
StockSaleValue	String	False	StockSaleValue.

Result Set Columns


Name	Type	Description
Success	String	Execution status of the stored procedure.

UpdateGiftReceipt

Edits a gift receipt

Stored Procedures Specific Information

Process of Update Gift Receipt

BlackBaud Raiser's Edge NXT allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The available columns for UpdateGiftReceipt are ReceiptId, Amount, Date, Number and Status. For example:

EXECUTE UpdateGiftReceipt ReceiptId = '372', Amount = 0.0, Date = '2018-12-31T00:00:00', Number = 123456, Status = 'Receipted'

Input


Name	Type	Required	Description
ReceiptId	String	True	The immutable system record ID of the gift receipt to edit. It uses the parent gift's ID as its value.
Amount	Double	True	The amount of the receipt.
Date	String	True	The date on the receipt
Number	Integer	True	The number of the receipt.
Status	String	True	The receipt status of the gift. Available values are: RECEIPTED, NEEDSRECEIPT, and DONOTRECEIPT. When receipt_status is set to NEEDSRECEIPT or DONOTRECEIPT, receipt_date should be null.

Result Set Columns


Name	Type	Description
Success	String	Execution status of the stored procedure

UpdateGiftStatus

Edit the status of a recurring gift.

Stored Procedures Specific Information

Process of Update Gift Status

BlackBaud Raiser's Edge NXT allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The available columns for UpdateGiftStatus are GiftId and GiftStatus. For example:

EXECUTE UpdateGiftStatus GiftId = '281', GiftStatus = 'Held'

Input


Name	Type	Required	Description
GiftId	String	True	The immutable system record ID of the recurring gift to update.
GiftStatus	String	True	The new status of the recurring gift. Available values are Active, Held, Terminated, Completed, and Cancelled.

Result Set Columns


Name	Type	Description
Success	String	Execution status of the stored procedure

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for BlackBaud Raiser's Edge NXT:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Constituents table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Constituents'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the UpdateGiftStatus stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='UpdateGiftStatus' AND Direction=1 OR Direction=2

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Constituents table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Constituents'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:raiseredgenxt:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

OAuth

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
SubscriptionKey	Subscription key which provides access to the API. Found in your Developer Profile.

SSL

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Logging

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Miscellaneous

Property	Description
IncludeCustomFields	Set to true to retrieve custom fields values for Constituents, Actions, Opportunities, and Gifts.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
PageSize	The number of results to return per page of data retrieved from BlackBaud Raiser's Edge NXT.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
SubscriptionKey	Subscription key which provides access to the API. Found in your Developer Profile.

Request a subscription to an API from the Products page (https://developer.sky.blackbaud.com/products/), select SKY API Standard Edition.
Select Subscribe. A confirmation screen appears.
To submit your request, select Confirm. You will get an email notification when your request is approved.
After it is approved, you can view the subscription key within your developer profile.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Verbosity

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
IncludeCustomFields	Set to true to retrieve custom fields values for Constituents, Actions, Opportunities, and Gifts.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
PageSize	The number of results to return per page of data retrieved from BlackBaud Raiser's Edge NXT.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

If Timeout expires and the operation is not yet complete, the Cloud throws an exception.

Cloud

Blackbaud Raisers Edge NXT - CData Cloud

Overview

Key Features

Getting Started

Connecting to BlackBaud Raiser's Edge NXT

Accessing Data from CData Cloud Services

Establishing a Connection

Connecting to BlackBaud Raiser's Edge NXT

Authenticating to BlackBaud Raiser's Edge NXT

Web Applications

Headless Machines

Creating a Custom OAuth Application

Creating a Custom OAuth Application

Create and Register the Custom Application

Connect the Custom Application to Your Environment

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Overview

Key Features

Views

Stored Procedures

Views

CData Cloud - Blackbaud Raisers Edge NXT Views

ActionAttachments

Table Specific Information

Select

Columns

ActionCustomFields

Columns

Actions

Table Specific Information

Select

Columns

Pseudo-Columns

Addresses

Table Specific Information

Select

Columns

Pseudo-Columns

Aliases

Table Specific Information

Select

Columns

AppealAttachments

Table Specific Information

Select

Columns

CampaignAttachments

Table Specific Information

Select

Columns

Campaigns

Table Specific Information

Select

Columns

Pseudo-Columns

ConsentCategories

Table Specific Information

Select

Columns

Pseudo-Columns

ConsentChannelCategories

Table Specific Information

Select

Columns

ConsentChannels

Table Specific Information

Select

Columns

ConsentSources

Table Specific Information

Select

Columns

Pseudo-Columns