Compartilhar via


Financial Edge NXT Query (Preview)

Blackbaud Financial Edge NXT is a comprehensive cloud-based accounting software solution built specifically for nonprofits. Use the Query connector to manage and execute queries.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Blackbaud Support
URL https://www.blackbaud.com/support
Email skyapi@blackbaud.com
Connector Metadata
Publisher Blackbaud. Inc
Website https://www.blackbaud.com/products/blackbaud-financial-edge-nxt
Privacy policy https://www.blackbaud.com/privacy-shield
Categories Sales and CRM;Productivity

Financial Edge NXT is a total cloud accounting solution designed specifically to meet the unique needs of nonprofits and government entities.

This connector is built on top of Blackbaud's SKY API, and provides operations to help manage queries and related entities found within Financial Edge NXT.

For more information, please view the documentation.

Prerequisites

To use this connector, you must have a Blackbaud ID account with access to one or more Blackbaud environments.

In addition, the Microsoft Power Platform application from the Blackbaud Marketplace must be connected to the environment. More information about these prerequisites can be found in the initial setup documentation.

How to get credentials?

Your organization's administrator will send you an invitation to the organization's Financial Edge NXT environment and configure your user account permissions within the environment. No additional credentials are required to use this connector.

Known issues and limitations

The connector will operate in the context of your user account, and will therefore be subject to your user permissions within the environment.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get query job status

Returns information about a background query execution job.

List queries

Returns a list of queries.

Start a query job

Starts a background job to execute the specified query.

Start a refresh static query job

Starts a background job to refresh the saved keys for the specified static query.

Start an ad hoc query job

Starts a background job to execute the specified ad hoc query definition.

Get query job status

Returns information about a background query execution job.

Parameters

Name Key Required Type Description
Module
module True string

The Financial Edge NXT module for the request.

Job ID
job_id True string

The system record ID of the query execution job.

Include results URL?
include_read_url string

Include the URL to the query results file?

Content disposition
content_disposition string

Indicates how the query results will be viewed.

Returns

Query execution job

List queries

Returns a list of queries.

Parameters

Name Key Required Type Description
Module
module True string

The Financial Edge NXT module for the request.

Type
query_type_id integer

Filter the set of queries to those with a specific query type.

Category
category integer

Filter the set of queries to those with a specific category.

Format
query_format string

Filter the set of queries to those with a specific format.

Search text
search_text string

The name field search text to filter the results.

My queries only?
my_queries_only boolean

Include only queries I created?

Merged queries only?
merged_queries_only boolean

Include only merged queries?

Sort column
sort_column string

Sort the results by the specified column.

Sort descending?
sort_descending boolean

Sort the results in descending order?

Limit
limit integer

Represents the number of records to return. The default is 50. The maximum is 500.

Offset
offset integer

Represents the number of records to skip. For use with pagination.

Returns

Queries

Start a query job

Starts a background job to execute the specified query.

Parameters

Name Key Required Type Description
Module
module True string

The Financial Edge NXT module for the request.

Type
v_query_type_id True integer

Filter the set of queries to those with a specific query type.

Query
id True integer

The query to execute.

Output format
output_format string

Indicates the output format for the query results file.

Formatting mode
formatting_mode string

Indicates whether and how formatting should be applied to the query results.

SQL generation mode
sql_generation_mode string

Indicates how query select fields should be handled. When 'Query' is selected, the output will include the select fields defined for the query plus QRECID. When 'Export' is selected, the output will include the select fields defined for the query ONLY. When 'Report' is selected, the output will ONLY include QRECID.

Use static query?
use_static_query_id_set boolean

Use the static query as the source of records (if not, the query will be executed dynamically)?

Returns

Started query job

Start a refresh static query job

Starts a background job to refresh the saved keys for the specified static query.

Parameters

Name Key Required Type Description
Module
module True string

The Financial Edge NXT module for the request.

Type
v_query_type_id True integer

Filter the set of queries to those with a specific query type.

Query
id True integer

The query to execute.

Returns

Started query job

Start an ad hoc query job

Starts a background job to execute the specified ad hoc query definition.

Parameters

Name Key Required Type Description
Module
module True string

The Financial Edge NXT module for the request.

Query definition
query True object

The JSON representation of the query definition.

Output format
output_format string

Indicates the output format for the query results file.

Formatting mode
formatting_mode string

Indicates whether and how formatting should be applied to the query results.

Returns

Started query job

Definitions

QueryApi.ExecuteQueryResponse

Started query job

Name Path Type Description
Job ID
id string

The query job identifier.

Status
status string

The resulting query job status. 'Pending' - the job has been queued but has not yet started running. 'Running' - the job is running. 'Completed' - the job completed successfully. 'Failed' - the job failed. 'Cancelling' - job cancellation has been requested (but may still complete successfully). 'Cancelled' - the job was canceled. 'Throttled' - the job has been throttled and will run when space is available.

Message
message string

A message associated with the response.

QueryApi.QueryExecutionJob

Query execution job

Name Path Type Description
Job ID
id string

The query job identifier.

Status
status string

The resulting query job status. 'Pending' - the job has been queued but has not yet started running. 'Running' - the job is running. 'Completed' - the job completed successfully. 'Failed' - the job failed. 'Cancelling' - job cancellation has been requested (but may still complete successfully). 'Cancelled' - the job was canceled. 'Throttled' - the job has been throttled and will run when space is available.

Row count
row_count integer

The number of records in the query.

Query results URI
sas_uri string

The URI for accessing the query results. This URI should be treated as a secure credential to access the query results - the value is considered sensitive, and the URI will expire after 15 minutes.

QueryApi.QuerySummary

Query

Name Path Type Description
ID
id integer

The system record ID of the query.

Name
name string

The unique name of the query.

Description
description string

The description of the query.

Type
type string

The type of the query.

Type ID
type_id integer

The system record ID of the query type.

Category
category string

The category of the query.

Category ID
category_id integer

The system record ID of the query category.

Format
format string

The query format.

View supported?
view_supported boolean

Is the query viewable?

Supported execution modes
supported_execution_modes string

The supported execution modes.

Can modify?
can_modify boolean

Can the user modify the query?

Can execute?
can_execute boolean

Can the user execute the query?

Others can modify?
others_can_modify boolean

Can other users modify the query?

Others can execute?
others_can_execute boolean

Can other users execute the query?

Suppress duplicates?
suppress_duplicates boolean

Are duplicates suppressed in the query results?

Select from query name
select_from_query_name string

The name of the query used as the base select for the query.

Select from query ID
select_from_query_id integer

The system record ID of the query used as the base select for the query.

Last run
date_last_run date-time

The date when the query was last run.

Number of records
num_records integer

The number of records found the last time the query was run.

Elapsed time
elapsed_ms integer

The elapsed time (in milliseconds) the last time the query was run.

Date created
date_added date-time

The date when the query was created.

Created by
added_by string

The name of the user that created the query.

Date changed
date_changed date-time

The date when the query was last changed.

Changed by
last_changed_by string

The name of the user that last changed the query.

QueryApi.QuerySummaryCollection

Queries

Name Path Type Description
queries
queries array of QueryApi.QuerySummary

The set of items included in the response.