Blackbaud FENXT General Ledger (Preview)
Blackbaud Financial Edge NXT is a comprehensive cloud-based accounting software solution built specifically for nonprofits. Use the General Ledger connector to manage the general ledger and related entities found within The Financial Edge NXT.
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) |
| Contact | |
|---|---|
| Name | Blackbaud Support |
| URL | https://www.blackbaud.com/support |
| 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 comprehensive cloud-based accounting software solution built specifically for nonprofits.
This connector is built on top of Blackbaud's SKY API, and provides operations to help manage the general ledger and related entities found within The 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, your organization's administrator must also perform an admin-level action within the system to enable this connector to access your Blackbaud 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
| Clear journal entries |
Remove all journal entries from the specified batch. |
| Create a journal entry (single distribution) |
Creates a new journal entry with a single distribution. |
| Create a journal entry (split distributions) |
Creates a new journal entry with split distributions. |
| Create a journal entry batch |
Creates a new journal entry batch. |
| Create a journal entry batch attachment |
Creates a new journal entry batch attachment. |
| Delete a journal entry batch |
Deletes a journal entry batch. |
| Get a journal entry batch summary |
Returns the journal entry batch summary. |
| List journal entries |
Returns a list of journal entries for a specified journal entry batch. |
| List journal entry batches |
Lists the available journal entry batches. |
| Post a journal entry batch |
Posts a journal entry batch. |
| Update a journal entry batch |
Updates a journal entry batch. |
| Validate a journal entry batch |
Validates a journal entry batch. |
Clear journal entries
Remove all journal entries from the specified batch.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Batch ID
|
batch_id | True | integer |
The system record ID of the journal entry batch to clear. |
Create a journal entry (single distribution)
Creates a new journal entry with a single distribution.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Batch ID
|
batch_id | True | integer |
The system record ID of the journal entry batch. |
|
body
|
body | True | dynamic |
The journal entry to create. |
Create a journal entry (split distributions)
Creates a new journal entry with split distributions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Batch ID
|
batch_id | True | integer |
The system record ID of the journal entry batch. |
|
body
|
body | True | dynamic |
The journal entry to create. |
Create a journal entry batch
Creates a new journal entry batch.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Description
|
description | True | string |
The journal entry batch description. Character limit: 60. |
|
Status
|
batch_status | True | string |
The journal entry batch status. |
|
Create adjustments?
|
create_bank_account_adjustments | boolean |
Create bank adjustments when posting to a bank's cash account? |
|
|
Add interfund entries?
|
create_interfund_sets | boolean |
Create interfund entries when the batch is posted? |
|
|
Source system name
|
source_system_name | string |
Name of source system that created the batch. |
|
|
Source base URL
|
source_base_url | string |
Base URL for the source system that created the batch. |
Returns
Created journal entry batch
Create a journal entry batch attachment
Creates a new journal entry batch attachment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Batch ID
|
parent_id | True | integer |
The system record ID of the journal entry batch containing the attachment. |
|
Type
|
type | True | string |
The attachment type. Physical attachments are uploaded files such as images, PDFs, or Word documents that are saved locally or on the network. They are stored and managed in the system. Link attachments are links to files such as images, blog posts, or YouTube videos that are online or in a cloud storage account. They are stored and managed externally. |
|
Name
|
name | True | string |
The name of the attachment. Character limit: 150. |
|
URL
|
url | string |
The URL for the attachment. This is required for link attachments and ignored for physical attachments. |
|
|
File contents
|
file | binary |
The binary contents of the file attachment. This is required for physical attachments and ignored for link attachments. |
|
|
File name
|
file_name | string |
The file name for the attachment. This is required for physical attachments and ignored for link attachments. |
|
|
Attachment type
|
media_type | True | string |
User-defined category of this attachment. Available values are the entries in the Media Type table for the parent record. Use the value types defined in /mediaTypes |
Returns
Created journal entry batch attachment
Delete a journal entry batch
Deletes a journal entry batch.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Batch ID
|
batch_id | True | integer |
The system record ID of the journal entry batch to delete. |
Get a journal entry batch summary
Returns the journal entry batch summary.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Batch ID
|
batch_id | True | integer |
The system record ID of the journal entry batch. |
Returns
Journal entry batch summary.
List journal entries
Returns a list of journal entries for a specified journal entry batch.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Batch ID
|
batch_id | True | integer |
The system record ID of the journal entry batch. |
|
Limit
|
limit | integer |
Represents the number of records to return. The default is 100. The maximum is 500. |
|
|
Offset
|
offset | integer |
Represents the number of records to skip. For use with pagination. |
Returns
Fetching data all at once quickly becomes unmanageable. The collection entity helps by returning paginated chunks of large data sets. This entity includes helpful metadata and properties to paginate and iterate through the data.
List journal entry batches
Lists the available journal entry batches.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Status
|
status | string |
The batch status. |
|
|
Search text
|
search_text | string |
Search text to match for journal entry batch ID or description. |
|
|
Limit
|
limit | integer |
Represents the number of records to return. The default is 100. The maximum is 500. |
|
|
Offset
|
offset | integer |
Represents the number of records to skip. For use with pagination. |
|
|
Modified on or after
|
last_modified | date-time |
Filter the results to journal entry batches modified on or after the specified date. |
Returns
Fetching data all at once quickly becomes unmanageable. The collection entity helps by returning paginated chunks of large data sets. This entity includes helpful metadata and properties to paginate and iterate through the data.
Post a journal entry batch
Posts a journal entry batch.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Batch ID
|
batch_id | True | integer |
The system record ID of the journal entry batch. |
Returns
Validation result
Update a journal entry batch
Updates a journal entry batch.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Batch ID
|
batch_id | True | integer |
The system record ID of the journal entry batch to update. |
|
Description
|
description | string |
The journal entry batch description. Character limit: 60. |
|
|
Status
|
batch_status | string |
The journal entry batch status. |
|
|
Create adjustments?
|
create_bank_account_adjustments | boolean |
Create bank adjustments when posting to a bank's cash account? |
|
|
Add interfund entries?
|
create_interfund_sets | boolean |
Create interfund entries when the batch is posted? |
|
|
Source system name
|
source_system_name | string |
Name of source system that created the batch. |
|
|
Source base URL
|
source_base_url | string |
Base URL for the source system that created the batch. |
Returns
Created journal entry batch
Validate a journal entry batch
Validates a journal entry batch.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Batch ID
|
batch_id | True | integer |
The system record ID of the journal entry batch. |
Returns
Validation result
Definitions
GLApi.CreatedJournalEntryBatch
Created journal entry batch
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
The ID of the newly created journal entry batch. |
GLApi.CreatedJournalEntryBatchAttachment
Created journal entry batch attachment
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
The ID of the newly created journal entry batch. |
GLApi.JournalEntry
Journal entry
| Name | Path | Type | Description |
|---|---|---|---|
|
Journal entry ID
|
journal_entry_id | integer |
The journal entry identifier. |
GLApi.JournalEntryBatch
Journal entry batch
| Name | Path | Type | Description |
|---|---|---|---|
|
Batch ID
|
batch_id | integer |
The system record ID for the batch. |
|
UI batch ID
|
ui_batch_id | string |
The user-defined identifier for the batch. |
|
Description
|
description | string |
The journal entry batch description. |
|
Status
|
batch_status | string |
The journal entry batch status. |
|
Create adjustments?
|
create_bank_account_adjustments | boolean |
Create bank adjustments when posting to a bank's cash account? |
|
Add interfund entries?
|
create_interfund_sets | boolean |
Create interfund entries when the batch is posted? |
|
Source system name
|
source_system_name | string |
Name of source system that created the batch. |
|
Source base URL
|
source_base_url | string |
Base URL for the source system that created the batch. |
|
Date added
|
date_added | date-time |
The date when the batch was created. |
|
Added by
|
added_by | string |
The name of the user who created the batch. |
|
Date modified
|
date_modified | date-time |
The date when the batch was last modified. |
|
Modified by
|
modified_by | string |
The name of the user who last modified the batch. |
GLApi.JournalEntryBatchCollection
Fetching data all at once quickly becomes unmanageable. The collection entity helps by returning paginated chunks of large data sets. This entity includes helpful metadata and properties to paginate and iterate through the data.
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
count | integer |
The number of items available for retrieval into the collection after applying any request parameters. |
|
value
|
value | array of GLApi.JournalEntryBatch |
The set of items included in the response. This may be a subset of the items in the collection. |
GLApi.JournalEntryBatchSummary
Journal entry batch summary.
| Name | Path | Type | Description |
|---|---|---|---|
|
Batch ID
|
BatchId | integer |
The system record ID for the batch. |
|
UI batch ID
|
UiBatchId | string |
The user-defined identifier for the batch. |
|
Description
|
Description | string |
The journal entry batch description. |
|
Status
|
BatchStatus | string |
The journal entry batch status. |
|
Create adjustments?
|
CreateBankAccountAdjustments | boolean |
Create bank adjustments when posting to a bank's cash account? |
|
Add interfund entries?
|
CreateInterfundSets | boolean |
Create interfund entries when the batch is posted? |
|
Total credits
|
TotalCredits | double |
Total credits in the journal entry batch. |
|
Total debits
|
TotalDebits | double |
Total debits in the journal entry batch. |
|
Source base URL
|
SourceBaseUrl | string |
Base URL for batch source system. |
|
Source system name
|
SourceSystemName | string |
Name of source system that created the batch. |
|
Date added
|
DateAdded | date-time |
The date when the journal entry batch was created. |
|
Added by
|
AddedBy | string |
The name of the user who created the journal entry batch. |
|
Date modified
|
DateModified | date-time |
The date when the journal entry batch was last modified. |
|
Modified by
|
ModifiedBy | string |
The name of the user who last modified the journal entry batch. |
GLApi.JournalEntryCollection
Fetching data all at once quickly becomes unmanageable. The collection entity helps by returning paginated chunks of large data sets. This entity includes helpful metadata and properties to paginate and iterate through the data.
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
count | integer |
The number of items available for retrieval into the collection after applying any request parameters. |
|
value
|
value | array of GLApi.JournalEntry |
The set of items included in the response. This may be a subset of the items in the collection. |
GLApi.ValidationResult
Validation result
| Name | Path | Type | Description |
|---|---|---|---|
|
Is valid?
|
is_valid | boolean |
Is the batch valid? |
|
Errors
|
errors | array of string |
The list of errors received during validation. |