Overview
Configuration is provided for establishing connections with Bloomerang service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from 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 'Bloomerang' 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 Bloomerang. Provide the base url in the Server host parameter. Then click New in the Token File parameter to create a new token file.
Step 3: Provide Username and Password. Then press 'Grant Access' button.
Step 4: Save generated access token to file. Specify token protection password. Click OK.
Step 5. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Bloomerang instance.
In this guide, we will show how to read data from the Bloomerang 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 Bloomerang connection from the combo. Select from available Bloomerang 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 Bloomerang 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 Bloomerang service.
In this guide, we will show how to write data to the Bloomerang 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 Bloomerang connection from the combo. Also, select resource action and Bloomerang 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 Bloomerang resource.
Configuration
Base URL address: https://api.bloomerang.co/v2.
- 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:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://bloomerang.co/features/integrations/api/oauth-reference-guide.
- APIKey
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- APIKey: Required. Specify API key.
The following request parameters will be automatically processed during the authentication process:
-
X-API-KEY:
{{=connection.user.APIKey}}
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/addresses.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Addresses/get_addresses.
- [Read Single] action
-
Endpoint URL address:
/address/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the addressID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Addresses/get_address__id_.
- [Create] action
-
Endpoint URL address:
/address.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Addresses/post_address.
- [Update] action
-
Endpoint URL address:
/address/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Addresses/put_address__id_.
- [Delete] action
-
Endpoint URL address:
/address/{{=item.Id}}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Addresses/delete_address__id_.
The resource includes the fields from the AddressT template.
- StateAbbreviation
Template: ShortText.
- CountryCode
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/appeals.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Appeals/get_appeals.
- [Read Single] action
-
Endpoint URL address:
/appeal/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the AppeaID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Appeals/get_appeal__id_.
- [Create] action
-
Endpoint URL address:
/appeal.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Appeals/post_appeal.
- [Update] action
-
Endpoint URL address:
/appeal/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Appeals/put_appeal__id_.
- Id
A key field. Data type: DT_I4
- Name
Template: ShortText.
- SortIndex
Data type: DT_I4
- IsActive
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/campaigns.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Campaigns/get_campaigns.
- [Read Single] action
-
Endpoint URL address:
/campaign/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the CampaignID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Campaigns/get_campaign__id_.
- [Read Refresh Summary] action
-
Endpoint URL address:
/campaigns/refreshsummaries.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Campaigns/get_campaigns_refreshsummaries.
- [Create] action
-
Endpoint URL address:
/campaign.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Campaigns/post_campaign.
- [Update] action
-
Endpoint URL address:
/campaign/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Campaigns/put_campaign__id_.
- Id
A key field. Data type: DT_I4
- StartDate
Template: DateTime. A read-only field.
- EndDate
Template: DateTime. A read-only field.
- Goal
Data type: DT_I8
- Name
Template: ShortText.
- SortIndex
Data type: DT_I4
- IsActive
Data type: DT_BOOL
- Raised
Data type: DT_R8
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/constituents.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Constituents/get_constituents.
- [Read Single] action
-
Endpoint URL address:
/constituent/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the ConstituentID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Constituents/get_constituent__id_.
- [Read Duplicate] action
-
Endpoint URL address:
/constituent/duplicates.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Constituents/get_constituent_duplicates.
- [Read search] action
-
Endpoint URL address:
/constituents/search.The following request parameters will be automatically processed:
-
type:
Individual
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Constituents/get_constituents_search.
-
type:
- [Create] action
-
Endpoint URL address:
/constituent.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Constituents/post_constituent.
- [Update] action
-
Endpoint URL address:
/constituent/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Constituents/put_constituent__id_.
- [Delete] action
-
Endpoint URL address:
/constituent/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Constituents/delete_constituent__id_.
- Id
A key field. Data type: DT_I4
- AccountNumber
Data type: DT_I4
- PreferredCommunicationChannel
Template: ShortText.
- CommunicationRestrictions
Template: LongText. A composite field.
- EmailInterestType
Template: ShortText.
- DonorSearchInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, GenerosityScore.
-
Uses template:
- IsFavorite
Data type: DT_BOOL
- Relationships
The gathered value is processed with
{{=connection.resourceManager['Relationship'].getData({ endpoint: 'constituent', parameters: ['constituent_id=' + item.id] })}}expression. Field components:- An array.
- Contains the following components: Id, RelationshipRole1, RelationshipRole2, AccountId1, AccountId2, Note.
- Timeline
The value is gathered from
/constituent/{{=item.Id}}/timelineaddress. The gathered value is processed with{{=response.Results}}expression. Field components:- An array.
- Contains the following components: Id, AccountId, date, CreatedDate, Type.
- IsInHousehold
Data type: DT_BOOL
- IsHeadOfHousehold
Data type: DT_BOOL
- Type
Template: ShortText.
- Status
Template: ShortText.
- FirstName
Template: ShortText.
- LastName
Template: ShortText.
- MiddleName
Template: ShortText.
- Prefix
Template: ShortText.
- Suffix
Template: ShortText.
- FullName
Template: ShortText.
- InformalName
Template: ShortText.
- FormalName
Template: ShortText.
- EnvelopeName
Template: ShortText.
- RecognitionName
Template: ShortText.
- JobTitle
Template: ShortText.
- Employer
Template: ShortText.
- Website
Template: ShortText.
- FacebookId
Template: ShortText.
- TwitterId
Template: ShortText.
- LinkedInId
Template: ShortText.
- Gender
Template: ShortText.
- Birthdate
Template: DateTime.
- ProfilePictureType
Template: ShortText.
- EngagementScore
Template: ShortText.
- PrimaryAddress
Template: AddressT.
- AddressIds
Template: LongText. A composite field.
- PrimaryEmail
Template: EmailT.
- EmailIds
Template: LongText. A composite field.
- PrimaryPhone
Template: PhoneT.
- PhoneIds
Template: LongText. A composite field.
- AuditTrail
Template: AuditTrailT. A read-only field.
- SecondaryAddresses
Field components:
- An array.
-
Uses template:
AddressT.
- SecondaryEmails
Field components:
- An array.
-
Uses template:
EmailT.
- SecondaryPhones
Field components:
- An array.
-
Uses template:
PhoneT.
- CustomValues
Template: CustomValuesT.
- [External]
-
The external fields URL address:
/customFields/Constituent/.- Custom.{{=external.Name}}
Data type: {{=Bloomerang.getDataType(external.DataType)}} ( length 250 ) The gathered value is processed with
{{=item.Custom[field.external.Id]}}expression. Before setting, the value is processed with{{=Bloomerang.getSetValue(field, value)}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/customFieldCategories/{{=parameters.type}}/.
The result is extracted from:{{=response}}.The action has the following user-defined parameters:
- type: Required. Specify the Object type to filters categories for the given object type.
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Custom%20Fields/get_customFieldCategories__type__.
- [Read Field] action
-
Endpoint URL address:
/customFields/{{=parameters.type}}/.The action has the following user-defined parameters:
- type: Required. Specify the Object type to filters fields for the given object type.
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Custom%20Fields/get_customFields__type__.
- [Read Field Value] action
-
Endpoint URL address:
/customValues/{{=parameters.type}}.The action has the following user-defined parameters:
- type: Required. Specify the Object type to get custom values for all pick fields of the given object type.
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Custom%20Fields/get_customValues__type_.
- [Read Single Field Values] action
-
Endpoint URL address:
/customValues/{{=parameters.type}}/{{=parameters.FieldId}}.The action has the following user-defined parameters:
- type: Required. Please specify the Object Type
- FieldId: Required. Please specify the FieldId
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Custom%20Fields/get_customValues__type___fieldId_.
- Id
Data type: DT_I4
- CategoryId
Data type: DT_I4
- Name
Template: ShortText.
- SortIndex
Data type: DT_I4
- IsRequired
Data type: DT_BOOL
- IsActive
Data type: DT_BOOL
- DataType
Template: ShortText.
- PickType
Template: ShortText.
- FieldId
Data type: DT_I4
- Value
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/emails.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Email%20Addresses/get_emails.
- [Read Single] action
-
Endpoint URL address:
/email/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the Id of the emailAddress to return
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Email%20Addresses/get_email__id_.
- [Create] action
-
Endpoint URL address:
/email.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Email%20Addresses/post_email.
- [Update] action
-
Endpoint URL address:
/email/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Email%20Addresses/put_email__id_.
- [Delete] action
-
Endpoint URL address:
/email/{{=item.Id}}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Email%20Addresses/delete_email__id_.
The resource includes the fields from the EmailT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/emailInterests.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Email%20Interests/get_emailInterests.
- [Read Single] action
-
Endpoint URL address:
/emailInterest/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the Id of the emailInterest to return
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Email%20Interests/get_emailInterest__id_.
- Id
Data type: DT_I4
- IsSurveyEmailInterest
Data type: DT_BOOL
- IsDefault
Data type: DT_BOOL
- Name
Template: ShortText.
- SortIndex
Data type: DT_I4
- IsActive
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/funds.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Funds/get_funds.
- [Read Single] action
-
Endpoint URL address:
/fund/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the Id of the fund to return
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Funds/get_fund__id_.
- [Create] action
-
Endpoint URL address:
/fund.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Funds/post_fund.
- [Update] action
-
Endpoint URL address:
/fund/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Funds/put_fund__id_.
- Id
Data type: DT_I4
- IsDefault
Data type: DT_BOOL
- Name
Template: ShortText.
- SortIndex
Data type: DT_I4
- IsActive
Data type: DT_BOOL
- GeneralLedgerClass
Template: ShortText.
- DefaultQuickbooksAccountId
Data type: DT_I4
- QuickbooksAccountIds
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/households.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Households/get_households.
- [Read Single] action
-
Endpoint URL address:
/household/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the Id of the emailAddress to return
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Households/get_household__id_.
- [Read search] action
-
Endpoint URL address:
/constituents/search.The following request parameters will be automatically processed:
-
type:
Household
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Households/get_constituents_search.
-
type:
- [Create] action
-
Endpoint URL address:
/household.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Households/post_household.
- [Update] action
-
Endpoint URL address:
/household/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Households/put_household__id_.
- [Delete] action
-
Endpoint URL address:
/household/{{=item.Id}}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Households/delete_household__id_.
- Id
Data type: DT_I4
- Type
Template: ShortText.
- Status
Template: ShortText.
- EngagementScore
Template: ShortText.
- HeadId
Data type: DT_I4
- MemberIds
Template: LongText. A composite field.
- IsFavorite
Data type: DT_BOOL
- CommunicationRestrictions
Template: LongText. A composite field.
- AuditTrail
Template: AuditTrailT. A read-only field.
- AccountNumber
Data type: DT_I4
- FullName
Template: ShortText.
- SortName
Template: ShortText.
- InformalName
Template: ShortText.
- FormalName
Template: ShortText.
- EnvelopeName
Template: ShortText.
- RecognitionName
Template: ShortText.
- Head
Template: ProfileT.
- Members
Field components:
- An array.
-
Uses template:
ProfileT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/interactions.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Interactions/get_interactions.
- [Read Single] action
-
Endpoint URL address:
/interaction/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the interactionID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Notes/get_note__id_.
- [Create] action
-
Endpoint URL address:
/interaction.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Notes/post_note.
- [Update] action
-
Endpoint URL address:
/interaction/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Notes/put_note__id_.
- [Delete] action
-
Endpoint URL address:
/interaction/{{=item.Id}}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Notes/delete_note__id_.
- Id
A key field. Data type: DT_I4
- Date
Template: ShortText.
- Note
Template: ShortText.
- Channel
Template: ShortText.
- Purpose
Template: ShortText.
- Subject
Template: ShortText.
- IsInbound
Data type: DT_BOOL
- AccountId
Data type: DT_I4
- TweetId
Template: ShortText.
- IsBcc
Data type: DT_BOOL
- EmailAddress
Template: ShortText.
- AttachmentIds
Template: LongText. A composite field.
- LetterAttachmentIds
Template: LongText. A composite field.
- SurveyLapsedResponses
Template: LongText. A composite field.
- IsEngagementSurveyResponse
Data type: DT_BOOL
- SurveyEmailInteractionId
Data type: DT_I4
- IsEngagementSurveyEmail
Data type: DT_BOOL
- SurveyResponseInteractionId
Data type: DT_I4
- CustomValues
Template: CustomValuesT.
- AuditTrail
Template: AuditTrailT. A read-only field.
- [External]
-
The external fields URL address:
/customFields/Interaction/.- Custom.{{= external.Name }}
Data type: {{=Bloomerang.getDataType(external.DataType)}} ( length 250 ) The gathered value is processed with
{{=item.Custom[field.external.Id]}}expression. Before setting, the value is processed with{{=Bloomerang.getSetValue(field, value)}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/notes.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Notes/get_notes.
- [Read Single] action
-
Endpoint URL address:
/note/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the noteID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Notes/get_note__id_.
- [Create] action
-
Endpoint URL address:
/note.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Notes/post_note.
- [Update] action
-
Endpoint URL address:
/note/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Notes/put_note__id_.
- [Delete] action
-
Endpoint URL address:
/note/{{=item.Id}}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Notes/delete_note__id_.
- Id
A key field. Data type: DT_I4
- AttachmentIds
Template: LongText. A composite field.
- AccountId
Data type: DT_I4
- Date
Template: DateTime.
- Note
Template: ShortText.
- CustomValues
Template: CustomValuesT.
- Attachments
Template: AttachmentsT.
- AuditTrail
Template: AuditTrailT. A read-only field.
- [External]
-
The external fields URL address:
/customFields/Note/.- Custom.{{= external.Name }}
Data type: {{=Bloomerang.getDataType(external.DataType)}} ( length 250 ) The gathered value is processed with
{{=item.Custom[field.external.Id]}}expression. Before setting, the value is processed with{{=Bloomerang.getSetValue(field, value)}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/phones.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Phones/get_phones.
- [Read Single] action
-
Endpoint URL address:
/phone/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the phoneID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Phones/get_phone__id_.
- [Create] action
-
Endpoint URL address:
/phone.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Phones/post_phone.
- [Update] action
-
Endpoint URL address:
/phone/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Phones/put_phone__id_.
- [Delete] action
-
Endpoint URL address:
/phone/{{=item.Id}}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Phones/delete_phone__id_.
The resource includes the fields from the PhoneT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/processors.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Processors/get_processors.
- [Read Single] action
-
Endpoint URL address:
/processor/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the processorID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Processors/get_processor__id_.
- Id
Data type: DT_I4
- Type
Template: ShortText.
- SortIndex
Data type: DT_I4
- Name
Template: ShortText.
- IsDefault
Data type: DT_BOOL
- IsActive
Data type: DT_BOOL
- PublicKey
Template: ShortText.
- IsStripeConnect
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/refunds.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Refunds/get_refunds.
- [Read Single] action
-
Endpoint URL address:
/refund/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the refundID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Refunds/get_refund__id_.
- [Create] action
-
Endpoint URL address:
/refund.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Refunds/post_refund.
- [Update] action
-
Endpoint URL address:
/refund/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Refunds/put_refund__id_.
- [Delete] action
-
Endpoint URL address:
/refund/{{=item.Id}}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Refunds/delete_refund__id_.
- Id
A key field. Data type: DT_I4
- TransactionId
Data type: DT_I4
- Note
Template: ShortText.
- Date
Template: DateTime.
- Amount
Data type: DT_R8
- AuditTrail
Template: AuditTrailT. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/relationshiproles.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Relationship%20Roles/get_relationshiproles.
- [Read Single] action
-
Endpoint URL address:
/relationshiprole/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the relationshipID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Relationship%20Roles/get_relationshiprole__id_.
- Id
Data type: DT_I4
- SortIndex
Data type: DT_I4
- Name
Template: ShortText.
- IsDefault
Data type: DT_BOOL
- IsActive
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/relationship/{{=parameters.id}}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the refundID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Relationships/get_relationship__id_.
- [Read constituent] action
-
Endpoint URL address:
/constituent/{{=parameters.constituent_id}}/relationships.
The result is extracted from:{{=response.Results}}.The action has the following user-defined parameters:
- constituent_id: Required. Please specify the constituent identifier.
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Constituents/get_constituent__id__relationships.
- [Create] action
-
Endpoint URL address:
/relationship.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Relationships/post_relationship.
- [Update] action
-
Endpoint URL address:
/relationship/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Relationships/put_relationship__id_.
- [Delete] action
-
Endpoint URL address:
/relationship/{{=item.Id}}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Relationships/delete_relationship__id_.
- Id
A key field. Data type: DT_I4
- AccountId1
Data type: DT_I4
- AccountId2
Data type: DT_I4
- Note
Template: ShortText.
- RelationshipRole1
Template: RelationshipRoleT.
- RelationshipRole2
Template: RelationshipRoleT.
- RelationshipRoleId1
Data type: DT_I4
- RelationshipRoleId2
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/softcredits.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Soft%20Credits/get_softcredits.
- [Read Single] action
-
Endpoint URL address:
/softcredit/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the softCreditID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Soft%20Credits/get_softcredit__id_.
- [Create] action
-
Endpoint URL address:
/softcredit.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Soft%20Credits/post_softcredit.
- [Update] action
-
Endpoint URL address:
/softcredit/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Soft%20Credits/put_softcredit__id_.
- [Delete] action
-
Endpoint URL address:
/softcredit/{{=item.Id}}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Soft%20Credits/delete_softcredit__id_.
- Id
A key field. Data type: DT_I4
- DesignationId
Data type: DT_I4
- TransactionId
Data type: DT_I4
- Amount
Data type: DT_R8
- AccountId
Data type: DT_I4
- AuditTrail
Template: AuditTrailT. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tasks.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Tasks/get_tasks.
- [Read Single] action
-
Endpoint URL address:
/task/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the taskID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Tasks/get_task__id_.
- [Create] action
-
Endpoint URL address:
/task.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Tasks/post_task.
- [Update] action
-
Endpoint URL address:
/task/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Tasks/put_task__id_.
- [Delete] action
-
Endpoint URL address:
/task/{{=item.Id}}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Tasks/delete_task__id_.
- Id
A key field. Data type: DT_I4
- AccountId
Data type: DT_I4
- Status
Template: ShortText.
- CompletedDate
Template: DateTime.
- DueDate
Template: DateTime.
- Subject
Template: ShortText.
- Note
Template: ShortText.
- Channel
Template: ShortText.
- Purpose
Template: ShortText.
- UserId
Data type: DT_I4
- InteractionId
Data type: DT_I4
- AttachmentIds
Template: LongText. A composite field.
- Attachments
Template: AttachmentsT.
- AuditTrail
Template: AuditTrailT. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/transactions.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Transactions/get_transactions.
- [Read Single] action
-
Endpoint URL address:
/transaction/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the transactionID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Transactions/get_transaction__id_.
- [Create] action
-
Endpoint URL address:
/transaction.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Transactions/post_transaction.
- [Update] action
-
Endpoint URL address:
/transaction/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Transactions/put_transaction__id_.
- [Delete] action
-
Endpoint URL address:
/transaction/{{=item.Id}}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Transactions/delete_transaction__id_.
- Id
A key field. Data type: DT_I4
- TransactionNumber
Data type: DT_I4
- NonDeductibleAmount
Data type: DT_R8
- AccountId
Data type: DT_I4
- Date
Template: DateTime.
- Amount
Data type: DT_R8
- Method
Template: ShortText.
- CheckNumber
Template: ShortText.
- CheckDate
Template: DateTime.
- CreditCardType
Template: ShortText.
- CreditCardLastFourDigits
Template: ShortText.
- CreditCardExpMonth
Template: ShortText.
- CreditCardExpYear
Template: ShortText.
- EftAccountType
Template: ShortText.
- EftLastFourDigits
Template: ShortText.
- EftRoutingNumber
Template: ShortText.
- InKindDescription
Template: ShortText.
- InKindType
Template: ShortText.
- InKindMarketValue
Data type: DT_R8
- WalletItemId
Data type: DT_I4
- IntegrationUrl
Template: ShortText.
- Designations
Field components:
- An array.
-
Uses template:
TransactionDesignation.
- Attachments
Template: AttachmentsT.
- AttachmentIds
Template: LongText. A composite field.
- IsRefunded
Template: ShortText.
- RefundIds
Template: LongText. A composite field.
- AuditTrail
Template: AuditTrailT. A read-only field.
- CustomValues
Template: CustomValuesT.
- [External]
-
The external fields URL address:
/customFields/Transaction/.- Custom.{{= external.Name }}
Data type: {{=Bloomerang.getDataType(external.DataType)}} ( length 250 ) The gathered value is processed with
{{=item.Custom[field.external.Id]}}expression. Before setting, the value is processed with{{=Bloomerang.getSetValue(field, value)}}expression.
Based on resource template Base.
- [Read Transactions Designations] action
-
Endpoint URL address:
/transactions/designations.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Transactions/get_transactions_designations.
- [Read Single Transaction Desgnation] action
-
Endpoint URL address:
/transactions/designation/{{=parameters.id}}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the designationID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Transactions/get_transactions_designation__id_.
The resource includes the fields from the TransactionDesignation template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tributes.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Tributes/get_tributes.
- [Read Single] action
-
Endpoint URL address:
/tribute/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the tributeID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Tributes/get_tribute__id_.
- [Read Search Tribute] action
-
Endpoint URL address:
/tributes/search.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Tributes/get_tributes_search.
- [Create] action
-
Endpoint URL address:
/tribute.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Tributes/post_tribute.
- [Update] action
-
Endpoint URL address:
/tribute/{{=item.Id }}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Tributes/put_tribute__id_.
- Id
A key field. Data type: DT_I4
- Note
Template: ShortText.
- TributeType
Template: ShortText.
- NotificantAccountIds
Template: LongText. A composite field.
- Name
Template: ShortText.
- IsDefault
Data type: DT_BOOL
- IsActive
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/walletitems.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Wallet%20Items/get_walletitems.
- [Read Single] action
-
Endpoint URL address:
/walletitem/{{=parameters.id }}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the walletItemID
Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Wallet%20Items/get_walletitem__id_.
- [Create] action
-
Endpoint URL address:
/walletitem.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Wallet%20Items/post_walletitem.
- [Delete] action
-
Endpoint URL address:
/walletitem/{{=item.Id}}.Documentation: https://bloomerang.co/features/integrations/api/rest-api#/Wallet%20Items/delete_walletitem__id_.
- Id
A key field. Data type: DT_I4
- AccountId
Data type: DT_I4
- TransactionProcessorAccountId
Data type: DT_I4
- Type
Template: ShortText.
- CreditCardType
Template: ShortText.
- CreditCardLastFour
Data type: DT_I4
- CreditCardExpiration
Template: DateTime.
- EftAccountType
Template: ShortText.
- EftAccountLastFour
Template: ShortText.
- EftRoutingNumber
Template: ShortText.
- Token
Template: ShortText.
- IsSpreedlyToken
Data type: DT_BOOL
- [Read] action
-
The result is extracted from:{{=response.Results}}.
The result is paginated.The following request parameters will be automatically processed:
-
skip:
{{=parameters.iterator}} -
take:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
skip:
- [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 PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- AuditTrailT
Field components:
-
Uses template:
DateTime. - Contains the following components: CreatedDate, CreatedName, LastModifiedDate, LastModifiedName.
-
Uses template:
- RelationshipRoleT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, IsDefault, Name, SortIndex, IsActive.
-
Uses template:
- AddressT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, AccountId, Type, Street, City, State, PostalCode, Country, IsPrimary, IsBad.
-
Uses template:
- EmailT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, AccountId, Type, Value, IsPrimary, IsBad.
-
Uses template:
- PhoneT
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, AccountId, Type, Extension, Number, IsPrimary.
-
Uses template:
- AttachmentsT
Field components:
- An array.
- Contains the following components: Guid, Name, Extension, Url.
- CustomValuesT
Field components:
- An array.
- Contains the following components: FieldId, Value.
- ProfileT
Field components:
-
Uses template:
ShortText. - Contains the following components: Type, Status, FirstName, LastName, MiddleName, Prefix, Suffix, FullName, InformalName, FormalName, EnvelopeName, RecognitionName, JobTitle, Employer, Website, FacebookId, TwitterId, LinkedInId, Gender, Birthdate, ProfilePictureType, PrimaryEmail, PrimaryPhone, PrimaryAddress, SecondaryAddresses, SecondaryPhones, FullCustomProfileImage, CroppedCustomProfileImage, CustomValues.
-
Uses template:
- Ref
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, Name.
-
Uses template:
- TransactionDesignation
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, Amount, Note, AcknowledgementStatus, AcknowledgementInteractionIds, Type, NonDeductibleAmount, FundId, QuickbooksAccountId, CampaignId, AppealId, TributeId, SoftCreditIds, CustomValues, TransactionId, Fund, Campaign, Appeal, Tribute, TributeType, AttachmentIds, DesignationNumber, AuditTrail.
-
Uses template:
What's New
- 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.