Blackbaud · Schema

NewRevenueBatchRow

CreateRevenueBatchRow

Non-ProfitFundraisingDonor ManagementCRMFund AccountingEducationGrantmakingPaymentsPhilanthropySocial Impact

Properties

Name	Type	Description
batch_id	string	The batch ID.
batch_data_form_id	string	The batch data form ID.
constituent_id	string	The constituent.
constituent_lookup_id	string	The lookup ID.
type	string	The revenue type. Available values are payment, pledge, recurring gift
date	string	The date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.
amount	number	The amount.
payment_method	string	The payment method. Available values are cash, check, credit card, credit card - last 4 digits, direct debit, stock, property, gift-in-kind,
constituent_account	string	The account. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/59d26d27-5304-4e93-a55e-ebb5d5fd85a4?parameters=constituentid1,{constituent_id}¶meters=constitue
do_not_acknowledge	boolean	Indicates whether do not acknowledge.
do_not_receipt	boolean	Indicates whether do not receipt.
check_date	object
check_number	string	The check number.
reference_number	string	The reference number.
reference_date	object
credit_card_number	string	The card number.
card_holder_name	string	The name on card.
expires_on	object
credit_type	string	The card type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/credittypecode/entries
authorization_code	string	The authorization code.
credit_card_token	string	The credit card token.
issuer	string	The issuer.
merchant_account_id	string	The merchant account.
number_of_units	number	The stock number of units.
symbol	string	The symbol.
median_price	number	The median price.
property_sub_type	string	The property subtype. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/propertysubtypecode/entries
gift_in_kind_sub_type	string	The gift-in-kind subtype. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/giftinkindsubtypecode/entries
receipt_amount	number	The receipt amount.
single_designation_id	string	The designation.
splits	array	Splits.
apply_by_percent	boolean	Indicates whether apply by.
revenue_streams	array	Revenue streams.
apply_to_shown_for_constituent_id	string	The apply to shown for constituent.
sequence	integer	The sequence.
installment_frequency	string	The installment frequency. Available values are annually, semi-annually, quarterly, bimonthly, monthly, semi-monthly, biweekly, weekly, irreg
installment_start_date	string	The installment start date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.
installment_end_date	string	The installment end date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.
number_of_installments	integer	The no. installments.
installment_amount	number	The installment amount.
solicitors	array	Solicitors.
benefits	array	Benefits.
finder_number	integer	The finder number.
source_code	string	The source code.
appeal_id	string	The appeal.
finder_number_is_valid	boolean	Indicates whether finder number is valid.
user_modified_benefits	boolean	Indicates whether user modified benefits.
benefits_waived	boolean	Indicates whether user waived benefits.
post_date	string	The gl post date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.
post_status	string	The gl post status. Available values are not posted, do not post
send_pledge_reminder	boolean	Indicates whether send reminders.
sale_date	string	The date on which the stock was sold. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.
sale_amount	number	The amount for which the stock was sold.
broker_fee	number	The fees charged for the sale.
sale_post_status	string	The post status in GL. Available values are not posted, do not post.
sale_post_date	string	The date posted to GL. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.
sale_low_price	number	The sale low price.
sale_median_price	number	The sale median price.
sale_high_price	number	The sale high price.
note_title	string	The title of this note.
note_date_entered	string	The date this note was entered. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.
note_author_id	string	The author of this note.
note_type	string	The user-defined type of this note. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuenotetypecode/entries
note_text_note	string	The text that comprises this note.
note_html_note	string	The html that comprises this note.
gift_amount	number	The gift amount. Read-only in the SOAP API.
given_anonymously	boolean	Indicates whether given anonymously.
given_anonymously_defaulted_for_constituent_id	string	The given anonymously defaulted for constituent.
user_modified_receipt_amount	boolean	Indicates whether user modified receipt amount.
pledge_sub_type	string	Indicates the user-defined subtype of the pledge. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/4f2263f4-6ca3-420f-9ac0-913d14d5a100.
rejection	string	Indicates the reason this row was rejected. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/rejectioncode/entries
rejection_message	string	Indicates the reason this row was rejected.
mailing_id	string	The marketing effort for the row.
channel	string	The channel for the row. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/channelcode/entries
installments	array	Installments.
payment_for_pledge_amount	number	For pledge rows, the amount to create a payment applied to that pledge.
recognitions	array	Recognitions.
did_recognitions_default	boolean	Indicates whether the batch has defaulted recognition credits for this row.
tributes	array	Tributes.
unapplied_matching_gift_splits	array	Unapplied matching gift splits.
unapplied_matching_gift_amount	number	The unapplied matching gift amount.
receipt_type	string	The receipt type. Available values are per payment, consolidated
new_constituent	array	New constituent.
other_payment_method	string	The other method. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/otherpaymentmethodcode/entries
letter_code	string	The letter. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/2ee83e88-66d2-4e79-af42-c2e37219dc78?parameters=requireselectionorexportdefinition,{false}.
acknowledge_date	string	The acknowledge date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.
reference	string	The reference.
category_code	string	The revenue category. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/d9dd46ce-6651-4fcc-b9fe-e59162662224.
acknowledgee_id	string	The acknowledgee.
application_info	string	The application. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/be9ba78d-7171-4923-b8cf-b9ed8480ef8e?parameters=constituentid1,{constituent_id}¶meters=const
other_type	string	The other type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/revenueothertypecode/entries
opportunity_id	string	The opportunity.
direct_debit_result_code	string	The result code.
low_price	number	The low price.
high_price	number	The high price.
number_of_units_sold	number	The stock sale number of units.
user_modified_number_of_units_sold	boolean	Indicates whether user modified stock number of units sold.
partial_credit_card_number	string	The partial card number.
existing_constituent	boolean	Indicates whether is existing constituent. Read-only in the SOAP API.
standing_order_reference_number	string	The standing order reference number.
standing_order_reference_date	object
standing_order_constituent_account	string	The standing order account. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/59d26d27-5304-4e93-a55e-ebb5d5fd85a4?parameters=constituentid1,{constituent_id}¶m
standing_order_setup	boolean	Indicates whether standing order has been setup.
standing_order_setup_date	string	The standing order setup date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.
tax_declarations	array	Tax declarations.
constituent_type	string	The constituent type. Read-only in the SOAP API. Available values are individual, organization, household, constituent group
transaction_id	string	The transaction ID.
transient_card	boolean	Indicates whether is transient credit card.
declines_gift_aid	boolean	Indicates whether declines gift aid.
ddi_source	string	The ddi source. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/ddisourcecode/entries
ddi_source_date	string	The ddi source date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.
covenant	boolean	Indicates whether is covenant gift.
amount_for_vat	number	The portion subject to vat.
vat_tax_rate	string	The vat tax rate. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/0adee9cf-0222-4b7c-8609-8f5ef4b4c4a6.
vat_amount	number	The vat amount.
additional_applications_stream	array	Additional applications stream.
revenue_lookup_id	string	The revenue ID.
application_solicitors	array	Application solicitors.
application_recognitions	array	Application recognitions.
mg_generated	boolean	Indicates whether mg generated.
mg_altered	boolean	Indicates whether mg altered.
matching_gifts	array	Matching gifts.
paying_pending_revenue_id	string	The was paying pending revenue.
gift_in_kind_item_name	string	The item name.
gift_in_kind_disposition	string	The disposition. Available values are to use, to sell
gift_in_kind_number_of_units	integer	The gift-in-kind number of units.
gift_in_kind_fair_market_value	number	The fair market value per unit.
direct_debit_is_rejected	boolean	Indicates whether direct debit is rejected.
percentage_benefits	array	Percentage benefits.
gift_aid_sponsorship	boolean	Indicates whether gift aid sponsorship.
other_constituent_application_info	string	The other application. Read-only in the SOAP API.
lock_box	string	The lockbox. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/bf735af5-c203-4ddf-9858-9c7d133c8181.
lock_box_batch_number	string	The lockbox batch number.
lock_box_batch_sequence	integer	The lockbox batch sequence.
pd_account_system	string	The account system. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/9eca5ee4-3b6b-4069-a4f3-9d7a832b3aff.
application_business_units	array	Application business units.
transaction_currency	string	The transaction currency. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/6e5d1d52-7c15-44be-ad8b-fc00be5c23bc?parameters=pdaccountsystemid,{pdaccountsystemid}&p
base_currency_id	string	The base currency.
base_exchange_rate	string	The base exchange rate. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/58150f60-4a87-4f64-b3d4-bcd8d587ca4a?parameters=transactioncurrencyid,{transactioncurrenc
exchange_rate	number	The exchange rate.
base_amount	number	The base amount. Read-only in the SOAP API.
generate_reference_number	boolean	Indicates whether automatically generate reference number.
source_code_import	string	The source code (import only).
current_batch_row_id	string	The batchrowid .
set_null_base_exchange_rate_to_latest	boolean	Indicates whether use latest base exchange rate when not specified.
appeal_id_for_import	string	The in import, populate this field in lieu of the normal "appeal" field to default the appeal’s designation into the designation field..
credit_card_attempt_count	integer	The credit card attempt count.
vendor_id	string	The vendor ID.
client_app_license_id	string	The client app license ID.
bbnc_transaction_processor_id	string	The bbnc transaction processor ID.
bbnc_origin_appeal_id	string	The bbnc origin appeal ID.
bbnc_tran_id	integer	The bbnc tran ID.
bbnc_id	integer	The blackbaud internet solutions transaction ID.
bbnc_origin_page_id	integer	The bbnc origin page ID.
bbnc_origin_page_name	string	The bbnc origin page name.
financial_institution_id	string	The financial institution.
account_number	string	The account number.
account_type	string	The account type. Available values are checking, savings
account_name	string	The account name.
edit_constituent_context	string	The edit constituent context. Read-only in the SOAP API.
receipt_number	string	The receipt number.
receipt_stack_short_name	string	The receipt stack short name.
mark_gift_as_receipted	boolean	Indicates whether mark gift as receipted.
email_id	integer	The email ID.
email_subject	string	The email subject.
email_name	string	The email name.
name	string	The if incoming name is different from existing name. Available values are update name, add name as an alias, ignore name, require manual review (generate exception)
similar_address	string	The if incoming address is. Available values are update existing address (old address data will not be retained), add as new address, ignore address, require manual review (gen
unsimilar_address	string	The if incoming address is not similar to any existing address. Available values are add as new address, ignore address, require manual review (generate exception)
new_address_end_date	string	The if new address has the same type as any existing address. Available values are make existing address, keep existing address active
new_address_primary	string	The make new address primary. Available values are always, only if the current primary address has the same address type, never
birth_date_rule	string	The if incoming birth date is not identical to existing birth date. Available values are ignore birth date, update birth date
different_phone	string	The if incoming phone is not identical to any existing phone. Available values are add as new phone, ignore phone, require manual review (generate exception)
new_phone_end_date	string	The if new phone has the same type as any existing phone. Available values are make existing phone, keep existing phone active
new_phone_primary	string	The make new phone primary. Available values are always, only if the current primary phone has the same phone type, never
different_email	string	The if incoming email address is not identical to any existing email address. Available values are add as new email address, ignore email address, require manual review (generate exce
new_email_end_date	string	The if new email address has the same type as any existing email address. Available values are make existing email address, keep existing email address active
new_email_primary	string	The make new email primary. Available values are always, only if the current primary email address has the same email type, never
use_global_settings	boolean	Indicates whether use global settings.
do_manual_review_for_auto_match	boolean	Indicates whether do manual review for auto match. Read-only in the SOAP API.
create_historical_name	string	The retain existing name as historical reference. Available values are yes, no
constituent_has_edits	boolean	Indicates whether constituent has edits. Read-only in the SOAP API.
first_payment_processed	string	The first payment processed.
payment_for_pledge_receipt_amount	number	The payment for pledge receipt amount.
sepa_mandate	string	The mandate. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/3444cee8-1aa9-4bde-babf-ff53eb4edf9a?parameters=constituentaccountid,{constituentaccountid}¶mete
add_sepa_mandate	boolean	Indicates whether in import, set this field to true to add a sepa mandate.
sepa_mandate_custom_identifier	string	The in import, when adding a sepa mandate, set this field to override the default value genrated for the unique mandate number.
sepa_mandate_signature_date	string	The in import, when adding a sepa mandate, optionally specify a signature date for the new mandate. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.
sepa_mandate_type	string	The in import, when adding a sepa mandate, a mandate type is required for the new mandate. Available values are one-off, recurrent
financial_institution_name	string	The financial institution name.
banking_system	string	The banking system. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/164ce2d9-5a39-436e-a63f-e4b75fdaa23d.
branch_name	string	The branch name.
routing_number	string	The routing number.
sort_code	string	The sort code.
bic	string	The bic.
bank_code	string	The bank code.
require_credit_card_processing	boolean	Indicates whether this batch row requires credit card processing.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-new-revenue-batch-row-schema.json",
  "title": "NewRevenueBatchRow",
  "description": "CreateRevenueBatchRow",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blackbaud-altru-administration-api-openapi.yml#/components/schemas/NewRevenueBatchRow",
  "required": [
    "batch_data_form_id",
    "type",
    "date",
    "amount"
  ],
  "type": "object",
  "properties": {
    "batch_id": {
      "type": "string",
      "description": "The batch ID."
    },
    "batch_data_form_id": {
      "type": "string",
      "description": "The batch data form ID."
    },
    "constituent_id": {
      "type": "string",
      "description": "The constituent."
    },
    "constituent_lookup_id": {
      "type": "string",
      "description": "The lookup ID."
    },
    "type": {
      "type": "string",
      "description": "The revenue type. Available values are <i>payment</i>, <i>pledge</i>, <i>recurring gift</i>"
    },
    "date": {
      "type": "string",
      "description": "The date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "amount": {
      "type": "number",
      "description": "The amount.",
      "format": "double"
    },
    "payment_method": {
      "type": "string",
      "description": "The payment method. Available values are <i>cash</i>, <i>check</i>, <i>credit card</i>, <i>credit card - last 4 digits</i>, <i>direct debit</i>, <i>stock</i>, <i>property</i>, <i>gift-in-kind</i>, <i>standing order</i>, <i>none</i>, <i>other</i>"
    },
    "constituent_account": {
      "type": "string",
      "description": "The account. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/59d26d27-5304-4e93-a55e-ebb5d5fd85a4?parameters=constituentid1,{constituent_id}&parameters=constituentid2,{constituent_lookup_id}."
    },
    "do_not_acknowledge": {
      "type": "boolean",
      "description": "Indicates whether do not acknowledge."
    },
    "do_not_receipt": {
      "type": "boolean",
      "description": "Indicates whether do not receipt."
    },
    "check_date": {
      "$ref": "#/$defs/FuzzyDate"
    },
    "check_number": {
      "maxLength": 20,
      "minLength": 0,
      "type": "string",
      "description": "The check number."
    },
    "reference_number": {
      "maxLength": 20,
      "minLength": 0,
      "type": "string",
      "description": "The reference number."
    },
    "reference_date": {
      "$ref": "#/$defs/FuzzyDate"
    },
    "credit_card_number": {
      "maxLength": 20,
      "minLength": 0,
      "type": "string",
      "description": "The card number."
    },
    "card_holder_name": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "The name on card."
    },
    "expires_on": {
      "$ref": "#/$defs/FuzzyDate"
    },
    "credit_type": {
      "type": "string",
      "description": "The card type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/credittypecode/entries"
    },
    "authorization_code": {
      "maxLength": 20,
      "minLength": 0,
      "type": "string",
      "description": "The authorization code."
    },
    "credit_card_token": {
      "type": "string",
      "description": "The credit card token."
    },
    "issuer": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string",
      "description": "The issuer."
    },
    "merchant_account_id": {
      "type": "string",
      "description": "The merchant account."
    },
    "number_of_units": {
      "type": "number",
      "description": "The stock number of units.",
      "format": "double"
    },
    "symbol": {
      "maxLength": 25,
      "minLength": 0,
      "type": "string",
      "description": "The symbol."
    },
    "median_price": {
      "type": "number",
      "description": "The median price.",
      "format": "double"
    },
    "property_sub_type": {
      "type": "string",
      "description": "The property subtype. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/propertysubtypecode/entries"
    },
    "gift_in_kind_sub_type": {
      "type": "string",
      "description": "The gift-in-kind subtype. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/giftinkindsubtypecode/entries"
    },
    "receipt_amount": {
      "type": "number",
      "description": "The receipt amount.",
      "format": "double"
    },
    "single_designation_id": {
      "type": "string",
      "description": "The designation."
    },
    "splits": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowSplits"
      },
      "description": "Splits."
    },
    "apply_by_percent": {
      "type": "boolean",
      "description": "Indicates whether apply by."
    },
    "revenue_streams": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowRevenueStreams"
      },
      "description": "Revenue streams."
    },
    "apply_to_shown_for_constituent_id": {
      "type": "string",
      "description": "The apply to shown for constituent."
    },
    "sequence": {
      "type": "integer",
      "description": "The sequence.",
      "format": "int32"
    },
    "installment_frequency": {
      "type": "string",
      "description": "The installment frequency. Available values are <i>annually</i>, <i>semi-annually</i>, <i>quarterly</i>, <i>bimonthly</i>, <i>monthly</i>, <i>semi-monthly</i>, <i>biweekly</i>, <i>weekly</i>, <i>irregular</i>, <i>single installment</i>"
    },
    "installment_start_date": {
      "type": "string",
      "description": "The installment start date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "installment_end_date": {
      "type": "string",
      "description": "The installment end date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "number_of_installments": {
      "type": "integer",
      "description": "The no. installments.",
      "format": "int32"
    },
    "installment_amount": {
      "type": "number",
      "description": "The installment amount.",
      "format": "double"
    },
    "solicitors": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowSolicitors"
      },
      "description": "Solicitors."
    },
    "benefits": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowBenefits"
      },
      "description": "Benefits."
    },
    "finder_number": {
      "type": "integer",
      "description": "The finder number.",
      "format": "int32"
    },
    "source_code": {
      "maxLength": 60,
      "minLength": 0,
      "type": "string",
      "description": "The source code."
    },
    "appeal_id": {
      "type": "string",
      "description": "The appeal."
    },
    "finder_number_is_valid": {
      "type": "boolean",
      "description": "Indicates whether finder number is valid."
    },
    "user_modified_benefits": {
      "type": "boolean",
      "description": "Indicates whether user modified benefits."
    },
    "benefits_waived": {
      "type": "boolean",
      "description": "Indicates whether user waived benefits."
    },
    "post_date": {
      "type": "string",
      "description": "The gl post date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "post_status": {
      "type": "string",
      "description": "The gl post status. Available values are <i>not posted</i>, <i>do not post</i>"
    },
    "send_pledge_reminder": {
      "type": "boolean",
      "description": "Indicates whether send reminders."
    },
    "sale_date": {
      "type": "string",
      "description": "The date on which the stock was sold. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "sale_amount": {
      "type": "number",
      "description": "The amount for which the stock was sold.",
      "format": "double"
    },
    "broker_fee": {
      "type": "number",
      "description": "The fees charged for the sale.",
      "format": "double"
    },
    "sale_post_status": {
      "type": "string",
      "description": "The post status in GL. Available values are <i>not posted</i>, <i>do not post</i>."
    },
    "sale_post_date": {
      "type": "string",
      "description": "The date posted to GL. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "sale_low_price": {
      "type": "number",
      "description": "The sale low price.",
      "format": "double"
    },
    "sale_median_price": {
      "type": "number",
      "description": "The sale median price.",
      "format": "double"
    },
    "sale_high_price": {
      "type": "number",
      "description": "The sale high price.",
      "format": "double"
    },
    "note_title": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string",
      "description": "The title of this note."
    },
    "note_date_entered": {
      "type": "string",
      "description": "The date this note was entered. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "note_author_id": {
      "type": "string",
      "description": "The author of this note."
    },
    "note_type": {
      "type": "string",
      "description": "The user-defined type of this note. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuenotetypecode/entries"
    },
    "note_text_note": {
      "type": "string",
      "description": "The text that comprises this note."
    },
    "note_html_note": {
      "type": "string",
      "description": "The html that comprises this note."
    },
    "gift_amount": {
      "type": "number",
      "description": "The gift amount. Read-only in the SOAP API.",
      "format": "double"
    },
    "given_anonymously": {
      "type": "boolean",
      "description": "Indicates whether given anonymously."
    },
    "given_anonymously_defaulted_for_constituent_id": {
      "type": "string",
      "description": "The given anonymously defaulted for constituent."
    },
    "user_modified_receipt_amount": {
      "type": "boolean",
      "description": "Indicates whether user modified receipt amount."
    },
    "pledge_sub_type": {
      "type": "string",
      "description": "Indicates the user-defined subtype of the pledge. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/4f2263f4-6ca3-420f-9ac0-913d14d5a100."
    },
    "rejection": {
      "type": "string",
      "description": "Indicates the reason this row was rejected. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/rejectioncode/entries"
    },
    "rejection_message": {
      "maxLength": 500,
      "minLength": 0,
      "type": "string",
      "description": "Indicates the reason this row was rejected."
    },
    "mailing_id": {
      "type": "string",
      "description": "The marketing effort for the row."
    },
    "channel": {
      "type": "string",
      "description": "The channel for the row. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/channelcode/entries"
    },
    "installments": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowInstallments"
      },
      "description": "Installments."
    },
    "payment_for_pledge_amount": {
      "type": "number",
      "description": "For pledge rows, the amount to create a payment applied to that pledge.",
      "format": "double"
    },
    "recognitions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowRecognitions"
      },
      "description": "Recognitions."
    },
    "did_recognitions_default": {
      "type": "boolean",
      "description": "Indicates whether the batch has defaulted recognition credits for this row."
    },
    "tributes": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowTributes"
      },
      "description": "Tributes."
    },
    "unapplied_matching_gift_splits": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowUnappliedMatchingGiftSplits"
      },
      "description": "Unapplied matching gift splits."
    },
    "unapplied_matching_gift_amount": {
      "type": "number",
      "description": "The unapplied matching gift amount.",
      "format": "double"
    },
    "receipt_type": {
      "type": "string",
      "description": "The receipt type. Available values are <i>per payment</i>, <i>consolidated</i>"
    },
    "new_constituent": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowNewConstituent"
      },
      "description": "New constituent."
    },
    "other_payment_method": {
      "type": "string",
      "description": "The other method. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/otherpaymentmethodcode/entries"
    },
    "letter_code": {
      "type": "string",
      "description": "The letter. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/2ee83e88-66d2-4e79-af42-c2e37219dc78?parameters=requireselectionorexportdefinition,{false}."
    },
    "acknowledge_date": {
      "type": "string",
      "description": "The acknowledge date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "reference": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "The reference."
    },
    "category_code": {
      "type": "string",
      "description": "The revenue category. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/d9dd46ce-6651-4fcc-b9fe-e59162662224."
    },
    "acknowledgee_id": {
      "type": "string",
      "description": "The acknowledgee."
    },
    "application_info": {
      "type": "string",
      "description": "The application. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/be9ba78d-7171-4923-b8cf-b9ed8480ef8e?parameters=constituentid1,{constituent_id}&parameters=constituent_lookup_id,{constituent_lookup_id}&parameters=paying_pending_revenue_id,{paying_pending_revenue_id}&parameters=commitmentid,{other_constituent_application_info}&parameters=pdaccountsystemid,{pdaccountsystemid}&parameters=batchrevenuerowid,{current_batch_row_id}."
    },
    "other_type": {
      "type": "string",
      "description": "The other type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/revenueothertypecode/entries"
    },
    "opportunity_id": {
      "type": "string",
      "description": "The opportunity."
    },
    "direct_debit_result_code": {
      "maxLength": 10,
      "minLength": 0,
      "type": "string",
      "description": "The result code."
    },
    "low_price": {
      "type": "number",
      "description": "The low price.",
      "format": "double"
    },
    "high_price": {
      "type": "number",
      "description": "The high price.",
      "format": "double"
    },
    "number_of_units_sold": {
      "type": "number",
      "description": "The stock sale number of units.",
      "format": "double"
    },
    "user_modified_number_of_units_sold": {
      "type": "boolean",
      "description": "Indicates whether user modified stock number of units sold."
    },
    "partial_credit_card_number": {
      "maxLength": 4,
      "minLength": 0,
      "type": "string",
      "description": "The partial card number."
    },
    "existing_constituent": {
      "type": "boolean",
      "description": "Indicates whether is existing constituent. Read-only in the SOAP API."
    },
    "standing_order_reference_number": {
      "maxLength": 18,
      "minLength": 0,
      "type": "string",
      "description": "The standing order reference number."
    },
    "standing_order_reference_date": {
      "$ref": "#/$defs/FuzzyDate"
    },
    "standing_order_constituent_account": {
      "type": "string",
      "description": "The standing order account. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/59d26d27-5304-4e93-a55e-ebb5d5fd85a4?parameters=constituentid1,{constituent_id}&parameters=constituentid2,{constituent_lookup_id}."
    },
    "standing_order_setup": {
      "type": "boolean",
      "description": "Indicates whether standing order has been setup."
    },
    "standing_order_setup_date": {
      "type": "string",
      "description": "The standing order setup date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "tax_declarations": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowTaxDeclarations"
      },
      "description": "Tax declarations."
    },
    "constituent_type": {
      "type": "string",
      "description": "The constituent type. Read-only in the SOAP API. Available values are <i>individual</i>, <i>organization</i>, <i>household</i>, <i>constituent group</i>"
    },
    "transaction_id": {
      "type": "string",
      "description": "The transaction ID."
    },
    "transient_card": {
      "type": "boolean",
      "description": "Indicates whether is transient credit card."
    },
    "declines_gift_aid": {
      "type": "boolean",
      "description": "Indicates whether declines gift aid."
    },
    "ddi_source": {
      "type": "string",
      "description": "The ddi source. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/ddisourcecode/entries"
    },
    "ddi_source_date": {
      "type": "string",
      "description": "The ddi source date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "covenant": {
      "type": "boolean",
      "description": "Indicates whether is covenant gift."
    },
    "amount_for_vat": {
      "type": "number",
      "description": "The portion subject to vat.",
      "format": "double"
    },
    "vat_tax_rate": {
      "type": "string",
      "description": "The vat tax rate. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/0adee9cf-0222-4b7c-8609-8f5ef4b4c4a6."
    },
    "vat_amount": {
      "type": "number",
      "description": "The vat amount.",
      "format": "double"
    },
    "additional_applications_stream": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowAdditionalApplicationsStream"
      },
      "description": "Additional applications stream."
    },
    "revenue_lookup_id": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string",
      "description": "The revenue ID."
    },
    "application_solicitors": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowApplicationSolicitors"
      },
      "description": "Application solicitors."
    },
    "application_recognitions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowApplicationRecognitions"
      },
      "description": "Application recognitions."
    },
    "mg_generated": {
      "type": "boolean",
      "description": "Indicates whether mg generated."
    },
    "mg_altered": {
      "type": "boolean",
      "description": "Indicates whether mg altered."
    },
    "matching_gifts": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowMatchingGifts"
      },
      "description": "Matching gifts."
    },
    "paying_pending_revenue_id": {
      "type": "string",
      "description": "The was paying pending revenue."
    },
    "gift_in_kind_item_name": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string",
      "description": "The item name."
    },
    "gift_in_kind_disposition": {
      "type": "string",
      "description": "The disposition. Available values are <i>to use</i>, <i>to sell</i>"
    },
    "gift_in_kind_number_of_units": {
      "type": "integer",
      "description": "The gift-in-kind number of units.",
      "format": "int32"
    },
    "gift_in_kind_fair_market_value": {
      "type": "number",
      "description": "The fair market value per unit.",
      "format": "double"
    },
    "direct_debit_is_rejected": {
      "type": "boolean",
      "description": "Indicates whether direct debit is rejected."
    },
    "percentage_benefits": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowPercentageBenefits"
      },
      "description": "Percentage benefits."
    },
    "gift_aid_sponsorship": {
      "type": "boolean",
      "description": "Indicates whether gift aid sponsorship."
    },
    "other_constituent_application_info": {
      "type": "string",
      "description": "The other application. Read-only in the SOAP API."
    },
    "lock_box": {
      "type": "string",
      "description": "The lockbox. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/bf735af5-c203-4ddf-9858-9c7d133c8181."
    },
    "lock_box_batch_number": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string",
      "description": "The lockbox batch number."
    },
    "lock_box_batch_sequence": {
      "type": "integer",
      "description": "The lockbox batch sequence.",
      "format": "int32"
    },
    "pd_account_system": {
      "type": "string",
      "description": "The account system. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/9eca5ee4-3b6b-4069-a4f3-9d7a832b3aff."
    },
    "application_business_units": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewRevenueBatchRowApplicationBusinessUnits"
      },
      "description": "Application business units."
    },
    "transaction_currency": {
      "type": "string",
      "description": "The transaction currency. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/6e5d1d52-7c15-44be-ad8b-fc00be5c23bc?parameters=pdaccountsystemid,{pdaccountsystemid}&parameters=revenuetypecode,{typecode}&parameters=currentcurrencyid,{transactioncurrencyid}."
    },
    "base_currency_id": {
      "type": "string",
      "description": "The base currency."
    },
    "base_exchange_rate": {
      "type": "string",
      "description": "The base exchange rate. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/58150f60-4a87-4f64-b3d4-bcd8d587ca4a?parameters=transactioncurrencyid,{transactioncurrencyid}&parameters=pdaccountsystemid,{pdaccountsystemid}&parameters=asofdate,{date}&parameters=includespotrate,{1}&parameters=revenuetypecode,{typecode}&parameters=base_currency_id,{base_currency_id}."
    },
    "exchange_rate": {
      "type": "number",
      "description": "The exchange rate.",
      "format": "double"
    },
    "base_amount": {
      "type": "number",
      "description": "The base amount. Read-only in the SOAP API.",
      "format": "double"
    },
    "generate_reference_number": {
      "type": "boolean",
      "description": "Indicates whether automatically generate reference number."
    },
    "source_code_import": {
      "maxLength": 60,
      "minLength": 0,
      "type": "string",
      "description": "The source code (import only)."
    },
    "current_batch_row_id": {
      "type": "string",
      "description": "The batchrowid ."
    },
    "set_null_base_exchange_rate_to_latest": {
      "type": "boolean",
      "description": "Indicates whether use latest base exchange rate when not specified."
    },
    "appeal_id_for_import": {
      "type": "string",
      "description": "The in import, populate this field in lieu of the normal \"appeal\" field to default the appeal’s designation into the designation field.."
    },
    "credit_card_attempt_count": {
      "type": "integer",
      "description": "The credit card attempt count.",
      "format": "int32"
    },
    "vendor_id": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string",
      "description": "The vendor ID."
    },
    "client_app_license_id": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string",
      "description": "The client app license ID."
    },
    "bbnc_transaction_processor_id": {
      "type": "string",
      "description": "The bbnc transaction processor ID."
    },
    "bbnc_origin_appeal_id": {
      "type": "string",
      "description": "The bbnc origin appeal ID."
    },
    "bbnc_tran_id": {
      "type": "integer",
      "description": "The bbnc tran ID.",
      "format": "int32"
    },
    "bbnc_id": {
      "type": "integer",
      "description": "The blackbaud internet solutions transaction ID.",
      "format": "int32"
    },
    "bbnc_origin_page_id": {
      "type": "integer",
      "description": "The bbnc origin page ID.",
      "format": "int32"
    },
    "bbnc_origin_page_name": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string",
      "description": "The bbnc origin page name."
    },
    "financial_institution_id": {
      "type": "string",
      "description": "The financial institution."
    },
    "account_number": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string",
      "description": "The account number."
    },
    "account_type": {
      "type": "string",
      "description": "The account type. Available values are <i>checking</i>, <i>savings</i>"
    },
    "account_name": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string",
      "description": "The account name."
    },
    "edit_constituent_context": {
      "type": "string",
      "description": "The edit constituent context. Read-only in the SOAP API."
    },
    "receipt_number": {
      "maxLength": 30,
      "minLength": 0,
      "type": "string",
      "description": "The receipt number."
    },
    "receipt_stack_short_name": {
      "maxLength": 20,
      "minLength": 0,
      "type": "string",
      "description": "The receipt stack short name."
    },
    "mark_gift_as_receipted": {
      "type": "boolean",
      "description": "Indicates whether mark gift as receipted."
    },
    "email_id": {
      "type": "integer",
      "description": "The email ID.",
      "format": "int32"
    },
    "email_subject": {
      "maxLength": 510,
      "minLength": 0,
      "type": "string",
      "description": "The email subject."
    },
    "email_name": {
      "maxLength": 510,
      "minLength": 0,
      "type": "string",
      "description": "The email name."
    },
    "name": {
      "type": "string",
      "description": "The if incoming name is different from existing name. Available values are <i>update name</i>, <i>add name as an alias</i>, <i>ignore name</i>, <i>require manual review (generate exception)</i>"
    },
    "similar_address": {
      "type": "string",
      "description": "The if incoming address is. Available values are <i>update existing address (old address data will not be retained)</i>, <i>add as new address</i>, <i>ignore address</i>, <i>require manual review (generate exception)</i>"
    },
    "unsimilar_address": {
      "type": "string",
      "description": "The if incoming address is not similar to any existing address. Available values are <i>add as new address</i>, <i>ignore address</i>, <i>require manual review (generate exception)</i>"
    },
    "new_address_end_date": {
      "type": "string",
      "description": "The if new address has the same type as any existing address. Available values are <i>make existing address</i>, <i>keep existing address active</i>"
    },
    "new_address_primary": {
      "type": "string",
      "description": "The make new address primary. Available values are <i>always</i>, <i>only if the current primary address has the same address type</i>, <i>never</i>"
    },
    "birth_date_rule": {
      "type": "string",
      "description": "The if incoming birth date is not identical to existing birth date. Available values are <i>ignore birth date</i>, <i>update birth date</i>"
    },
    "different_phone": {
      "type": "string",
      "description": "The if incoming phone is not identical to any existing phone. Available values are <i>add as new phone</i>, <i>ignore phone</i>, <i>require manual review (generate exception)</i>"
    },
    "new_phone_end_date": {
      "type": "string",
      "description": "The if new phone has the same type as any existing phone. Available values are <i>make existing phone</i>, <i>keep existing phone active</i>"
    },
    "new_phone_primary": {
      "type": "string",
      "description": "The make new phone primary. Available values are <i>always</i>, <i>only if the current primary phone has the same phone type</i>, <i>never</i>"
    },
    "different_email": {
      "type": "string",
      "description": "The if incoming email address is not identical to any existing email address. Available values are <i>add as new email address</i>, <i>ignore email address</i>, <i>require manual review (generate exception)</i>"
    },
    "new_email_end_date": {
      "type": "string",
      "description": "The if new email address has the same type as any existing email address. Available values are <i>make existing email address</i>, <i>keep existing email address active</i>"
    },
    "new_email_primary": {
      "type": "string",
      "description": "The make new email primary. Available values are <i>always</i>, <i>only if the current primary email address has the same email type</i>, <i>never</i>"
    },
    "use_global_settings": {
      "type": "boolean",
      "description": "Indicates whether use global settings."
    },
    "do_manual_review_for_auto_match": {
      "type": "boolean",
      "description": "Indicates whether do manual review for auto match. Read-only in the SOAP API."
    },
    "create_historical_name": {
      "type": "string",
      "description": "The retain existing name as historical reference. Available values are <i>yes</i>, <i>no</i>"
    },
    "constituent_has_edits": {
      "type": "boolean",
      "description": "Indicates whether constituent has edits. Read-only in the SOAP API."
    },
    "first_payment_processed": {
      "maxLength": 10,
      "minLength": 0,
      "type": "string",
      "description": "The first payment processed."
    },
    "payment_for_pledge_receipt_amount": {
      "type": "number",
      "description": "The payment for pledge receipt amount.",
      "format": "double"
    },
    "sepa_mandate": {
      "type": "string",
      "description": "The mandate. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/3444cee8-1aa9-4bde-babf-ff53eb4edf9a?parameters=constituentaccountid,{constituentaccountid}&parameters=sepamandateid,{sepamandateid}."
    },
    "add_sepa_mandate": {
      "type": "boolean",
      "description": "Indicates whether in import, set this field to true to add a sepa mandate."
    },
    "sepa_mandate_custom_identifier": {
      "maxLength": 35,
      "minLength": 0,
      "type": "string",
      "description": "The in import, when adding a sepa mandate, set this field to override the default value genrated for the unique mandate number."
    },
    "sepa_mandate_signature_date": {
      "type": "string",
      "description": "The in import, when adding a sepa mandate, optionally specify a signature date for the new mandate. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "sepa_mandate_type": {
      "type": "string",
      "description": "The in import, when adding a sepa mandate, a mandate type is required for the new mandate. Available values are <i>one-off</i>, <i>recurrent</i>"
    },
    "financial_institution_name": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string",
      "description": "The financial institution name."
    },
    "banking_system": {
      "type": "string",
      "description": "The banking system. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg

# --- truncated at 32 KB (105 KB total) ---
# Full source: https://artifacts.apis.io/blackbaud/json-schema/blackbaud-new-revenue-batch-row-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/blackbaud-new-revenue-batch-row"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.