Virtuous CRMInstall

Summary

Create a gift transaction in Virtuous CRM.

Inputs

• inputMethod (required) — Input method: 'Using Fields Below' (default) supplies individual parameters; 'Using JSON' supplies a complete payload via jsonData.
• transactionSource — The source of the gift transaction (visible when inputMethod is 'fields').
• transactionId — The transaction ID of the gift transaction (visible when inputMethod is 'fields').
• contactReferenceId — The reference ID of the contact (visible when inputMethod is 'fields').
• contactId — The ID of the contact (visible when inputMethod is 'fields').
• contactName — The full name of the contact (visible when inputMethod is 'fields').
• contactType — The type of contact. Examples: Household, Organization, Foundation. Configurable via CRM. (visible when inputMethod is 'fields').
• contactTitle — The title of the contact. (visible when inputMethod is 'fields').
• contactFirstName (required) — The first name of the contact. (visible when inputMethod is 'fields').
• contactMiddleName — The middle name of the contact. (visible when inputMethod is 'fields').
• contactLastName (required) — The last name of the contact. (visible when inputMethod is 'fields').
• contactSuffix — The suffix of the contact. (visible when inputMethod is 'fields').
• contactBirthMonth — The birth month of the contact. (visible when inputMethod is 'fields').
• contactBirthDay — The birth day of the contact. (visible when inputMethod is 'fields').
• contactBirthYear — The birth year of the contact. (visible when inputMethod is 'fields').
• contactGender — The gender of the contact. (visible when inputMethod is 'fields').
• contactEmailType — The email type of the contact. Examples: Primary Email, Secondary Email, Home Email, Work Email, Other Email. (visible when inputMethod is 'fields').
• contactEmail — The email of the contact. (visible when inputMethod is 'fields').
• contactPhoneType — The phone type of the contact. Examples: Home Phone, Mobile Phone, Work Phone, Other Phone. (visible when inputMethod is 'fields').
• contactPhoneNumber — The phone number of the contact. (visible when inputMethod is 'fields').
• contactAddressLine1 — The address line 1 of the contact. (visible when inputMethod is 'fields').
• contactAddressLine2 — The address line 2 of the contact. (visible when inputMethod is 'fields').
• contactCity — The city of the contact. (visible when inputMethod is 'fields').
• contactState — The state of the contact. (visible when inputMethod is 'fields').
• contactPostal — The postal code of the contact. (visible when inputMethod is 'fields').
• contactCountry — The country of the contact. (visible when inputMethod is 'fields').
• contactTags — The tags of the contact, separated by semicolons. (visible when inputMethod is 'fields').
• contactEmailLists — Provide a JSON array of email list names. (visible when inputMethod is 'fields').
• giftDate — The date of the gift transaction. (visible when inputMethod is 'fields').
• cancelDate — The cancel date of the gift transaction. (visible when inputMethod is 'fields').
• giftType (required) — The type of the gift transaction. Examples: Cash, Check, Credit, EFT, NonCash, Stock, Other, ReversingTransaction, Cryptocoin, Pledge, PayPal. (visible when inputMethod is 'fields').
• giftAmount (required) — The amount of the gift transaction. (visible when inputMethod is 'fields').

Output shape

The raw response body from the Virtuous CRM API at POST /api/v2/Gift/Transaction.

The API response format is determined by the CRM service.

Examples

Example 1: Using fields

Set inputMethod to 'fields' and provide the required parameters (giftType, giftAmount) along with any optional contact, gift, tribute, and passthrough contact parameters. All non-empty values are sent to the CRM; empty/default values are stripped by cleanFieldsForApi.

Example 2: Using JSON

Set inputMethod to 'json' and provide a complete JSON payload via the jsonData parameter. The payload structure matches the description's jsonData schema. The payload is parsed and posted as-is.