Blackbaud Raiser's Edge NXT Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8803 of the connector.

Get Started¶

BlackBaud Raiser's Edge NXT Version Support

The connector leverages the SKY API to enable bidirectional access to BlackBaud Raiser's Edge NXT.

Establish a Connection¶

Authenticate via OAuth Authentication¶

You can connect after setting required connection properties for your user credentials and obtaining required access tokens using a tool such as Postman.

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

See Using OAuth Authentication for details of the OAuth authentication flow.

Create a Custom OAuth Application¶

Create a Custom OAuth Application¶

embeds OAuth Application Credentials with 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:

1. Go to BlackBaud Sign Up.
2. Set up a developer account and get a subscription key, as described in the BlackBaud Getting Started documentation.
3. Log in at https://app.blackbaud.com/subscriptions.
4. To request a subscription to an API, select SKY API Standard Edition.
5. Select Subscribe. A confirmation screen appears.
6. 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:

1. From My Applications (see https://developer.blackbaud.com/apps), select Register app.
2. 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.
3. 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:

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

The new application displays on the Manage page.

Important Notes¶

Configuration Files and Their Paths¶

• All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features¶

This section details a selection of advanced features of the BlackBaud Raiser's Edge NXT connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to BlackBaud Raiser's Edge NXT and then processes the rest of the query in memory (client-side).

User Defined Views¶

The Jitterbit Connector for Blackbaud Raisers Edge NXT allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Constituents WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements¶

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View¶

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View¶

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View¶

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views¶

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views¶

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration¶

Customize the SSL Configuration¶

By default, the connector 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.

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 connector 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 connector.

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.

Jitterbit Connector for Blackbaud Raisers Edge NXT Views¶

ActionAttachments¶

Retrieves a list of attachments for an action.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: ActionId is required in order to query ActionAttachments.

• ActionId supports the = operator.

For example:

SELECT * FROM ActionAttachments WHERE ActionId = '335'

Columns¶

ActionCustomFields¶

Retrieves custom fields for an action

Columns¶

Actions¶

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

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

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.

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 connector 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 connector.

• 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¶

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.

Aliases¶

Retrieves a list of aliases for a constituent

Table Specific Information¶

Select¶

The connector 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 connector.
Note: ConstituentId is required in order to query Aliases.

• ConstituentId supports the = operator.

For example:

SELECT * FROM Aliases WHERE ConstituentId = '280'

Columns¶

AppealAttachments¶

Returns a list of attachments for an appeal.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: AppealId is required in order to query AppealAttachments.

• AppealId supports the = operator.

For example:

SELECT * FROM AppealAttachments WHERE AppealId = '2'

Columns¶

CampaignAttachments¶

Returns a list of attachments for a campaign.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: CampaignId is required in order to query CampaignAttachments.

• CampaignId supports the = operator.

For example:

SELECT * FROM CampaignAttachments WHERE CampaignId = '2'

Columns¶

Campaigns¶

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

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

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.

ConsentCategories¶

Returns a list of consent categories.

Table Specific Information¶

Select¶

The connector 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 connector.

• IncludeInactive supports the = operator.

For example:

SELECT * FROM ConsentCategories WHERE IncludeInactive = true

Columns¶

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.

ConsentChannelCategories¶

Returns a list of valid consent channel category combinations.

Table Specific Information¶

Select¶

The connector 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 connector.

Columns¶

ConsentChannels¶

Represents the consent channel entity

Table Specific Information¶

Select¶

The connector 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 connector.

Columns¶

ConsentSources¶

Represents the consent source entity

Table Specific Information¶

Select¶

The connector 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 connector.

• IncludeInactive supports the = operator.

For example:

SELECT * FROM ConsentSources WHERE IncludeInactive = true

Columns¶

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.

ConstituentAppeals¶

Returns a list of appeals for a constituent.

Table Specific Information¶

Select¶

The connector 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 connector.

• ConstituentId supports the = operator.

For example:

SELECT * FROM ConstituentAppeals WHERE ConstituentId = '280'

Columns¶

ConstituentAttachments¶

Returns a list of attachments for a constituent.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: ConstituentId is required in order to query ConstituentAttachments.

• ConstituentId supports the = operator.

For example:

SELECT * FROM ConstituentAttachments WHERE ConstituentId = '280'

Columns¶

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 connector 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 connector.

• 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¶

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.

ConstituentConsents¶

Returns a list of constituent consent records.

Table Specific Information¶

Select¶

The connector 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 connector.
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¶

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.

ConstituentFundraiserAssignments¶

Returns a list of fundraiser assignments for a constituent.

Table Specific Information¶

Select¶

The connector 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 connector.
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¶

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.

Constituents¶

Returns a paginated list of constituents

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

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.

ConstituentsCustomFields¶

Retrieves custom fields for all constituents

Table Specific Information¶

Select¶

The connector 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 connector.

Columns¶

ConstituentSolicitCodes¶

Returns a list of solicit codes for the specified constituent.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: ConstituentId is required in order to query ConstituentSolicitCodes.

• ConstituentId supports the = operator.

For example:

SELECT * FROM ConstituentSolicitCodes WHERE ConstituentId = '280'

Columns¶

Countries¶

Returns the list of available countries.

Table Specific Information¶

Select¶

The connector 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 connector.

Columns¶

Educations¶

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

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

Emails¶

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

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

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.

EventCategories¶

Returns a list of active event categories.

Table Specific Information¶

Select¶

The connector 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 connector.

• IncludeInactive supports the = operator.

For example:

SELECT * FROM EventCategories WHERE IncludeInactive = true

Columns¶

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.

EventFees¶

Returns a list of fees for an event.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: EventId is required in order to query EventFees.

• EventId supports the = operator.

For example:

SELECT * FROM EventFees WHERE EventId = '2'

Columns¶

EventParticipantGuests¶

The participant's basic summary information

Table Specific Information¶

Select¶

The connector 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 connector.
Note: EventId is required in order to query EventParticipantGuests.

• EventId supports the = operator.

For example:

SELECT * FROM EventParticipantGuests WHERE EventId = '2'

Columns¶

EventParticipantMemberships¶

The individual's membership category

Table Specific Information¶

Select¶

The connector 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 connector.
Note: EventId is required in order to query EventParticipantMemberships.

• EventId supports the = operator.

For example:

SELECT * FROM EventParticipantMemberships WHERE EventId = '2'

Columns¶

EventParticipantOptions¶

Returns the participant options for an event.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: EventId is required in order to query EventParticipantOptions.

• EventId supports the = operator.

For example:

SELECT * FROM EventParticipantOptions WHERE EventId = '2'

Columns¶

EventParticipants¶

Returns a list of participants for an event.

Table Specific Information¶

Select¶

The connector 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 connector.
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¶

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.

Events¶

Returns a list of events

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

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.

FundAttachments¶

Returns a list of attachments for a fund.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: FundId is required in order to query FundAttachments.

• FundId supports the = operator.

For example:

SELECT * FROM FundAttachments WHERE FundId = '4'

Columns¶

FundraiserAssignments¶

Returns a list of assignments for a fundraiser.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: FundraiserId is required in order to query FundraiserAssignments.

• FundraiserId supports the = operator.

For example:

SELECT * FROM FundraiserAssignments WHERE FundraiserId = '4'

Columns¶

FundraiserGoals¶

Returns a list of goals for a fundraiser

Table Specific Information¶

Select¶

The connector 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 connector.
Note: FundraiserId is required in order to query FundraiserGoals.

• FundraiserId supports the = operator.

For example:

SELECT * FROM FundraiserGoals WHERE FundraiserId = '4'

Columns¶

FundraisingAppeals¶

Returns a list of fundraising appeals.

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

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.

Funds¶

Returns a list of funds.

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

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.

GetPledgeInstallments¶

This gets the installments of an existing pledge gift.

Columns¶

GetPledgePayments¶

This gets the payments of an existing pledge gift.

Columns¶

GiftAcknowledgements¶

Returns a list of acknowledgements for a gift

Table Specific Information¶

Select¶

The connector 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 connector.
Note: GiftId are required in order to query GiftAcknowledgements.

• GiftId supports the = operator.

For example:

SELECT * FROM GiftAcknowledgements WHERE GiftId = '476'

Columns¶

GiftAttachments¶

Returns a list of attachments for a gift.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: GiftId are required in order to query GiftAttachments.

• GiftId supports the = operator.

For example:

SELECT * FROM GiftAttachments WHERE GiftId = '476'

Columns¶

GiftBatches¶

Returns a list of gift batches.

Table Specific Information¶

Select¶

The connector 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 connector.

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

Columns¶

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.

GiftPayments¶

Returns payments for a gift.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: GiftId are required in order to query GiftPayments.

• GiftId supports the = operator.

For example:

SELECT * FROM GiftPayments WHERE GiftId = '476'

Columns¶

GiftReceipts¶

Returns receipts for a gift.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: GiftId are required in order to query GiftReceipts.

• GiftId supports the = operator.

For example:

SELECT * FROM GiftReceipts WHERE GiftId = '476'

Columns¶

Gifts¶

Returns a paginated list of gifts

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

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.

GiftsCustomFields¶

Retrieves custom fields for all gifts

Table Specific Information¶

Select¶

The connector 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 connector.

Columns¶

GiftSoftCredits¶

Returns soft credits for a gift.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: GiftId are required in order to query GiftSoftCredits.

• GiftId supports the = operator.

For example:

SELECT * FROM GiftSoftCredits WHERE GiftId = '476'

Columns¶

GiftSplits¶

Returns the splits for a gift.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: GiftId are required in order to query GiftSplits.

• GiftId supports the = operator.

For example:

SELECT * FROM GiftSplits WHERE GiftId = '476'

Columns¶

Giving¶

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

Table Specific Information¶

Select¶

The connector 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 connector.
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¶

GivingAppeals¶

Returns the giving appeals summary for the constituent

Table Specific Information¶

Select¶

The connector 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 connector.
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¶

GivingCampaigns¶

Returns the giving campaigns summary for the constituent

Table Specific Information¶

Select¶

The connector 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 connector.
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¶

GivingFunds¶

Returns the giving funds summary for the constituent

Table Specific Information¶

Select¶

The connector 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 connector.
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¶

LifetimeGiving¶

Returns the lifetime giving information for a constituent.

Table Specific Information¶

Select¶

The connector 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 connector.
Note: ConstituentId are required in order to query LifetimeGiving.

• ConstituentId supports the = operator.

For example:

SELECT * FROM LifetimeGiving WHERE ConstituentId = '280'

Columns¶

Lists¶

Returns a list of lists for the given list type

Table Specific Information¶

Select¶

The connector 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 connector.

• ListType supports the = operator.

For example:

SELECT * FROM Lists WHERE ListType = 'Constituent'

Columns¶

Members¶

Returns the list of members.

Table Specific Information¶

Select¶

The connector 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 connector.

• ConstituentId supports the = operator.

For example:

SELECT * FROM Members WHERE ConstituentId = '280'

Columns¶

Memberships¶

Returns a list of memberships.

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

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 connector 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 connector.

• 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¶

OnlinePresences¶

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

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

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.

Opportunities¶

Retrieves a list of opportunities

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

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.

OpportunitiesCustomFields¶

Retrieves custom fields for an opportunity

Columns¶

OpportunityAttachments¶

Returns a list of attachments for an opportunity

Table Specific Information¶

Select¶

The connector 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 connector.
Note: OpportunityId is required in order to query OpportunityAttachments.

• OpportunityId supports the = operator.

For example:

SELECT * FROM OpportunityAttachments WHERE OpportunityId = '4'

Columns¶

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 connector 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 connector.

• 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¶