Overview
Configuration is provided for establishing connections with the Blackbaud SKY API service. The configuration is used in the REST Connection Manager. To enable COZYROC application for your organization, please review the article posted here.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from a service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Quick Start
In this task, we will show you step-by-step how to create a connection to Blackbaud REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Blackbaud. Click New in the Token File parameter to create a new token file.
Step 3: Provide your subscription key. For further information how to get your subscription, please check the documentation page here.
Step 4: Provide email address and Password. Then press 'Sign in' button.
Step 5: Click 'Authorize' button to authorize access to your Blackbaud account.
Step 6: Save generated access token to file. Specify token protection password. Click OK.
Step 7. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Blackbaud instance.
In this guide, we will show how to read data from the Blackbaud service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Blackbaud connection from the combo. Select from available Blackbaud resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Blackbaud resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Blackbaud service.
In this guide, we will show how to write data to the Blackbaud service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Blackbaud connection from the combo. Also, select resource action and Blackbaud resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Blackbaud resource.
Configuration
Base URL address: https://api.sky.blackbaud.com.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- SubscriptionKey: Required. Specify subscription key.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}} -
Bb-Api-Subscription-Key:
{{=token.SubscriptionKey}}
Documentation: https://developer.blackbaud.com/skyapi/docs/authorization/auth-code-flow.
Based on resource template AP.
- [Read department] action
-
Endpoint URL address:
/departments.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListAccountsPayableDepartments.
- [Read buyer] action
-
Endpoint URL address:
/buyers.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListBuyers.
- [Read fob] action
-
Endpoint URL address:
/fobs.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListFOBs.
- [Read ship_via] action
-
Endpoint URL address:
/shipvia.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListShipVias.
- [Read staff] action
-
Endpoint URL address:
/staff.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListStaff.
- [Read transaction_code_value] action
-
Endpoint URL address:
/transactioncodes/{{=parameters.transaction_code_id}}/values.The action has the following user-defined parameters:
- transaction_code_id: Required. Specify transaction code identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListTransactionCodeValuesSingleTransactionCode.
- [Read uom] action
-
Endpoint URL address:
/unitsofmeasure.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListUnitsOfMeasure.
- id
Data type: DT_I4
- description
Template: ShortText.
- value
Template: ShortText.
- inactive
Data type: DT_BOOL
Based on resource template AP.
- [Read] action
-
Endpoint URL address:
/interfundsets.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListAccountsPayableInterfundSets.
- id
Data type: DT_I4
- description
Template: ShortText.
- value
Template: ShortText.
Based on resource template AP.
- [Read] action
-
Endpoint URL address:
/mediaTypes.
The result is extracted from:{{=response.results}}.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListAccountsPayableMediaTypes.
- type_id
Data type: DT_I4
- description
Template: ShortText.
- value
Template: ShortText.
Based on resource template AP.
- [Read] action
-
Endpoint URL address:
/products.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListAccountsPayableProducts.
- id
Data type: DT_I4
- description
Template: ShortText.
- code
Template: ShortText.
Based on resource template AP.
- [Read] action
-
Endpoint URL address:
/vendors/{{=parameters.vendor_id}}/addresses.
The result is extracted from:{{=response.results}}.The action has the following user-defined parameters:
- vendor_id: Required. Specify vendor identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListVendorAddressesSingleVendor.
- [Create] action
-
Endpoint URL address:
/vendors/{{=item.vendor_id}}/addresses.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/CreateVendorAddress.
- [Update] action
-
Endpoint URL address:
/vendors/{{=item.vendor_id}}/addresses/{{=item.address_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/EditVendorAddress.
- [Delete] action
-
Endpoint URL address:
/vendors/{{=item.vendor_id}}/addresses/{{=item.address_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/DeleteVendorAddress.
The resource includes the fields from the FAddress template.
- vendor_id
A key field. Data type: DT_I4
Based on resource template AP.
- [Read] action
-
Endpoint URL address:
/vendors/{{=parameters.vendor_id}}/creditmemos.The action has the following user-defined parameters:
- vendor_id: Required. Specify vendor identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListCreditMemosSingleVendor.
- [Create] action
-
Endpoint URL address:
/creditmemos.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/CreateCreditMemo.
- [Update] action
-
Endpoint URL address:
/creditmemos/{{=credit_memo_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/EditCreditMemo.
- [Delete] action
-
Endpoint URL address:
/creditmemos/{{=credit_memo_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/DeleteCreditMemo.
- credit_memo_id
A key field. Data type: DT_I4
- date
Template: DateTime.
- description
Template: ShortText.
- status
Template: ShortText.
- amount
Data type: DT_R8
- balance
Data type: DT_R8
- number
Template: ShortText.
- post_status
Template: ShortText.
- post_date
Template: DateTime.
- invoice_applications
Field components:
- An array.
- Contains the following components: invoice_number, date, amount_applied, invoice_id.
- date_added
Template: DateTime.
- date_modified
Template: DateTime.
- added_by
Template: ShortText.
- modified_by
Template: ShortText.
- vendor_id
Data type: DT_I4
- distributions
The value is gathered from
/creditmemos/{{=item.credit_memo_id}}address. Field components:- An array.
-
Uses template:
Distribution.
- form_1099_box_numbers
The value is gathered from
/creditmemos/{{=item.credit_memo_id}}address. Field components:- An array.
- Contains the following components: number, state, amount.
- [External]
-
The external fields URL address:
/creditmemos/customfields. The external fields list is extracted from:{{=response.results}}.- custom.{{=external.name}}
Data type: {{=Blackbaud.getDataType(external.type)}} ( length 255 ) The value is gathered from
/creditmemos/{{=item.credit_memo_id}}address. The gathered value is processed with{{=response[field.external.name]}}expression. Before setting, the value is processed with{{=value && { field_name: field.external.name, value: value } }}expression.
Based on resource template AP.
- [Read] action
-
Endpoint URL address:
/invoices.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListInvoices.
- [Create] action
-
Endpoint URL address:
/invoices.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/CreateInvoice.
- [Update] action
-
Endpoint URL address:
/invoices/{{=item.invoice_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/EditInvoice.
- invoice_id
A key field. Data type: DT_I4
- vendor_id
Data type: DT_I4
- invoice_number
Template: ShortText.
- invoice_date
Template: DateTime.
- vendor_name
Template: ShortText.
- vendor_status
Template: ShortText.
- amount
Data type: DT_R8
- description
Template: ShortText.
- status
Template: ShortText.
- post_status
Template: ShortText.
- post_date
Template: ShortText.
- balance
Data type: DT_R8
- is_past_due
Data type: DT_BOOL
- amount_due
Data type: DT_R8
- age
Template: ShortText.
- date_added
Template: DateTime.
- date_modified
Template: DateTime.
- added_by
Template: ShortText.
- modified_by
Template: ShortText.
- payment_method
Template: ShortText.
- purchase_order_number
Template: ShortText.
- approval_status
Template: ShortText.
- due_date
Template: DateTime.
- payment_details
Field components:
-
Uses template:
ShortText. - Contains the following components: remit_to, payment_method, paid_from, hold_payment, create_separate_payment, credit_card_account_id, credit_card_id.
-
Uses template:
- distribute_discounts
Data type: DT_BOOL
- [External]
-
The external fields URL address:
/invoices/customfields. The external fields list is extracted from:{{=response.results}}.- custom.{{=external.name}}
Data type: {{=Blackbaud.getDataType(external.type)}} ( length 255 ) The value is gathered from
/invoices/{{=item.invoice_id}}address. The gathered value is processed with{{=response[field.external.name]}}expression. Before setting, the value is processed with{{=value && { field_name: field.external.name, value: value } }}expression.
Based on resource template AP.
- [Read] action
-
Endpoint URL address:
/purchaseorders/{{=parameters.purchase_order_id}}/lineitems.The action has the following user-defined parameters:
- purchase_order_id: Required. Specify PO identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListLineItemsSinglePurchaseOrder.
- [Create] action
-
Endpoint URL address:
/purchaseorders/{{=item.purchase_order_id}}/lineitems.
The resource includes the fields from the LineItem template.
- purchase_order_id
Data type: DT_I4
Based on resource template AP.
- [Read] action
-
Endpoint URL address:
/purchaseorders.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListPurchaseOrders.
- [Create] action
-
Endpoint URL address:
/purchaseorders.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/CreatePurchaseOrder.
- purchase_order_id
A key field. Data type: DT_I4
- order_number
Template: ShortText.
- order_date
Template: DateTime.
- type
Template: ShortText.
- order_total
Data type: DT_R8
- receipted_total
Data type: DT_R4
- order_status
Template: ShortText.
- vendor_name
Template: ShortText.
- vendor_id
Data type: DT_I4
- terms
Template: ShortText.
- ship_to_address_id
Data type: DT_I4
- department
Template: ShortText.
- buyer
Template: ShortText.
- ship_via
Template: ShortText.
- fob
Template: ShortText.
- ordered_by
Template: ShortText.
- order_from_contact_id
Data type: DT_I4
- attention
Template: ShortText.
- comments
Template: ShortText.
- expiration_date
Template: DateTime.
- date_added
Template: DateTime. A read-only field.
- added_by
Template: ShortText. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- modified_by
Template: ShortText. A read-only field.
- line_items
The gathered value is processed with
{{=connection.resourceManager['Financial | Line Item'].getData({ parameters: ['purchase_order_id=' + item.purchase_order_id] })}}expression. Field components:- An array.
-
Uses template:
LineItem.
- [External]
-
The external fields URL address:
/purchaseorders/customfields. The external fields list is extracted from:{{=response.results}}.- custom.{{=external.name}}
Data type: {{=Blackbaud.getDataType(external.type)}} ( length 255 ) The value is gathered from
/purchaseorders/{{=item.purchase_order_id}}address. The gathered value is processed with{{=response[field.external.name]}}expression. Before setting, the value is processed with{{=value && { field_name: field.external.name, value: value } }}expression.
Based on resource template AP.
- [Read] action
-
Endpoint URL address:
/transactioncodes.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListTransactionCodes.
- transaction_code_id
Data type: DT_I4
- name
Template: ShortText.
- description
Template: ShortText.
- used_for_grants
Data type: DT_BOOL
Based on resource template AP.
- [Read] action
-
Endpoint URL address:
/vendors.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListVendors.
- [Create] action
-
Endpoint URL address:
/vendors.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/CreateVendor.
- [Update] action
-
Endpoint URL address:
/vendors/{{=item.vendor_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/EditVendor.
- vendor_id
A key field. Data type: DT_I4
- vendor_name
Template: ShortText.
- balance_due
Data type: DT_R8
- ui_defined_id
Template: ShortText.
- customer_number
Template: ShortText.
- vendor_status
Template: ShortText.
- issue_1099s
Data type: DT_BOOL
- primary_address
Template: FAddress.
- payment_method
Template: ShortText.
- payment_defaults
Field components:
-
Uses template:
ShortText. - Contains the following components: has_credit_limit, credit_limit, payment_terms, account_name, payment_method, payment_option.
-
Uses template:
- date_added
Template: DateTime. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- added_by
Template: ShortText. A read-only field.
- modified_by
Template: ShortText. A read-only field.
- address
Field components:
- An array.
-
Uses template:
FAddress.
- default_box_numbers
The value is gathered from
/vendors/{{=item.vendor_id}}/1099infoaddress. Field components:-
Uses template:
ShortText. - Contains the following components: number, state, percent.
-
Uses template:
- contacts
The value is gathered from
/vendors/{{=item.vendor_id}}/contactsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
- Contains the following components: vendor_contact_id, address_description, address_line, contact_display_name.
- [External]
-
The external fields URL address:
/vendors/customfields. The external fields list is extracted from:{{=response.results}}.- custom.{{=external.name}}
Data type: {{=Blackbaud.getDataType(external.type)}} ( length 255 ) The value is gathered from
/vendors/{{=item.vendor_id}}address. The gathered value is processed with{{=response[field.external.name]}}expression. Before setting, the value is processed with{{=value && { field_name: field.external.name, value: value } }}expression.
Based on resource template AP.
- [Read] action
-
Endpoint URL address:
/vendors/{{=parameters.vendor_id}}/attachments.The action has the following user-defined parameters:
- vendor_id: Required. Specify vendor identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListVendorAttachments.
- [Create] action
-
Endpoint URL address:
/vendors/attachments.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/CreateVendorAttachment.
- [Delete] action
-
Endpoint URL address:
/vendors/{{=item.vendor_id}}/attachments/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/DeleteVendorAttachment.
The resource includes the fields from the FAttachment template.
Based on resource template AP.
- [Read] action
-
Endpoint URL address:
/vendors/{{=parameters.vendor_id}}/defaultdistributions.The action has the following user-defined parameters:
- vendor_id: Required. Specify vendor identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListDefaultDistributionsSingleVendor.
The resource includes the fields from the Distribution template.
Based on resource template AP.
- [Read] action
-
Endpoint URL address:
/vendors/{{=parameters.vendor_id}}/notes.
The result is extracted from:{{=response.results}}.The action has the following user-defined parameters:
- vendor_id: Required. Specify vendor identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/ListVendorNotes.
- [Create] action
-
Endpoint URL address:
/vendors/{{=item.vendor_id}}/notes.Documentation: https://developer.sky.blackbaud.com/docs/services/57a342f1d7dcde1c28a749fe/operations/CreateVendorNote.
The resource includes the fields from the Note template.
- vendor_id
Data type: DT_I4
Based on resource template Constituent.
- [Read] action
-
Endpoint URL address:
/actions.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListActionsAllConstituents.
- [Create] action
-
Endpoint URL address:
/actions.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/CreateAction.
- [Update] action
-
Endpoint URL address:
/actions/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditAction.
- [Delete] action
-
Endpoint URL address:
/actions/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/DeleteAction.
The resource includes the fields from the Action template.
- attachments
The gathered value is processed with
{{=connection.resourceManager['Church | Action Attachment'].getData({ parameters: ['action_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
CAttachment.
Based on resource template Constituent.
- [Read] action
-
Endpoint URL address:
/actions/{{=parameters.action_id}}/attachments.The action has the following user-defined parameters:
- action_id: Required. Specify action identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListActionAttachmentsSingleAction.
- [Create] action
-
Endpoint URL address:
/actions/attachments.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/CreateActionAttachment.
- [Update] action
-
Endpoint URL address:
/actions/attachments/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditActionAttachment.
- [Delete] action
-
Endpoint URL address:
/actions/attachments/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/DeleteActionAttachment.
The resource includes the fields from the CAttachment template.
Based on resource template Constituent.
- [Read] action
-
Endpoint URL address:
/addresses.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListConstituentAddressesAllConstituents.
- [Create] action
-
Endpoint URL address:
/addresses.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/CreateConstituentAddress.
- [Update] action
-
Endpoint URL address:
/addresses/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditConstituentAddress.
- [Delete] action
-
Endpoint URL address:
/addresses/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/DeleteConstituentAddress.
The resource includes the fields from the CAddress template.
Based on resource template Constituent.
- [Read] action
-
Endpoint URL address:
/constituents/{{=parameters.constituent_id}}/aliases.The action has the following user-defined parameters:
- constituent_id: Required. Specify constituent identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListConstituentAliasesSingleConstituent.
- [Create] action
-
Endpoint URL address:
/aliases.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/CreateConstituentAlias.
- [Update] action
-
Endpoint URL address:
/aliases/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditConstituentAlias.
- [Delete] action
-
Endpoint URL address:
/aliases/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/DeleteConstituentAlias.
The resource includes the fields from the Alias template.
Based on resource template Constituent.
- [Read] action
-
Endpoint URL address:
/constituents.The following request parameters will be automatically processed:
-
fields:
{{=_.filter(parameters.fields, function(field) { return field.indexOf('.') == -1; }).join()}}
Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListConstituents.
-
fields:
- [Read search] action
-
Endpoint URL address:
/constituents/search.The action has the following user-defined parameters:
- search_text: Required. Specify the text to search for.
Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/SearchConstituent.
- [Create] action
-
Endpoint URL address:
/constituents.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/CreateConstituent.
- [Update] action
-
Endpoint URL address:
/constituents/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditConstituent.
- id
A key field. Template: ShortText.
- address
Template: CAddress.
- age
Data type: DT_I4
- birthdate
Template: FuzzyDate.
- date_added
Template: DateTime. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- deceased
Data type: DT_BOOL
- deceased_date
Template: FuzzyDate.
Template: EmailAddress.
- first
Template: ShortText.
- former_name
Template: ShortText.
- fundraiser_status
Template: ShortText.
- gender
Template: ShortText.
- gives_anonymously
Data type: DT_BOOL
- inactive
Data type: DT_BOOL
- last
Template: ShortText.
- lookup_id
Template: ShortText.
- marital_status
Template: ShortText.
- middle
Template: ShortText.
- name
Template: ShortText.
- online_presence
Field components:
-
Uses template:
ShortText. - Contains the following components: address, inactive, primary, type.
-
Uses template:
- phone
Template: Phone. Field components:
-
Uses template:
ShortText. - Contains the following components: id, constituent_id, do_not_call, inactive, number, primary, type.
-
Uses template:
- preferred_name
Template: ShortText.
- suffix
Template: ShortText.
- suffix_2
Template: ShortText.
- title
Template: ShortText.
- title_2
Template: ShortText.
- type
Template: ShortText.
- primary_addressee
Template: PrimaryNameFormat.
- primary_salutation
Template: PrimaryNameFormat.
- actions
The value is gathered from
/constituents/{{=item.id}}/actionsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
-
Uses template:
Action.
- addresses
The value is gathered from
/constituents/{{=item.id}}/addressesaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
-
Uses template:
CAddress.
- aliases
The gathered value is processed with
{{=connection.resourceManager['Church | Constituent Alias'].getData({ parameters: ['constituent_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Alias.
- communication_preferences
The value is gathered from
/constituents/{constituent_id}/communicationpreferencesaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
- Contains the following components: id, constituent_id, end, solicit_code, start.
- attachments
The gathered value is processed with
{{=connection.resourceManager['Church | Constituent Attachment'].getData({ parameters: ['constituent_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
CAttachment.
- codes
The value is gathered from
/constituents/{{=item.id}}/constituentcodesaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
-
Uses template:
ConstituentCode.
- appeals
The value is gathered from
/constituents/{{=item.id}}/appealsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
- Contains the following components: id, appeal, date, package.
- educations
The value is gathered from
/constituents/{{=item.id}}/educationsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
-
Uses template:
Education.
- fundraiser_assignments
The value is gathered from
/constituents/{{=item.id}}/fundraiserassignmentsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
- Contains the following components: id, amount, appeal_id, campaign_id, constituent_id, end, fundraiser_id, start, type.
- memberships
The value is gathered from
/constituents/{{=item.id}}/membershipsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
- Contains the following components: id, category, dues, expires, joined, members, program, standing, subcategory.
- notes
The value is gathered from
/constituents/{{=item.id}}/notesaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
-
Uses template:
Note.
- profile_picture
Data type: DT_IMAGE The value is gathered from
/constituents/{{=item.id}}/profilepictureaddress. The gathered value is processed with{{=connection.execute({ url: response.url })}}expression.- ratings
The value is gathered from
/constituents/{{=item.id}}/ratingsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
- Contains the following components: id, category, comment, constituent_id, date, inactive, source, type, value.
- relationships
The value is gathered from
/constituents/{{=item.id}}/relationshipsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
-
Uses template:
CRelationship.
Based on resource template Constituent.
- [Read] action
-
Endpoint URL address:
/constituents/{{=parameters.constituent_id}}/attachments.The action has the following user-defined parameters:
- constituent_id: Required. Specify constituent identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListConstituentAttachmentsSingleConstituent.
- [Create] action
-
Endpoint URL address:
/constituents/attachments.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/CreateConstituentAttachment.
- [Update] action
-
Endpoint URL address:
/constituents/attachments/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditConstituentAttachment.
- [Delete] action
-
Endpoint URL address:
/constituents/attachments/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/DeleteConstituentAttachment.
The resource includes the fields from the CAttachment template.
Based on resource template Constituent.
- [Read] action
-
Endpoint URL address:
/constituents/constituentcodes.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListConstituentCodesAllConstituents.
- [Create] action
-
Endpoint URL address:
/constituentcodes.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/CreateConstituentCode.
- [Update] action
-
Endpoint URL address:
/constituentcodes/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditConstituentCode.
- [Delete] action
-
Endpoint URL address:
/constituentcodes/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/DeleteConstituentCode.
The resource includes the fields from the ConstituentCode template.
Based on resource template Constituent.
- [Read] action
-
Endpoint URL address:
/educations.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListConstituentEducationsAllConstituents.
- [Create] action
-
Endpoint URL address:
/educations.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/CreateConstituentEducation.
- [Update] action
-
Endpoint URL address:
/educations/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditConstituentEducation.
- [Delete] action
-
Endpoint URL address:
/educations/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/DeleteConstituentEducation.
The resource includes the fields from the Education template.
Based on resource template Constituent.
- [Read] action
-
Endpoint URL address:
/emailaddresses.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListConstituentEmailAddressesAllConstituents.
- [Create] action
-
Endpoint URL address:
/emailaddresses.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/CreateConstituentEmailAddress.
- [Update] action
-
Endpoint URL address:
/emailaddresses/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditConstituentEmailAddress.
- [Delete] action
-
Endpoint URL address:
/emailaddresses/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/DeleteConstituentEmailAddress.
The resource includes the fields from the EmailAddress template.
- date_added
Template: DateTime. A read-only field.
- date_modified
Template: DateTime. A read-only field.
Based on resource template Constituent.
- [Read] action
-
Endpoint URL address:
/notes.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListConstituentNotesAllConstituents.
- [Create] action
-
Endpoint URL address:
/notes.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/CreateConstituentNote.
- [Update] action
-
Endpoint URL address:
/notes/{{=item.note_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditConstituentNote.
- [Delete] action
-
Endpoint URL address:
/notes/{{=item.note_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditConstituentNote.
The resource includes the fields from the Note template.
Based on resource template Constituent.
- [Read] action
-
Endpoint URL address:
/onlinepresences.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListConstituentOnlinePresencesAllConstituents.
- [Create] action
-
Endpoint URL address:
/onlinepresences.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/CreateConstituentOnlinePresence.
- [Update] action
-
Endpoint URL address:
/onlinepresences/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditConstituentOnlinePresence.
- [Delete] action
-
Endpoint URL address:
/onlinepresences/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/DeleteConstituentOnlinePresence.
- id
A key field. Template: ShortText.
- address
Template: ShortText.
- constituent_id
Template: ShortText.
- date_added
Template: DateTime. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- inactive
Data type: DT_BOOL
- primary
Data type: DT_BOOL
- type
Template: ShortText.
Based on resource template Constituent.
- [Read] action
-
Endpoint URL address:
/phones.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListConstituentPhonesAllConstituents.
- [Create] action
-
Endpoint URL address:
/phones.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/CreateConstituentPhone.
- [Update] action
-
Endpoint URL address:
/phones/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditConstituentPhone.
- [Delete] action
-
Endpoint URL address:
/phones/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/DeleteConstituentPhone.
The resource includes the fields from the Phone template.
- date_added
Template: DateTime. A read-only field.
- date_modified
Template: DateTime. A read-only field.
Based on resource template Constituent.
- [Read] action
-
Endpoint URL address:
/relationships.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListConstituentRelationshipsAllConstituents.
- [Create] action
-
Endpoint URL address:
/relationships.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/CreateConstituentRelationship.
- [Update] action
-
Endpoint URL address:
/relationships/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/EditConstituentRelationship.
- [Delete] action
-
Endpoint URL address:
/relationships/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/DeleteConstituentRelationship.
The resource includes the fields from the CRelationship template.
Based on resource template Fundraising.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entity}}.The action has the following user-defined parameters:
- entity: Required. Specify entity type: appeals, campaigns, funds
- id
A key field. Template: ShortText.
- category
Template: ShortText.
- date_added
Template: DateTime. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- description
Template: ShortText.
- end_date
Template: DateTime.
- goal
Field components:
- Contains the following components: value.
- inactive
Data type: DT_BOOL
- lookup_id
Template: ShortText.
- start_date
Template: DateTime.
- type
Template: ShortText.
- attachments
The value is gathered from
/{{=parameters.entity}}/{{=item.id}}/attachmentsaddress. Field components:- An array.
-
Uses template:
CAttachment.
Based on resource template Fundraising.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entity}}/{{=parameters.entity_id}}/attachments.The action has the following user-defined parameters:
- entity: Required. Specify entity type: appeals, campaigns, funds
- entity_id: Required. Specify entity identifier.
- [Create] action
-
Endpoint URL address:
/appeals/attachments.The action has the following user-defined parameters:
- entity: Required. Specify entity type: appeals, campaigns, funds
- [Update] action
-
Endpoint URL address:
/{{=parameters.entity}}/attachments/{{=item.id}}.The action has the following user-defined parameters:
- entity: Required. Specify entity type: appeals, campaigns, funds
- [Delete] action
-
Endpoint URL address:
/{{=parameters.entity}}/attachments/{{=item.id}}.The action has the following user-defined parameters:
- entity: Required. Specify entity type: appeals, campaigns, funds
The resource includes the fields from the CAttachment template.
Based on resource template Fundraising.
- [Read] action
-
Endpoint URL address:
/packages.Documentation: https://developer.sky.blackbaud.com/docs/services/58bdd6c8d7dcde06046081d7/operations/ListPackages.
- id
A key field. Template: ShortText.
- appeal_id
Template: ShortText.
- date_added
Template: DateTime. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- default_gift_amount
Field components:
- Contains the following components: value.
- description
Template: ShortText.
- goal
Field components:
- Contains the following components: value.
- inactive
Data type: DT_BOOL
- lookup_id
Template: ShortText.
- notes
Template: ShortText.
- recipient_count
Data type: DT_I4
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/accounts.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/SearchAccounts.
- account_id
A key field. Data type: DT_I4
- account_number
Template: ShortText.
- description
Template: ShortText.
- prevent_data_entry
Data type: DT_BOOL
- prevent_posting_date
Template: ShortText.
- class
Template: ShortText.
- cashflow
Template: ShortText.
- working_capital
Template: ShortText.
- default_transaction_codes
Field components:
- An array.
- Contains the following components: id, name, value.
- date_added
Template: DateTime. A read-only field.
- added_by
Template: ShortText. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- modified_by
Template: ShortText. A read-only field.
- [External]
-
The external fields URL address:
/accounts/customfields. The external fields list is extracted from:{{=response.results}}.- custom.{{=external.name}}
Data type: {{=Blackbaud.getDataType(external.type)}} ( length 255 ) The gathered value is processed with
{{=item[field.external.name]}}expression. Before setting, the value is processed with{{=value && { field_name: field.external.name, value: value } }}expression.
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/accounts/codes.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListAccountCodes.
- account_code_id
Data type: DT_I4
- value
Data type: DT_I4
- category
Template: ShortText.
- class
Template: ShortText.
- is_contra
Data type: DT_BOOL
- is_control
Data type: DT_BOOL
- description
Template: ShortText.
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/accounts/funds.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListAccountFunds.
- fund_id
Data type: DT_I4
- value
Template: ShortText.
- description
Template: ShortText.
- beginning_balances_locked
Template: DateTime.
- fund_balance_account
Template: ShortText.
- fund_requirements
Field components:
- An array.
- Contains the following components: name, type, preserve_details_during_closing, require_to_balance, require_on_accounts_specified, default.
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/budgets.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListBudgets.
- [Create] action
-
Endpoint URL address:
/budgets.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/CreateBudget.
- [Update] action
-
Endpoint URL address:
/budgets/{{{=item.budget_scenario_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/EditBudget.
- budget_scenario_id
A key field. Data type: DT_I4
- description
Template: ShortText.
- start_fiscal_year
Template: ShortText.
- end_fiscal_year
Template: ShortText.
- start_date
Template: DateTime.
- end_date
Template: DateTime.
- status
Template: ShortText.
- budget_type
Template: ShortText.
- locked
Template: ShortText.
- scenario_id
Template: ShortText.
- lines
The value is gathered from
/budgets/{{=item.budget_scenario_id}}/details/linesaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
- Contains the following components: account_number, account_description, project_id, budget_line_id, ui_project_id, project_description, grant_description, notes, total, periods.
- accounts
The gathered value is processed with
{{=connection.resourceManager['Financial | Budget Account'].getData({ parameters: ['scenario_id=' + item.budget_scenario_id] })}}expression. Field components:- An array.
-
Uses template:
BudgetAccount.
- grants
The value is gathered from
/budgets/{{=item.budget_scenario_id}}/grantsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
- Contains the following components: budget_category, account_number, grant, fiscal_year, total_amount, fiscal_period, period_amount, period_percent.
- projects
The value is gathered from
/budgets/{{=item.budget_scenario_id}}/projectsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
- Contains the following components: budget_category, account_number, ui_project_id, fiscal_year, total_amount, fiscal_period, period_amount, period_percent.
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/budgets/{{=parameters.scenario_id}}/accounts.The action has the following user-defined parameters:
- scenario_id: Required. Specify budget scenario identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListBudgetAccounts.
The resource includes the fields from the BudgetAccount template.
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/budgets/scenarios.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListBudgetScenarios.
- [Create] action
-
Endpoint URL address:
/budgets/scenarios.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/CreateBudgetScenario.
- id
A key field. Data type: DT_I4
- value
Template: ShortText.
- description
Template: ShortText.
- inactive
Data type: DT_BOOL
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/distributionsets/cashmanagement.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListCashManagementDistributionSets.
- [Create] action
-
Endpoint URL address:
/distributionsets/cashmanagement.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/CreateCashManagementDistributionSet.
- [Update] action
-
Endpoint URL address:
/distributionsets/cashmanagement/{{=item.set_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/EditCashManagementDistributionSet.
- [Delete] action
-
Endpoint URL address:
/distributionsets/cashmanagement/{{=item.set_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/DeleteCashManagementDistributionSet.
- set_id
Data type: DT_I4
- name
Template: ShortText.
- line_items
Field components:
- An array.
- Contains the following components: percent, row_number, account_id, custom_fields, project_line_items.
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/grants.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListGrants.
- grant_id
A key field. Data type: DT_I4
- ui_grant_id
Template: ShortText.
- description
Template: ShortText.
- amount
Data type: DT_R8
- type
Template: ShortText.
- status
Template: ShortText.
- start_date
Template: DateTime.
- end_date
Template: DateTime.
- transaction_code_value
Template: ShortText.
- date_added
Template: DateTime. A read-only field.
- added_by
Template: ShortText. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- modified_by
Template: ShortText. A read-only field.
- contacts
The value is gathered from
/grants/{{=item.grant_id}}/contactsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
- Contains the following components: contact_id, description, country, city, county, state, address_line, postal, title, first_name, middle_name, last_name, suffix, position, address_contact_methods.
- projects
The value is gathered from
/grants/{{=item.grant_id}}/projectsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
- Contains the following components: project_id, description, ui_project_id.
- [External]
-
The external fields URL address:
/grants/customfields. The external fields list is extracted from:{{=response.results}}.- custom.{{=external.name}}
Data type: {{=Blackbaud.getDataType(external.type)}} ( length 255 ) The value is gathered from
/grants/{{=item.grant_id}}address. The gathered value is processed with{{=response[field.external.name]}}expression. Before setting, the value is processed with{{=value && { field_name: field.external.name, value: value } }}expression.
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/journalentrybatches/{{=parameters.batch_id}}/journalentries.The action has the following user-defined parameters:
- batch_id: Required. Specify batch identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListJournalEntriesSingleJournalEntryBatch.
- [Create] action
-
Endpoint URL address:
/journalentrybatches/{{=item.batch_id}}/journalentries.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/CreateJournalEntries.
- [Update] action
-
Endpoint URL address:
/journalentrybatches/{{=item.batch_id}}/journalentries/{{=item.journal_entry_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/EditJournalEntry.
- journal_entry_id
A key field. Data type: DT_I4
- type_code
Template: ShortText.
- line_number
Data type: DT_I4
- account_number
Template: ShortText.
- post_date
Template: DateTime.
- encumbrance
Template: ShortText.
- journal
Template: ShortText.
- reference
Template: ShortText.
- amount
Data type: DT_R8
- notes
Template: ShortText.
- distributions
Field components:
- An array.
- Contains the following components: distribution_id, ui_project_id, account_class, transaction_code_values, amount, percent.
- reverse_date
Template: ShortText.
- reverse_transaction_id
Data type: DT_I4
- batch_id
Data type: DT_I4
- [External]
-
The external fields URL address:
/journalentrybatches/customfields. The external fields list is extracted from:{{=response.results}}.- custom.{{=external.name}}
Data type: {{=Blackbaud.getDataType(external.type)}} ( length 255 ) The gathered value is processed with
{{=item[field.external.name]}}expression. Before setting, the value is processed with{{=value && { field_name: field.external.name, value: value } }}expression.
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/journalentrybatches.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListJournalEntryBatches.
- [Create] action
-
Endpoint URL address:
/journalentrybatches.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/CreateJournalEntryBatch.
- [Update] action
-
Endpoint URL address:
/journalentrybatches/{{=item.batch_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/EditJournalEntryBatch.
- [Delete] action
-
Endpoint URL address:
/journalentrybatches/{{=item.batch_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/DeleteJournalEntryBatch.
- batch_id
A key field. Data type: DT_I4
- ui_batch_id
Template: ShortText.
- description
Template: ShortText.
- batch_status
Template: ShortText.
- create_interfund_sets
Template: ShortText.
- create_bank_account_adjustments
Template: ShortText.
- date_added
Template: DateTime. A read-only field.
- added_by
Template: ShortText. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- modified_by
Template: ShortText. A read-only field.
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/summary/{{=parameters.fiscal_year_id}}.The action has the following user-defined parameters:
- fiscal_year_id: Required. Specify fiscal year identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListLedgerSummaries.
The resource includes the fields from the GLSummary template.
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/periodsummary/summaries.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListPeriodSummaries.
The resource includes the fields from the GLSummary template.
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/projects.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/SearchProjects.
- [Create] action
-
Endpoint URL address:
/projects.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/CreateProject.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/EditProject.
- project_id
A key field. Data type: DT_I4
- description
Template: ShortText.
- ui_project_id
Template: ShortText.
- start_date
Template: DateTime.
- end_date
Template: DateTime.
- location
Template: ShortText.
- division
Template: ShortText.
- department
Template: ShortText.
- type
Template: ShortText.
- status
Template: ShortText.
- prevent_data_entry
Data type: DT_BOOL
- prevent_posting_after
Data type: DT_BOOL
- posting_date
Template: ShortText.
- account_restrictions
Field components:
-
Uses template:
ShortText. - Contains the following components: allow_or_restrict, criteria.
-
Uses template:
- contacts
Field components:
- An array.
- Contains the following components: contact_id, description, country, city, county, state, address_line, postal, title, first_name, middle_name, last_name, suffix, position, address_contact_methods.
- date_added
Template: DateTime. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- added_by
Template: ShortText. A read-only field.
- modified_by
Template: ShortText. A read-only field.
- attachments
The value is gathered from
/projects/{{=item.project_id}}/attachmentsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
-
Uses template:
FAttachment.
- notes
The value is gathered from
/projects/{{=item.project_id}}/notesaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
-
Uses template:
Note.
- [External]
-
The external fields URL address:
/projects/customfields. The external fields list is extracted from:{{=response.results}}.- custom.{{=external.name}}
Data type: {{=Blackbaud.getDataType(external.type)}} ( length 255 ) The gathered value is processed with
{{=item[field.external.name]}}expression. Before setting, the value is processed with{{=value && { field_name: field.external.name, value: value } }}expression.
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/projects/{{=parameters.project_id}}/attachments.The action has the following user-defined parameters:
- project_id: Required. Specify project identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListProjectAttachments.
- [Create] action
-
Endpoint URL address:
/projects/attachments.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/CreateProjectAttachment.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.parent_id}}/attachments/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/DeleteProjectAttachment.
The resource includes the fields from the FAttachment template.
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/projects/{{=parameters.project_id}}/notes.The action has the following user-defined parameters:
- project_id: Required. Specify project identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/GetProjectNotes.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/notes.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/CreateProjectNote.
The resource includes the fields from the Note template.
- project_id
Data type: DT_I4
Based on resource template GL.
- [Read] action
-
Endpoint URL address:
/transactiondistributions.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListTransactionDistributions.
- transaction_id
A key field. Data type: DT_I4
- transaction_amount
Data type: DT_R8
- distribution_id
Data type: DT_I4
- batch_id
Data type: DT_I4
- ui_batch_id
Data type: DT_I4
- distribution_amount
Data type: DT_R8
- account_number
Template: ShortText.
- account_class
Template: ShortText.
- ui_project_id
Template: ShortText.
- post_date
Template: DateTime.
- type_code
Template: ShortText.
- reference
Template: ShortText.
- journal
Template: ShortText.
- encumbrance
Template: ShortText.
- transaction_code_values
Field components:
- An array.
- Contains the following components: name, value, id.
- date_added
Template: DateTime. A read-only field.
- added_by
Template: ShortText. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- modified_by
Template: ShortText. A read-only field.
- post_status
Template: ShortText.
- [Read] action
-
Endpoint URL address:
/distributionsets/transaction.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/ListTransactionDistributionSets.
- [Create] action
-
Endpoint URL address:
/distributionsets/transaction.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/CreateTransactionDistributionSet.
- [Update] action
-
Endpoint URL address:
/distributionsets/transaction/{{=item.set_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/EditTransactionDistributionSet.
- [Delete] action
-
Endpoint URL address:
/distributionsets/transaction/{{=item.set_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/56eb17a0a9db9516c46bff6f/operations/DeleteTransactionDistributionSet.
- set_id
A key field. Data type: DT_I4
- name
Template: ShortText.
- line_items
Field components:
- An array.
- Contains the following components: percent, line_number, project_id, transaction_code_values, account_class.
Based on resource template Gift.
- [Read] action
-
Endpoint URL address:
/gifts/{{=parameters.gift_id}}/attachments.The action has the following user-defined parameters:
- gift_id: Required. Specify gift identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/58bdd5edd7dcde06046081d6/operations/ListGiftAttachmentsSingleGift.
- [Create] action
-
Endpoint URL address:
/gifts/attachments.Documentation: https://developer.sky.blackbaud.com/docs/services/58bdd5edd7dcde06046081d6/operations/CreateGiftAttachment.
- [Update] action
-
Endpoint URL address:
/gifts/attachments/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/58bdd5edd7dcde06046081d6/operations/EditGiftAttachment.
- [Delete] action
-
Endpoint URL address:
/gifts/attachments/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/58bdd5edd7dcde06046081d6/operations/DeleteGiftAttachment.
The resource includes the fields from the CAttachment template.
Based on resource template Gift.
- [Read] action
-
Endpoint URL address:
/gifts.Documentation: https://developer.sky.blackbaud.com/docs/services/58bdd5edd7dcde06046081d6/operations/ListGifts.
- [Create] action
-
Endpoint URL address:
/gifts.Documentation: https://developer.sky.blackbaud.com/docs/services/58bdd5edd7dcde06046081d6/operations/CreateGift.
- [Update] action
-
Endpoint URL address:
/gifts/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/58bdd5edd7dcde06046081d6/operations/EditGift.
- [Delete] action
-
Endpoint URL address:
/gifts/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/58bdd5edd7dcde06046081d6/operations/DeleteGift.
- id
A key field. Template: ShortText.
- acknowledgements
Field components:
- An array.
- amount
Field components:
- Contains the following components: value.
- balance
Field components:
- Contains the following components: value.
- batch_number
Template: ShortText.
- constituent_id
Template: ShortText.
- date
Template: DateTime.
- date_added
Template: DateTime. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- gift_splits
Field components:
- An array.
- Contains the following components: id, amount, campaign_id, fund_id.
- gift_status
Template: ShortText.
- is_anonymous
Data type: DT_BOOL
- constituency
Template: ShortText.
- lookup_id
Template: ShortText.
- payments
Field components:
- An array.
- post_status
Template: ShortText.
- receipts
Field components:
- An array.
- Contains the following components: amount, date, status.
- reference
Template: ShortText.
- subtype
Template: ShortText.
- type
Template: ShortText.
Based on resource template Opportunity.
- [Read] action
-
Endpoint URL address:
/opportunities/{{=parameters.opportunity_id}}/attachments.The action has the following user-defined parameters:
- opportunity_id: Required. Specify opportunity identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2597c1af25c58b9c4e3/operations/ListOpportunityAttachmentsSingleOpportunity.
- [Create] action
-
Endpoint URL address:
/opportunities/attachments.Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2597c1af25c58b9c4e3/operations/CreateOpportunityAttachment.
- [Update] action
-
Endpoint URL address:
/opportunities/attachments/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2597c1af25c58b9c4e3/operations/EditOpportunityAttachment.
- [Delete] action
-
Endpoint URL address:
/opportunities/attachments/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2597c1af25c58b9c4e3/operations/DeleteOpportunityAttachment.
The resource includes the fields from the CAttachment template.
Based on resource template Opportunity.
- [Read] action
-
Endpoint URL address:
/opportunities.Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2597c1af25c58b9c4e3/operations/ListOpportunities.
- [Create] action
-
Endpoint URL address:
/opportunities.Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2597c1af25c58b9c4e3/operations/CreateOpportunity.
- [Update] action
-
Endpoint URL address:
/opportunities/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2597c1af25c58b9c4e3/operations/EditOpportunity.
- id
A key field. Template: ShortText.
- ask_amount
Field components:
- Contains the following components: value.
- ask_date
Template: DateTime.
- campaign_id
Template: ShortText.
- constituent_id
Template: ShortText.
- date_added
Template: DateTime. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- deadline
Template: ShortText.
- expected_amount
Field components:
- Contains the following components: value.
- expected_date
Template: DateTime.
- funded_amount
Field components:
- Contains the following components: value.
- funded_date
Template: DateTime.
- fundraisers
Field components:
- An array.
- Contains the following components: constituent_id, credit_amount.
- fund_id
Template: ShortText.
- inactive
Data type: DT_BOOL
- linked_gifts
Template: LongText. A composite field.
- name
Template: ShortText.
- purpose
Template: ShortText.
- status
Template: ShortText.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/addresses.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersByUser_idAddressesGet.
- [Create] action
-
Endpoint URL address:
/users/{{=item.user_id}}/addresses.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersByUser_idAddressesPost.
- [Update] action
-
Endpoint URL address:
/users/{{=item.user_id}}/addresses/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersByUser_idAddressesByAddress_idPatch.
The resource includes the fields from the SAddress template.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/attendance.The action has the following user-defined parameters:
- level_id: Required. Specify school level Id.
- day: Required. Specify date to return attendance for.
- offering_type: Required. Specify offering_type to retreive record for.
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AttendanceGet.
- [Create] action
-
Endpoint URL address:
/attendance.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AttendancePost.
- id
A key field. Data type: DT_I4
- attendance_of_record
Data type: DT_BOOL
- attendance_type
Data type: DT_BOOL
- block_name
Template: ShortText.
- comment
Template: ShortText.
- date
Template: DateTime.
- excuse_category_description
Template: ShortText.
- excuse_category_id
Data type: DT_I4
- excuse_description
Template: ShortText.
- excuse_type_id
Data type: DT_I4
- excused
Data type: DT_I4
- grad_year
Template: ShortText.
- grade
Template: ShortText.
- grade_level_sort
Data type: DT_I4
- group_name
Template: ShortText.
- photo_file_name
Template: ShortText.
- section
Template: ShortText.
- section_id
Data type: DT_I4
- student_name
Template: ShortText.
- student_user_id
Data type: DT_I4
- teacher_name
Template: ShortText.
- begin_date
Template: DateTime.
- end_date
Template: DateTime.
- start_time
Template: ShortText.
- end_time
Template: ShortText.
- excuse_comment
Template: ShortText.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/venues/buildings.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1VenuesBuildingsGet.
- building_id
A key field. Data type: DT_I4
- building_name
Template: ShortText.
- building_types
Template: LongText. A composite field.
- rooms
Field components:
- An array.
- Contains the following components: room_id, room_number, name, code, capacity, room_type, room_type_id.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/admissions/candidates.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AdmissionsCandidatesGet.
- [Create] action
-
Endpoint URL address:
/admissions/candidates.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AdmissionsCandidatesPost.
- user_id
A key field. Data type: DT_I4
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- middle_name
Template: ShortText.
- prefix
Template: ShortText.
- suffix
Template: ShortText.
- nickname
Template: ShortText.
- role
Template: ShortText.
- role_id
Data type: DT_I4
- current_status
Template: ShortText.
- status_id
Data type: DT_I4
- school_decision
Template: ShortText.
- school_decision_type
Data type: DT_I4
- candidate_decision
Template: ShortText.
- candidate_decision_type
Data type: DT_I4
- entering_year
Template: ShortText.
- entering_year_id
Data type: DT_I4
- entering_grade
Template: ShortText.
- entering_grade_id
Data type: DT_I4
Template: ShortText.
- comment
Template: ShortText.
- parent1_email
Template: ShortText.
- parent2_email
Template: ShortText.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/academics/courses.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AcademicsCoursesGet.
- offering_id
A key field. Data type: DT_I4
- course_length
Data type: DT_I4
- course_code
Template: ShortText.
- course_title
Template: ShortText.
- inactive
Data type: DT_BOOL
- level_num
Data type: DT_I4
- room_type_id
Data type: DT_I4
- room_id
Data type: DT_I4
- building_id
Data type: DT_I4
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/academics/departments.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AcademicsDepartmentsGet.
- id
A key field. Data type: DT_I4
- level_description
Template: ShortText.
- name
Template: ShortText.
- sort
Data type: DT_I4
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/dorms/{{=parameters.dorm_id}}/roster.The action has the following user-defined parameters:
- dorm_id: Required. Specify dorm identifier.
- level_num: Required. Specify level_num for school.
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1DormsByDorm_idRosterGet.
- room_number
Template: ShortText.
- room_name
Template: ShortText.
- residents
Field components:
- An array.
- Contains the following components: user_id, first_name, last_name, middle_name, nick_name, prefix, suffix, grad_year.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/users.The action has the following user-defined parameters:
- roles: Required. Specify comma delimited list of role IDs to get users for.
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/v1usersget.
- [Read changed] action
-
Endpoint URL address:
/users/changed.The action has the following user-defined parameters:
- base_role_ids: Required. Specify comma delimited list of base role IDs to get users for.
- start_date: Required. Specify the date to begin looking for changes. Use ISO-8601 date format: 2003-04-21.
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersChangedGet.
- [Read extended] action
-
Endpoint URL address:
/users/extended.The action has the following user-defined parameters:
- base_role_ids: Required. Specify comma delimited list of base role IDs to get users for.
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersExtendedGet.
- [Read list] action
-
Endpoint URL address:
https://api.sky.blackbaud.com/school/v1/lists/advanced/{{=parameters.list_id}}.
The result is extracted from:{{=Blackbaud.getAdvancedData(response)}}.
The result is paginated.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}}
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1ListsAdvancedByList_idGet.
- [Create] action
-
Endpoint URL address:
/users.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersPost.
- [Update] action
-
Endpoint URL address:
/users.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersPatch.
- id
Data type: DT_I4
- affiliation
Template: ShortText.
- audit_date
Template: DateTime.
- chat_service
Template: ShortText.
- citizenship
Template: ShortText.
- custom_field_eight
Template: ShortText.
- custom_field_five
Template: ShortText.
- custom_field_four
Template: ShortText.
- custom_field_nine
Template: ShortText.
- custom_field_one
Template: ShortText.
- custom_field_seven
Template: ShortText.
- custom_field_six
Template: ShortText.
- custom_field_ten
Template: ShortText.
- custom_field_three
Template: ShortText.
- custom_field_two
Template: ShortText.
- deceased
Data type: DT_BOOL
- deceased_date
Template: DateTime.
- birth_date
Template: DateTime.
- depart_date
Template: DateTime.
- display
Template: ShortText.
Template: ShortText.
- cc_email
Template: ShortText.
- email_active
Data type: DT_BOOL
- enroll_date
Template: DateTime.
- boarding_or_day
Template: ShortText.
- ethnicity
Template: ShortText.
- first_name
Template: ShortText.
- gender
Template: ShortText.
- gender_description
Template: ShortText.
- pronouns
Template: ShortText.
- greeting
Template: ShortText.
- host_id
Template: ShortText.
- last_name
Template: ShortText.
- last_sync_date
Template: DateTime.
- legacy_user_name
Template: ShortText.
- living_arrangement
Template: ShortText.
- lost
Data type: DT_BOOL
- maiden_name
Template: ShortText.
- middle_name
Template: ShortText.
- misc_bio
Template: ShortText.
- nick_name
Template: ShortText.
- personal_bio
Template: ShortText.
- personal_website
Template: ShortText.
- prefix
Template: ShortText.
- profile_url
Template: ShortText.
- religion
Template: ShortText.
- retire_date
Template: ShortText.
- screen_name
Template: ShortText.
- student_id
Template: ShortText.
- student_info
Field components:
-
Uses template:
ShortText. - Contains the following components: grad_year, grade_level, grade_level_description.
-
Uses template:
- username
Template: ShortText.
- dob
Template: ShortText.
- suffix
Template: ShortText.
- addresses
Field components:
- An array.
-
Uses template:
SAddress.
- education
Field components:
- An array.
- Contains the following components: id, degree, field, grad_year, major, school.
- emergencycontacts
The value is gathered from
/users/{{=item.id}}/emergencycontactsaddress. Field components:- Contains the following components: email_contact_list, phone_contact_list.
- employment
The value is gathered from
/users/{{=item.id}}/employmentaddress. Field components:-
Uses template:
ShortText. - Contains the following components: date_appointed, date_departed, school_levels, employee_roles, departments, grade_levels, main_sports.
-
Uses template:
- occupations
Field components:
- An array.
-
Uses template:
Occupation.
- phones
Field components:
- An array.
-
Uses template:
SPhone.
- races
Field components:
- An array.
- Contains the following components: race_type_id, description, user_race_id, user_id.
- relationships
Field components:
- An array.
-
Uses template:
SRelationship.
- roles
Field components:
- An array.
- Contains the following components: id, base_role_id, hidden, name.
- enrollments
The value is gathered from
/academics/enrollments/{{=item.id}}address. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
-
Uses template:
Enrollment.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/academics/schedules/master.The action has the following user-defined parameters:
- level_num: Required. Specify Level Number indicates which school you are working with.
- start_date: Required. Specify Start of the date range (inclusive).
- end_date: Required. Specify End of the date range (inclusive).
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AcademicsSchedulesMasterGet.
- calendar_day
Template: DateTime.
- schedule_sets
Field components:
- An array.
- Contains the following components: schedule_set_id, day_label, blocks.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/occupations.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersByUser_idOccupationsGet.
- [Create] action
-
Endpoint URL address:
/users/{{=item.user_id}}/occupations.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersByUser_idOccupationsPost.
The resource includes the fields from the Occupation template.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/phones.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersByUser_idPhonesGet.
- [Create] action
-
Endpoint URL address:
/users/{{=item.user_id}}/phones.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersByUser_idPhonesPost.
The resource includes the fields from the SPhone template.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/relationships.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersByUser_idRelationshipsGet.
- [Create] action
-
Endpoint URL address:
/users/{{=item.user_id}}/relationships.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersByUser_idRelationshipsPost.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.user_id}}/relationships.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersByUser_idRelationshipsDelete.
The resource includes the fields from the SRelationship template.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/athletics/schedules.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AthleticsSchedulesGet.
- id
A key field. Data type: DT_I4
- alumni
Data type: DT_BOOL
- cancelled
Data type: DT_BOOL
- departure_location
Template: ShortText.
- departure_time
Template: ShortText.
- description
Template: ShortText.
- directions
Template: ShortText.
- dismissal_time
Template: ShortText.
- end_time
Template: ShortText.
- end_time_span
Template: ShortText.
- faculty
Data type: DT_BOOL
- game_date
Template: DateTime.
- highlight_id
Data type: DT_I4
- home_or_away
Template: ShortText.
- invitational
Data type: DT_BOOL
- league
Data type: DT_BOOL
- location
Template: ShortText.
- map_url
Template: ShortText.
- meet
Data type: DT_I4
- opponents
Field components:
- An array.
- Contains the following components: id, name, score, win_loss.
- pickup_time
Template: ShortText.
- playoff
Data type: DT_BOOL
- practice
Data type: DT_BOOL
- published
Data type: DT_BOOL
- require_dinner
Data type: DT_BOOL
- require_lunch
Data type: DT_BOOL
- rescheduled
Data type: DT_BOOL
- rescheduled_date
Template: DateTime.
- rescheduled_note
Template: ShortText.
- room_id
Data type: DT_I4
- schedule_type
Data type: DT_I4
- scrimmage
Data type: DT_BOOL
- section_id
Data type: DT_I4
- show_details
Data type: DT_BOOL
- show_directions
Data type: DT_BOOL
- show_versus
Data type: DT_BOOL
- start_time
Template: ShortText.
- team_id
Data type: DT_I4
- time
Template: ShortText.
- tournament
Data type: DT_BOOL
- transportation_id
Data type: DT_I4
- uniform_color
Template: ShortText.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/academics/schedules/sets.The action has the following user-defined parameters:
- level_num: Required. Specify Level Number indicates which school you are working with.
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AcademicsSchedulesSetsGet.
- schedule_set_id
Data type: DT_I4
- title
Template: ShortText.
- meeting_time
Data type: DT_BOOL
- rotation
Data type: DT_BOOL
- begin_date
Template: DateTime.
- end_date
Template: DateTime.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/academics/sections.The action has the following user-defined parameters:
- level_num: Required. Specify Level Number indicates which school you are working with.
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AcademicsSectionsGet.
- [Read teacher] action
-
Endpoint URL address:
/academics/teachers/{{=parameters.teacher_id}}/sections.The action has the following user-defined parameters:
- teacher_id: Required. Specify teacher identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AcademicsTeachersByTeacher_idSectionsGet.
- id
A key field. Data type: DT_I4
- course_code
Template: ShortText.
- duration
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- lead_section_id
Data type: DT_I4
- name
Template: ShortText.
- offering_id
Data type: DT_I4
- parent_section_id
Data type: DT_I4
- room_id
Data type: DT_I4
- school_year
Template: ShortText.
- section_identifier
Template: ShortText.
- assignments
The value is gathered from
/academics/sections/{{=item.id}}/assignmentsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
- Contains the following components: id, date, description, discussion, due_date, enrolled, graded_count, index_id, major, name, publish_on_assigned, published, rank, type, type_id.
- students
The value is gathered from
/academics/sections/{{=item.id}}/studentsaddress. The gathered value is processed with{{=response.value}}expression. Field components:- An array.
- Contains the following components: id, name.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/academics/specialdays.
The result is extracted from:{{=response}}.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AcademicsSpecialdaysGet.
- id
Data type: DT_I4
- day_description
Template: ShortText.
- sort_order
Data type: DT_I4
- rotation_behavior
Template: ShortText.
- blocks
Field components:
- An array.
- Contains the following components: block_id, block_description, start_time, end_time.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/athletics/sports.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AthleticsSportsGet.
- id
A key field. Data type: DT_I4
- level
Field components:
-
Uses template:
ShortText. - Contains the following components: id, abbreviation.
-
Uses template:
- name
Template: ShortText.
- season
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/academics/enrollments/{{=parameters.student_id}}.The action has the following user-defined parameters:
- student_id: Required. Specify student identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AcademicsEnrollmentsByUser_idGet.
- [Create] action
-
Endpoint URL address:
/users/enroll.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersEnrollPost.
The resource includes the fields from the Enrollment template.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/athletics/sportslevels.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AthleticsSportslevelsGet.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- description
Template: ShortText.
- gender
Template: ShortText.
- level_of_play
Template: ShortText.
- sport_id
Data type: DT_I4
- sport
Template: ShortText.
- season_id
Data type: DT_I4
- season
Template: ShortText.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/athletics/teams.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1AthleticsTeamsGet.
- id
Data type: DT_I4
- name
Template: ShortText.
- sport
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- roster
The value is gathered from
/athletics/teams/{{=item.id}}/rosteraddress. Field components:- Contains the following components: coaches, players.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/terms.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/v1termsget.
- id
A key field. Data type: DT_I4
- begin_date
Template: DateTime.
- description
Template: ShortText.
- end_date
Template: DateTime.
- level_description
Template: ShortText.
- level_id
Data type: DT_I4
- offering_type
Data type: DT_I4
- school_year_label
Template: ShortText.
Based on resource template School.
- [Read] action
-
Endpoint URL address:
/users/audit.Documentation: https://developer.sky.blackbaud.com/docs/services/school/operations/V1UsersAuditGet.
- field_name
Template: ShortText.
- change_date
Template: DateTime.
- value_before
Template: ShortText.
- value_after
Template: ShortText.
- user_id
Data type: DT_I4
Based on resource template SU.
- [Read] action
-
Endpoint URL address:
/units/{{=item.unit_id}}.The action has the following user-defined parameters:
- unit_id: Required. Specify unit identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/statistical-unit/operations/SearchCounts.
- [Create] action
-
Endpoint URL address:
/units/{{=item.unit_id}}/counts.Documentation: https://developer.sky.blackbaud.com/docs/services/statistical-unit/operations/CreateCount.
- [Update] action
-
Endpoint URL address:
/units/{{=item.unit_id}}/counts/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/statistical-unit/operations/EditCount.
- [Delete] action
-
Endpoint URL address:
/units/{{=item.unit_id}}/counts/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/statistical-unit/operations/DeleteCount.
The resource includes the fields from the Count template.
- unit_id
Data type: DT_I4
Based on resource template SU.
- [Read] action
-
Endpoint URL address:
/units.Documentation: https://developer.sky.blackbaud.com/docs/services/statistical-unit/operations/SearchUnit.
- [Create] action
-
Endpoint URL address:
/units.Documentation: https://developer.sky.blackbaud.com/docs/services/statistical-unit/operations/CreateUnit.
- [Update] action
-
Endpoint URL address:
/units/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/statistical-unit/operations/EditUnit.
- [Delete] action
-
Endpoint URL address:
/units/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/statistical-unit/operations/DeleteUnit.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- description
Template: ShortText.
- integer
Data type: DT_BOOL
- cumulative
Data type: DT_BOOL
- inactive
Data type: DT_BOOL
- elements
Field components:
- An array.
- counts
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Financial | Unit Count'].getData({ parameters: ['unit_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Count.
Based on resource template Treasury.
- [Read] action
-
Endpoint URL address:
/bankaccounts/{{=parameters.bank_account_id}}/adjustments[.The action has the following user-defined parameters:
- bank_account_id: Required. Specify bank account identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2880528ab71c796492e/operations/ListAdjustmentsSingleBankAccount.
- [Create] action
-
Endpoint URL address:
/bankaccounts/{{=item.bank_account_id}}/adjustments.Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2880528ab71c796492e/operations/CreateBankAccountAdjustment.
- category
Template: ShortText.
- number
Data type: DT_I4
- date
Template: DateTime.
- amount
Data type: DT_R8
- type
Template: ShortText.
- transfer_to_account
Data type: DT_I4
- reference
Template: ShortText.
- is_cleared
Data type: DT_BOOL
- cleared_date
Template: ShortText.
- post_status
Template: ShortText.
- post_date
Template: DateTime.
- distributions
Field components:
- An array.
-
Uses template:
Distribution.
- interfund_entry_set
Template: ShortText.
- adjustment_id
A key field. Data type: DT_I4
- transaction_id
Data type: DT_I4
- payment_amount
Data type: DT_R8
- deposit_amount
Data type: DT_R8
- status
Template: ShortText.
- subledger
Template: ShortText.
- transaction_type
Template: ShortText.
- bank_account_id
Data type: DT_I4
Based on resource template Treasury.
- [Read] action
-
Endpoint URL address:
/bankaccounts.Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2880528ab71c796492e/operations/ListBankAccounts.
- bank_account_id
A key field. Data type: DT_I4
- account_name
Template: ShortText.
- bank_name
Template: ShortText.
- ui_account_id
Template: ShortText.
- type
Template: ShortText.
- current_balance
Template: ShortText.
- status
Template: ShortText.
- account_number
Template: ShortText.
Based on resource template Treasury.
- [Read] action
-
Endpoint URL address:
/bankaccounts/{{=parameters.bank_account_id}}/register.The action has the following user-defined parameters:
- bank_account_id: Required. Specify bank account identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2880528ab71c796492e/operations/ListRegisterTransactionsSingleBankAccount.
- transaction_id
A key field. Data type: DT_I4
- date
Template: DateTime.
- transaction_type
Template: ShortText.
- subledger
Template: ShortText.
- number
Data type: DT_I4
- payee
Template: ShortText.
- transaction_status
Template: ShortText.
- payment
Template: ShortText.
- deposit
Data type: DT_R8
- post_status
Template: ShortText.
- post_date
Template: DateTime.
Based on resource template Treasury.
- [Read] action
-
Endpoint URL address:
/deposits/{{=parameters.deposit_id}}/cashreceipts.The action has the following user-defined parameters:
- deposit_id: Required. Specify deposit identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2880528ab71c796492e/operations/ListCashReceiptsSingleDeposit.
- [Create] action
-
Endpoint URL address:
/deposits/{{=item.deposit_id}}/cashreceipts.Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2880528ab71c796492e/operations/CreateCashReceipt.
- cash_receipt_id
A key field. Data type: DT_I4
- date
Template: ShortText.
- amount
Data type: DT_R8
- category
Template: ShortText.
- description
Template: ShortText.
- payment_from
Template: ShortText.
- payment_info
Field components:
-
Uses template:
ShortText. - Contains the following components: payment_method, card_type, card_number, expiration_month, expiration_year, authorization_number.
-
Uses template:
- receipt_status
Template: ShortText.
- receipt_address
Template: ShortText.
- distributions
The value is gathered from
/cashreceipts/{{=item.cash_receipt_id}}address. Field components:- An array.
-
Uses template:
Distribution.
- number
Template: ShortText.
- payer
Template: ShortText.
- payment_method
Template: ShortText.
- deposit_id
Data type: DT_I4
- [External]
-
The external fields URL address:
/cashreceipts/customfields. The external fields list is extracted from:{{=response.results}}.- custom.{{=external.name}}
Data type: {{=Blackbaud.getDataType(external.type)}} ( length 255 ) The value is gathered from
/cashreceipts/{{=item.cash_receipt_id}}address. The gathered value is processed with{{=response[field.external.name]}}expression. Before setting, the value is processed with{{=value && { field_name: field.external.name, value: value } }}expression.
Based on resource template Treasury.
- [Read] action
-
Endpoint URL address:
/bankaccounts/{{=parameters.bank_account_id}}/checks.The action has the following user-defined parameters:
- bank_account_id: Required. Specify bank account identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2880528ab71c796492e/operations/ListChecksSingleBankAccount.
- check_id
A key field. Data type: DT_I4
- transaction_id
Data type: DT_I4
- date
Template: DateTime.
- amount
Data type: DT_R8
- number
Data type: DT_I4
- transaction_status
Template: ShortText.
- subledger
Template: ShortText.
- post_status
Template: ShortText.
- post_date
Template: DateTime.
- check_type
Template: ShortText.
- payee
Template: ShortText.
Based on resource template Treasury.
- [Read] action
-
Endpoint URL address:
/creditcardaccounts.Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2880528ab71c796492e/operations/ListCreditCardAccounts.
- credit_card_account_id
A key field. Data type: DT_I4
- account_name
Template: ShortText.
- bank_name
Template: ShortText.
- type
Template: ShortText.
- register_balance
Data type: DT_R8
- status
Template: ShortText.
- active_card_count
Data type: DT_I4
- credit_cards
The gathered value is processed with
{{=connection.resourceManager['Financial | Credit Card'].getData({ parameters: ['credit_card_account_id=' + item.credit_card_account_id] })}}expression. Field components:- An array.
-
Uses template:
CreditCard.
Based on resource template Treasury.
- [Read] action
-
Endpoint URL address:
/creditcardaccounts/{{=parameters.credit_card_account_id}}/creditcards.The action has the following user-defined parameters:
- credit_card_account_id: Required. Specify credit card account identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2880528ab71c796492e/operations/ListCreditCardsSingleCreditCardAccount.
The resource includes the fields from the CreditCard template.
Based on resource template Treasury.
- [Read] action
-
Endpoint URL address:
/bankaccounts/{{=parameters.bank_account_id}}/deposits.The action has the following user-defined parameters:
- bank_account_id: Required. Specify bank account identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2880528ab71c796492e/operations/ListDepositsSingleBankAccount.
- [Create] action
-
Endpoint URL address:
/bankaccounts/{{=item.bank_account_id}}/deposits.Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2880528ab71c796492e/operations/CreateDeposit.
- id
A key field. Data type: DT_I4
- transaction_id
Data type: DT_I4
- date
Template: DateTime.
- amount
Data type: DT_R8
- number
Data type: DT_I4
- post_date
Template: DateTime.
- post_status
Template: ShortText.
- status
Template: ShortText.
- subledger
Template: ShortText.
- bank_account_id
Data type: DT_I4
- type
Template: ShortText.
- description
Template: ShortText.
- ui_deposit_id
Template: ShortText.
- projected_count
Data type: DT_I4
- projected_amount
Data type: DT_R8
- created_date
Template: DateTime.
- payment_methods_allowed
Template: LongText. A composite field.
- transaction_defaults
Field components:
-
Uses template:
DateTime. - Contains the following components: receipt_date, amount, description, payment_method, category.
-
Uses template:
- distributions
The value is gathered from
/deposits/{{=item.id}}address. Field components:- An array.
-
Uses template:
Distribution.
Based on resource template Treasury.
- [Read] action
-
Endpoint URL address:
/payments/{{=parameters.payment_id}}/transactions.The action has the following user-defined parameters:
- payment_id: Required. Specify payment identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/58e3b2880528ab71c796492e/operations/ListPaymentTransactions.
- transaction_id
A key field. Data type: DT_I4
- transaction_type
Template: ShortText.
- transaction_number
Template: ShortText.
- transaction_date
Template: DateTime.
- amount_paid
Data type: DT_R8
- discount_amount
Data type: DT_R8
- description
Template: ShortText.
Based on resource template EventBase.
- [Read] action
-
Endpoint URL address:
/eventcategories.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/GetEventCategories.
- [Create] action
-
Endpoint URL address:
/eventcategories.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/CreateEventCategory.
- [Update] action
-
Endpoint URL address:
/eventcategories/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/EditEventCategory.
- [Delete] action
-
Endpoint URL address:
/eventcategories/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/DeleteEventCategory.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- inactive
Data type: DT_BOOL
Based on resource template EventBase.
- [Read] action
-
Endpoint URL address:
/events/{{=parameters.event_id}}/eventfees.The action has the following user-defined parameters:
- event_id: Required. Specify event identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/GetEventFees.
- [Create] action
-
Endpoint URL address:
/events/{{=item.event_id}}/eventfees.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/CreateEventFee.
- [Update] action
-
Endpoint URL address:
/eventfees/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/EditEventFee.
- [Delete] action
-
Endpoint URL address:
/eventfees/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/DeleteEventFee.
The resource includes the fields from the EventFee template.
Based on resource template EventBase.
- [Read] action
-
Endpoint URL address:
/eventlist.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/GetEventList.
- [Create] action
-
Endpoint URL address:
/events.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/CreateEvent.
- [Update] action
-
Endpoint URL address:
/events/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/EditEvent.
- id
A key field. Template: ShortText.
- lookup_id
Template: ShortText.
- name
Template: ShortText.
- start_date
Template: DateTime.
- start_time
Template: ShortText.
- end_date
Template: DateTime.
- end_time
Template: ShortText.
- attending_count
Data type: DT_I4
- invited_count
Data type: DT_I4
- revenue
Data type: DT_R8
- goal
Data type: DT_R8
- percent_of_goal
Data type: DT_R8
- date_added
Template: DateTime.
- date_modified
Template: DateTime.
- capacity
Data type: DT_I4
- inactive
Data type: DT_BOOL
- attended_count
Data type: DT_I4
- category
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, inactive.
-
Uses template:
- fees
A read-only field. The value is gathered from
/events/{{=item.id}}/eventfeesaddress. Field components:- An array.
-
Uses template:
EventFee.
- participants
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Event Participant'].getData({ parameters: ['event_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Participant.
- participant_options
A read-only field. The value is gathered from
/events/{{=item.id}}/eventparticipantoptionsaddress. Field components:- An array.
- Contains the following components: id, name, input_type, multi_select, added_by_user, updated_by_user, date_added, date_updated, version.
Based on resource template EventBase.
- [Read] action
-
Endpoint URL address:
/events/{{=parameters.event_id}}/participants.The action has the following user-defined parameters:
- event_id: Required. Specify event identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/GetEventParticipantList.
- [Create] action
-
Endpoint URL address:
/events/{{=item.event_id}}/participants.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/CreateParticipant.
- [Update] action
-
Endpoint URL address:
/participants/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/EditParticipant.
- [Delete] action
-
Endpoint URL address:
/participants/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/DeleteParticipant.
The resource includes the fields from the Participant template.
- event_id
Template: ShortText.
- options
A read-only field. The value is gathered from
/participants/{{=item.id}}/participantoptionsaddress. Field components:- An array.
-
Uses template:
ParticipantOption.
- fees
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Participant Fee'].getData({ parameters: ['participant_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
ParticipantFee.
Based on resource template EventBase.
- [Read] action
-
Endpoint URL address:
/participants/{{=parameters.participant_id}}/participantoptions.The action has the following user-defined parameters:
- participant_id: Required. Specify participant identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/GetParticipantOptions.
- [Create] action
-
Endpoint URL address:
/participants/{{=item.participant_id}}/participantoptions.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/CreateParticipantOption.
- [Update] action
-
Endpoint URL address:
/participantoptions/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/EditParticipantOption.
- [Delete] action
-
Endpoint URL address:
/participantoptions/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/DeleteParticipantOption.
The resource includes the fields from the ParticipantOption template.
Based on resource template EventBase.
- [Read] action
-
Endpoint URL address:
/participants/{{=parameters.participant_id}}/fees.The action has the following user-defined parameters:
- participant_id: Required. Specify participant identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/GetParticipantFees.
- [Create] action
-
Endpoint URL address:
/participants/{{=item.participant_id}}/fees.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/CreateParticipantFee.
- [Delete] action
-
Endpoint URL address:
/participantfees/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/DeleteParticipantFee.
The resource includes the fields from the ParticipantFee template.
Based on resource template EventBase.
- [Read] action
-
Endpoint URL address:
/participationlevels.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/GetParticipationLevels.
- [Create] action
-
Endpoint URL address:
/participationlevels.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/CreateParticipationLevel.
- [Update] action
-
Endpoint URL address:
/participationlevels/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/EditParticipationLevel.
- [Delete] action
-
Endpoint URL address:
/participationlevels/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/event/operations/DeleteParticipationLevel.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- inactive
Data type: DT_BOOL
Based on resource template NXT.
- [Read] action
-
Endpoint URL address:
/appeals.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/GetAppealList.
- [Create] action
-
Endpoint URL address:
/appeals.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/CreateAppeal.
- [Update] action
-
Endpoint URL address:
/appeals/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/EditAppeal.
- [Delete] action
-
Endpoint URL address:
/appeals/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/DeleteAppeal.
- id
A key field. Data type: DT_I4
- appeal_category
Template: ShortText.
- campaign
Template: ShortText.
- appeal_id
Template: ShortText.
- campaign_id
Data type: DT_I4
- appeal_category_id
Data type: DT_I4
- description
Template: ShortText.
- goal
Data type: DT_R8
- start_date
Template: DateTime.
- end_date
Template: DateTime.
- inactive
Data type: DT_BOOL
- default_fund_id
Data type: DT_I4
- notes
Template: ShortText.
- number_solicited
Data type: DT_I4
Based on resource template NXT.
- [Read] action
-
Endpoint URL address:
/campaigns.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/GetCampaignList.
- [Create] action
-
Endpoint URL address:
/campaigns.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/CreateCampaign.
- [Update] action
-
Endpoint URL address:
/campaigns/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/EditCampaign.
- [Delete] action
-
Endpoint URL address:
/campaigns/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/DeleteCampaign.
- id
A key field. Data type: DT_I4
- campaign_category
Template: ShortText.
- campaign_id
Template: ShortText.
- description
Template: ShortText.
- campaign_category_id
Data type: DT_I4
- start_date
Template: DateTime.
- end_date
Template: DateTime.
- inactive
Data type: DT_BOOL
- default_fund_id
Data type: DT_I4
- goal
Data type: DT_R8
- notes
Template: ShortText.
Based on resource template NXT.
- [Read] action
-
Endpoint URL address:
/codetables.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/GetCodeTableList.
- [Create] action
-
Endpoint URL address:
/codetables.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/CreateCodeTable.
- [Update] action
-
Endpoint URL address:
/codetables/{{=item.code_tables_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/EditCodeTable.
- [Delete] action
-
Endpoint URL address:
/codetables/{{=item.code_tables_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/DeleteCodeTable.
- code_tables_id
A key field. Data type: DT_I4
- name
Template: ShortText.
- user_defined
Data type: DT_BOOL A read-only field.
- has_short_description
Data type: DT_BOOL
- short_description_length
Data type: DT_I4 A read-only field.
- hidden_system_table
Data type: DT_BOOL A read-only field.
Based on resource template NXT.
- [Read] action
-
Endpoint URL address:
/constituents/customsearch.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/GetCustomSearchConstituent.
- [Delete] action
-
Endpoint URL address:
/constituents/{{=item.constituent_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/DeleteConstituent.
- constituent_id
A key field. Template: ShortText.
- matched_alias
Template: ShortText.
- matched_email
Template: ShortText.
- matched_phone
Template: ShortText.
- record_id
Data type: DT_I4
- import_id
Template: ShortText.
- is_constituent
Data type: DT_BOOL
- is_deceased
Data type: DT_BOOL
- is_inactive
Data type: DT_BOOL
- last_name
Template: ShortText.
- first_name
Template: ShortText.
- middle_name
Template: ShortText.
- key_indicator
Template: ShortText.
- maiden_name
Template: ShortText.
- gender
Template: ShortText.
- address_block
Template: ShortText.
- address_city_state
Template: ShortText.
- address_post_code
Template: ShortText.
- primary_email
Template: ShortText.
- primary_phone
Template: ShortText.
- title1
Template: ShortText.
- suffix1
Template: ShortText.
- birth_date
Template: FuzzyDate.
- preferred_name
Template: ShortText.
- spouse_first_name
Template: ShortText.
- spouse_last_name
Template: ShortText.
Based on resource template NXT.
- [Read] action
-
Endpoint URL address:
/countries.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/GetCountryList.
- [Create] action
-
Endpoint URL address:
/countries.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/CreateCountry.
- [Update] action
-
Endpoint URL address:
/countries/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/EditCountry.
- [Delete] action
-
Endpoint URL address:
/countries/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/DeleteCountry.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- abbreviation
Template: ShortText.
- currency_type_id
Data type: DT_I4
- currency_type
Template: ShortText.
- thousand_separator
Template: ShortText.
- exchange_rate
Data type: DT_R8
- decimal_separator
Template: ShortText.
- decimal_digits
Data type: DT_I4
- currency_symbol
Template: ShortText.
- currency_placement_id
Template: ShortText.
- leading_zero
Data type: DT_BOOL
- iso_code
Template: ShortText.
- label_format_country
Template: ShortText.
Based on resource template NXT.
- [Read] action
-
Endpoint URL address:
/funds.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/GetFundList.
- [Create] action
-
Endpoint URL address:
/funds.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/CreateFund.
- [Update] action
-
Endpoint URL address:
/funds/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/EditFund.
- [Delete] action
-
Endpoint URL address:
/funds/{{=item.id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/DeleteFund.
- id
A key field. Data type: DT_I4
- fund_category
Template: ShortText.
- fund_type
Template: ShortText.
- campaign
Template: ShortText.
- default_appeal
Template: ShortText.
- fund_id
Template: ShortText.
- description
Template: ShortText.
- fund_category_id
Data type: DT_I4
- fund_type_id
Data type: DT_I4
- campaign_id
Data type: DT_I4
- start_date
Template: DateTime.
- end_date
Template: DateTime.
- inactive
Data type: DT_BOOL
- default_appeal_id
Data type: DT_I4
- notes
Template: ShortText.
- goal
Data type: DT_R8
- restricted
Data type: DT_BOOL
Based on resource template NXT.
- [Read] action
-
Endpoint URL address:
/phonetypes.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/GetPhoneTypesList.
- [Create] action
-
Endpoint URL address:
/phonetypes.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/CreatePhoneType.
- [Update] action
-
Endpoint URL address:
/phonetypes/{{=item.type}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/EditPhoneType.
- [Delete] action
-
Endpoint URL address:
/phonetypes/{{=item.type}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/DeletePhoneType.
- type
A key field. Template: ShortText.
- sequence
Data type: DT_I4 A read-only field.
- is_system_entry
Data type: DT_BOOL A read-only field.
- date_added
Template: DateTime. A read-only field.
- date_changed
Template: DateTime. A read-only field.
- added_by_id
Data type: DT_I4 A read-only field.
- last_changed_by_id
Data type: DT_I4 A read-only field.
- format_mask
Template: ShortText.
- table_entries_id
Data type: DT_I4 A read-only field.
- is_active
Data type: DT_BOOL
- description
Template: ShortText.
- format
Template: ShortText.
Based on resource template NXT.
- [Read] action
-
Endpoint URL address:
/codetables/{{=parameters.code_tables_id}}/tableentries.The action has the following user-defined parameters:
- code_tables_id: Required. Specify code table identifier.
Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/GetTableEntriesList.
- [Create] action
-
Endpoint URL address:
/codetables/{{=item.code_tables_id}}/tableentries.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/CreateTableEntry.
- [Update] action
-
Endpoint URL address:
/codetables/{{=item.code_tables_id}}/tableentries/{{=item.table_entries_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/EditTableEntry.
- [Delete] action
-
Endpoint URL address:
/codetables/{{=item.code_tables_id}}/tableentries/{{=item.table_entries_id}}.Documentation: https://developer.sky.blackbaud.com/docs/services/nxt-data-integration/operations/DeleteTableEntry.
- table_entries_id
A key field. Data type: DT_I4
- is_active
Data type: DT_BOOL
- long_description
Template: ShortText.
- short_description
Template: ShortText.
- numeric_value
Data type: DT_R8
- sequence
Data type: DT_I4 A read-only field.
- is_system_entry
Data type: DT_BOOL A read-only field.
- code_tables_id
A key field. Data type: DT_I4
- date_added
Template: DateTime. A read-only field.
- date_changed
Template: DateTime. A read-only field.
- added_by_id
Data type: DT_I4 A read-only field.
- last_changed_by_id
Data type: DT_I4 A read-only field.
- code_tables_name
Template: ShortText.
- [Read] action
-
The result is extracted from:{{=response.value}}.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
offset:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
offset:
-
limit:
-
marker:
{{=parameters.iterator}}
-
offset:
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- FuzzyDate
Field components:
- Contains the following components: d, m, y.
- FAddress
Field components:
-
Uses template:
ShortText. - Contains the following components: address_id, description, country, city, county, state, postal, address_line, is_primary, is_invoices, is_pos, is_1099, title, first_name, middle_name, last_name, suffix, position, address_contact_methods.
-
Uses template:
- Distribution
Field components:
-
Uses template:
ShortText. - Contains the following components: distribution_id, amount, account_number, type_code, custom_fields, description, distribution_splits.
-
Uses template:
- LineItem
Field components:
-
Uses template:
ShortText. - Contains the following components: line_item_id, line_number, type, product_id, vendor_part_number, description, product_code, quantity_ordered, quantity_received, quantity_cancelled, quantity_rejected, unit_of_measure, unit_cost, extended_cost, post_status, post_date, comments, notes, status, deliver_to, requested_by, department, distributions, interfund_set, date_added, added_by, date_modified, modified_by.
-
Uses template:
- FAttachment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, url, type, media_type, date_attached, parent_id, vendor_id.
-
Uses template:
- CAttachment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, content_type, date, file_id, file_name, file_size, name, parent_id, thumbnail_id, thumbnail_url, type, url, tags.
-
Uses template:
- PrimaryNameFormat
Field components:
-
Uses template:
ShortText. - Contains the following components: configuration_id, custom_format, formatted_name.
-
Uses template:
- Action
Field components:
-
Uses template:
ShortText. - Contains the following components: id, category, completed, computed_status, constituent_id, date, date_added, date_modified, description, direction, end_time, location, outcome, priority, start_time, status, status_code, summary, type, fundraisers, opportunity_id.
-
Uses template:
- CAddress
Field components:
-
Uses template:
ShortText. - Contains the following components: id, address_lines, city, constituent_id, country, county, date_added, date_modified, do_not_mail, end, inactive, postal_code, preferred, seasonal_end, seasonal_start, start, state, suburb, type.
-
Uses template:
- EmailAddress
Field components:
-
Uses template:
ShortText. - Contains the following components: id, address, constituent_id, do_not_email, inactive, primary, type.
-
Uses template:
- Alias
Field components:
-
Uses template:
ShortText. - Contains the following components: id, constituent_id, name, type.
-
Uses template:
- ConstituentCode
Field components:
-
Uses template:
ShortText. - Contains the following components: id, constituent_id, date_added, date_modified, description, end, start.
-
Uses template:
- Education
Field components:
-
Uses template:
ShortText. - Contains the following components: id, campus, class_of, class_of_degree, constituent_id, date_added, date_entered, date_graduated, date_left, date_modified, degree, department, faculty, gpa, known_name, majors, minors, primary, registration_number, school, social_organization, status, subject_of_study, type.
-
Uses template:
- Note
Field components:
-
Uses template:
ShortText. - Contains the following components: id, constituent_id, date, date_added, date_modified, summary, type.
-
Uses template:
- Phone
Field components:
-
Uses template:
ShortText. - Contains the following components: id, constituent_id, do_not_call, inactive, number, primary, type.
-
Uses template:
- CRelationship
Field components:
-
Uses template:
ShortText. - Contains the following components: id, constituent_id, end, date_added, date_modified, is_organization_contact, is_primary_business, is_spouse, organization_contact_type, position, name, reciprocal_relationship_id, reciprocal_type, relation_id, start, type.
-
Uses template:
- BudgetAccount
Field components:
-
Uses template:
ShortText. - Contains the following components: budget_category, account_number, fiscal_year, total_amount, fiscal_period, period_amount, period_percent.
-
Uses template:
- GLSummary
Field components:
-
Uses template:
ShortText. - Contains the following components: fiscal_year, fiscal_year_id, fiscal_period, fiscal_period_id, period_start_date, period_end_date, account_number, ui_project_id, transaction_codes, beginning_balance, debit, credit, encumbered_beginning_balance, encumbered_debit, encumbered_credit.
-
Uses template:
- Note
Field components:
-
Uses template:
ShortText. - Contains the following components: note_action_id, note_type, date, content, description, type, is_complete, assign_to, completed_date.
-
Uses template:
- SAddress
Field components:
-
Uses template:
ShortText. - Contains the following components: id, address_type, city, country, line_one, line_three, line_two, links, mailing_address, postal_code, primary, province, region, state, type_id, user_id.
-
Uses template:
- Occupation
Field components:
-
Uses template:
DateTime. - Contains the following components: id, begin_date, business_name, current, end_date, industry, job_function, matching_gift, organization, parent_company, profession, specialty, title, url, user_id, years_employed.
-
Uses template:
- SPhone
Field components:
-
Uses template:
ShortText. - Contains the following components: id, phone_type, index_id, links, number, type_id, user_id.
-
Uses template:
- SRelationship
Field components:
-
Uses template:
ShortText. - Contains the following components: comment, contact, first_name, last_name, list_as_parent, parental_access, primary, relationship, resides_with, show_parent, tuition_responsible_signer, type_id, user_one_id, user_one_role, user_two_id.
-
Uses template:
- Enrollment
Field components:
-
Uses template:
DateTime. - Contains the following components: id, begin_date, block_id, block_name, blocks, building_name, course_code, course_title, departments, distinction, dropped, duration_begin_date, duration_description, duration_end_date, duration_id, duration_name, end_date, faculty_first_name, faculty_last_name, level_number, offering_description, offering_id, offering_type_id, room_id, room_name, room_number, school_year, section_identifier.
-
Uses template:
- Count
Field components:
-
Uses template:
DateTime. - Contains the following components: id, date, line_items.
-
Uses template:
- CreditCard
Field components:
-
Uses template:
ShortText. - Contains the following components: credit_card_id, ui_credit_card_id, account_id, last_4, Inactive.
-
Uses template:
- EventFee
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, event_id, cost, contribution_amount, number_sold.
-
Uses template:
- Participant
Field components:
-
Uses template:
ShortText. - Contains the following components: id, contact_id, date_added, date_modified, is_constituent, lookup_id, name, first_name, middle_name, last_name, preferred_name, former_name, title, suffix, class_of, phone, do_not_call, email, do_not_email, participation_level, attended, rsvp_status, invitation_status, rsvp_date, total_registration_fees, total_paid, guests, seat, name_tag, memberships.
-
Uses template:
- ParticipantOption
Field components:
-
Uses template:
ShortText. - Contains the following components: id, participant_id, event_id, event_participant_option_id, option_value, added_by_user, updated_by_user, date_added, date_updated.
-
Uses template:
- ParticipantFee
Field components:
-
Uses template:
ShortText. - Contains the following components: id, participant_id, quantity, fee_amount, tax_receiptable_amount, event_fee.
-
Uses template:
Knowledge Base
- Where can I find the documentation for the Blackbaud Connection?
- How do I enable COZYROC within my organizations Blackbaud instance.
What's New
- New: Defined 'Financial | Fixed Asset' resource.
- New: Defined 'Financial | Fixed Asset Transaction' resource.
- New: Defined 'School | Meeting' resource.
- New: Included definition for new /creditmemos API.
- Fixed: Corrected pagination for 'Church | Action' resource.
- New: Defined 'School | Student Schedule' resource.
- New: Replaced deprecated 'School | Dorm Resident' resource with 'School | Dorm' resource.
- Fixed: Infinite loop when trying to retrieve data from School resources (Thank you, Brian).
- Fixed: Unable to read from 'NXT | Constituent' resource (Thank you, Phil).
- New: Support for Event API resources.
- New: Support for NXT Data Integration API.
- Fixed: Various fixes (Thank you, Brian).
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.