Product: Omatic Cloud

Description: This solution presents information on creating payments in BBCRM

Environment: BBCRM

Versions: All

Answer:


The BBCRM data source destination supports the creation of payments towards various commitment types.


TABLE OF CONTENTS


Object: Revenue / Payment

The "Revenue / Payment" object maps to the payment portion of a revenue record in BBCRM, and should be used in conjunction with application objects, e.g., "Donation", "Pledge", "Recurring Gift", "Event Registration" and the "Revenue / Payment / Payment Method" object, to create payments. The payment will be associated with the mapped "Constituent / Individual" or "Constituent / Organization". Important fields, along with a description of their behavior, are detailed below:


FieldDescription
Add revenue payment?
  • If this value resolves to "True" or "Yes", a payment using the mapped data will be created in BBCRM.
  • If this value resolves to "False" or "No", all further "Revenue / Payment", "Revenue / Payment / Payment Method" and any mapped application objects will be ignored. A new revenue record will not be created in BBCRM.
Revenue lookup ID
  • A unique ID used to distinguish revenue records in BBCRM.
  • Newly created payments will use the supplied value for the revenue's "Revenue ID" in BBCRM.
  • If not supplied, will be created automatically by BBCRM.
  • Supplying a "Revenue lookup ID" prevents duplicate payments from being created if revenue is found in BBCRM with the supplied ID.
Date
  • Date to associate with the payment.
Appeal
  • Appeal to associate with solicitation of the payment.
Inbound channel
  • Channel to associate with receipt of the payment.
Reference
  • Reference value to associate with the payment.
  • Applied to the "Revenue reference" field on the "Details" of a payment.
Post status
  • Possible values: "Not posted" or "Do not post".
  • Alternate values: "1" for "Not posted" or "2" for "Do not post".
Post date
  • Date to associate with the payment's post status, if applicable.
Do not receipt
  • Possible values: "True" or "False".
  • Alternate values: "Yes" or "No".
Receipt amount
  • Monetary value which cannot be greater than the summed amounts of all mapped application objects, e.g., "Donation", "Pledge", "Recurring Gift", "Event Registration" amounts.
Payment is anonymous
  • Possible values: "True" or "False".
  • Alternate values: "Yes" or "No".


Object: Revenue / Payment / Payment Method

The "Revenue / Payment / Payment Method" object maps to the "Payment information" portion of a revenue record in BBCRM.


FieldDescription
Payment method
  • Possible values: "Credit card" or "Other".
  • If "Other" is selected, an "Other payment method" value must be provided.
Credit card type
  • Your organization's supported credit card types, e.g., Visa, American Express, etc...
Cardholder name
  • Name to associate with a "Payment method" of type "Credit card".
Card expiration date
  • Expiration date to associate with a "Payment method" of type "Credit card".
  • Supported Month-Year separators:
    • hyphen:     -
    • period:       .
    • backslash:  /
  • Example formats:
    • 5/25
    • 5/2025
    • 05.25
    • 05-2025
Card number (last 4)
  • Card number to associate with a "Payment method" of type "Credit card".
  • Values over 4 digits in length will be truncated during payment creation.
Authorization code
  • Authorization code to associate with a "Payment method" of type "Credit card".
Other payment method
  • Required if "Payment method" is of type "Other"
  • Your organization's supported "Other payment method" types, e.g. "Gift certificate".


Object: Revenue / Payment / Donation

The "Revenue / Payment / Donation" object maps to the application type "Donation" in BBCRM. Use this object in conjunction with "Revenue / Payment" and "Revenue / Payment / Payment Method" to create a payment of type "Donation" in BBCRM.


To split a payment across multiple donations, select "Add another Revenue / Payment / Donation" from the "Donation" object's "Options" menu. The "Revenue / Payment" object's "Receipt amount" value cannot be greater than the sum of all application object's "Amount" field.


FieldDescription
Add donation?
  • If this value resolves to "True" or "Yes", a payment with application type "Donation" will be created in BBCRM using this object's mapped data.
Amount
  • Monetary value to be associated with the "Donation".
Designation
  • Designation to be associated with the "Donation".
Revenue category
  • Revenue category to be associated with the "Donation"


Object: Revenue / Payment / Recurring Gift

The "Revenue / Payment / Recurring Gift" object maps to the application type "Recurring gift" in BBCRM. Use this object in conjunction with "Revenue / Payment" and "Revenue / Payment / Payment Method" to create a payment of type "Recurring gift" in BBCRM. 


To split a payment across multiple recurring gifts, select "Add another Revenue / Payment / Recurring Gift" from the "Recurring Gift" object's "Options" menu. The "Revenue / Payment" object's "Receipt amount" value cannot be greater than the sum of all application object's "Amount" field.


FieldDescription
Add recurring gift payment?
  • If this value resolves to "True" or "Yes", a payment with application type "Recurring gift" will be created in BBCRM using this object's mapped data.
Recurring gift lookup ID
  • A unique ID used to distinguish recurring gifts in BBCRM.
  • If provided, is used to search for an existing "Recurring gift" in BBCRM toward which the payment will be applied.
Amount
  • Monetary value to be associated with the installment amount of the "Recurring gift".
  • If a "Recurring gift lookup ID" is not provided, an attempt will be made to locate the recurring gift using this installment amount for the mapped "Constituent / Individual" or "Constituent / Organization".


Object: Revenue / Payment / Pledge

The "Revenue / Payment / Pledge" object maps to the application type "Pledge" in BBCRM. Use this object in conjunction with "Revenue / Payment" and "Revenue / Payment / Payment Method" to create a payment of type "Pledge" in BBCRM.


To split a payment across multiple pledges, select "Add another Revenue / Payment / Pledge" from the "Pledge" object's "Options" menu. The "Revenue / Payment" object's "Receipt amount" value cannot be greater than the sum of all application object's "Amount" field.


FieldDescription
Add pledge payment?
  • If this value resolves to "True" or "Yes", a payment with application type "Pledge" will be created in BBCRM using this object's mapped data.
Pledge lookup ID
  • A unique ID used to distinguish pledges in BBCRM.
  • If provided, is used to search for an existing "Pledge" in BBCRM toward which the payment will be applied.
Amount
  • Monetary value to be associated with the installment amount of the "Pledge".
  • If a "Pledge lookup ID" is not provided, an attempt will be made to locate the pledge using this installment amount for the mapped "Constituent / Individual" or "Constituent / Organization".


Object: Revenue / Payment / Event Registration

The "Revenue / Payment / Event Registration" object maps to the application type "Event registration" in BBCRM. Use this object in conjunction with "Revenue / Payment" and "Revenue / Payment / Payment Method" to create a payment of type "Event registration" in BBCRM.


To split a payment across multiple event registrations, select "Add another Revenue / Payment / Event registration" from the "Event registration" object's "Options" menu. The "Revenue / Payment" object's "Receipt amount" value cannot be greater than the sum of all application object's "Amount" field.


Payment Application Logic

The logic for determining which event registration to apply payment to is as-follows:

  1. If "Event registration lookup ID" is provided and references an existing BBCRM event registration with a balance, the payment will be applied to the referenced event registration.
  2. If an event registration is included on the same incoming data in the "Constituent / Event Registration" fields, the payment will be applied to this event registration.
  3. If the constituent on the incoming data in the "Constituent" fields is matched to an existing constituent and the existing constituent has a single event registration balance with the same amount as the payment, the payment is applied to that event registration.


FieldDescription
Add registration payment?
  • If this value resolves to "True" or "Yes", a payment with application type "Event registration" will be created in BBCRM using this object's mapped data.
Event registration lookup ID
Amount
  • Monetary value to be associated with the "Event registration".