{
"$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 payment, pledge, recurring gift"
},
"date": {
"type": "string",
"description": "The date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.",
"format": "date-time"
},
"amount": {
"type": "number",
"description": "The amount.",
"format": "double"
},
"payment_method": {
"type": "string",
"description": "The payment method. Available values are cash, check, credit card, credit card - last 4 digits, direct debit, stock, property, gift-in-kind, standing order, none, other"
},
"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}¶meters=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 annually, semi-annually, quarterly, bimonthly, monthly, semi-monthly, biweekly, weekly, irregular, single installment"
},
"installment_start_date": {
"type": "string",
"description": "The installment start date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.",
"format": "date-time"
},
"installment_end_date": {
"type": "string",
"description": "The installment end date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.",
"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: 1955-11-05T22:04:00.",
"format": "date-time"
},
"post_status": {
"type": "string",
"description": "The gl post status. Available values are not posted, do not post"
},
"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: 1955-11-05T22:04:00.",
"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 not posted, do not post."
},
"sale_post_date": {
"type": "string",
"description": "The date posted to GL. Uses the format YYYY-MM-DDThh:mm:ss. An example date: 1955-11-05T22:04:00.",
"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: 1955-11-05T22:04:00.",
"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 per payment, consolidated"
},
"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: 1955-11-05T22:04:00.",
"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}¶meters=constituent_lookup_id,{constituent_lookup_id}¶meters=paying_pending_revenue_id,{paying_pending_revenue_id}¶meters=commitmentid,{other_constituent_application_info}¶meters=pdaccountsystemid,{pdaccountsystemid}¶meters=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}¶meters=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: 1955-11-05T22:04:00.",
"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 individual, organization, household, constituent group"
},
"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: 1955-11-05T22:04:00.",
"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 to use, to sell"
},
"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}¶meters=revenuetypecode,{typecode}¶meters=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}¶meters=pdaccountsystemid,{pdaccountsystemid}¶meters=asofdate,{date}¶meters=includespotrate,{1}¶meters=revenuetypecode,{typecode}¶meters=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 checking, savings"
},
"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 update name, add name as an alias, ignore name, require manual review (generate exception)"
},
"similar_address": {
"type": "string",
"description": "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 (generate exception)"
},
"unsimilar_address": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The make new address primary. Available values are always, only if the current primary address has the same address type, never"
},
"birth_date_rule": {
"type": "string",
"description": "The if incoming birth date is not identical to existing birth date. Available values are ignore birth date, update birth date"
},
"different_phone": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The make new phone primary. Available values are always, only if the current primary phone has the same phone type, never"
},
"different_email": {
"type": "string",
"description": "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 exception)"
},
"new_email_end_date": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"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 yes, no"
},
"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}¶meters=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: 1955-11-05T22:04:00.",
"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 one-off, recurrent"
},
"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/simplelists/164ce2d9-5a39-436e-a63f-e4b75fdaa23d."
},
"branch_name": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "The branch name."
},
"routing_number": {
"maxLength": 9,
"minLength": 0,
"type": "string",
"description": "The routing number."
},
"sort_code": {
"maxLength": 6,
"minLength": 0,
"type": "string",
"description": "The sort code."
},
"bic": {
"maxLength": 11,
"minLength": 0,
"type": "string",
"description": "The bic."
},
"bank_code": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "The bank code."
},
"require_credit_card_processing": {
"type": "boolean",
"description": "Indicates whether this batch row requires credit card processing."
}
},
"additionalProperties": false,
"x-display-name": "Revenue Batch 2 Row Add Form",
"x-display-id": "Revenue Batch 2 Row Add Form",
"$defs": {
"FuzzyDate": {
"type": "object",
"properties": {
"year": {
"type": "integer",
"description": "The year.",
"format": "int32"
},
"month": {
"type": "integer",
"description": "The month.",
"format": "int32"
},
"day": {
"type": "integer",
"description": "The day.",
"format": "int32"
}
},
"description": "FuzzyDate",
"x-display-name": "Month Day",
"x-display-id": "Month Day"
},
"NewRevenueBatchRowAdditionalApplicationsStream": {
"required": [
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"type": {
"type": "string",
"description": "The application type. Available values are donation, other, unapplied matching gift payment, sponsorship additional donation"
},
"applied": {
"type": "number",
"description": "The applied amount."
},
"applied_percent": {
"type": "number",
"description": "The applied percent."
},
"designation_id": {
"type": "string",
"description": "The designation."
},
"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"
},
"declines_gift_aid": {
"type": "boolean",
"description": "Indicates whether gift aid is declined."
},
"gift_aid_sponsorship": {
"type": "boolean",
"description": "The gift aid sponsorship."
},
"opportunity_id": {
"type": "string",
"description": "The opportunity."
},
"sponsorship": {
"type": "string",
"description": "The sponsorship. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/98470a77-d098-433f-8871-224dc2f43de9?parameters=constituent_id,{constituent_id}."
},
"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."
},
"did_campaigns_default": {
"type": "boolean",
"description": "Indicates whether campaigns were defaulted."
},
"campaigns": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowAdditionalapplicationsstreamCampaigns"
},
"description": "Campaigns."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency."
}
},
"description": "NewRevenueBatchRowAdditionalApplicationsStream",
"x-display-name": "additional_applications_stream",
"x-display-id": "additional_applications_stream"
},
"NewRevenueBatchRowAdditionalapplicationsstreamCampaigns": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"campaign_id": {
"type": "string",
"description": "The campaign."
},
"campaign_sub_priority": {
"type": "string",
"description": "The campaign subpriority. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/e3e9e22a-85f2-4a77-ba74-25b391252dab?parameters=campaign_id,{campaign_id}."
}
},
"description": "NewRevenueBatchRowAdditionalapplicationsstreamCampaigns",
"x-display-name": "campaigns",
"x-display-id": "campaigns"
},
"NewRevenueBatchRowApplicationBusinessUnits": {
"required": [
"application_id"
],
"type": "object",
"properties": {
"application_id": {
"type": "string",
"description": "The application ID."
},
"business_units": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowApplicationbusinessunitsBusinessUnits"
},
"description": "Business units."
},
"override_business_units": {
"type": "boolean",
"description": "Indicates whether to override business units."
},
"reason": {
"type": "string",
"description": "The reason. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuesplitbusinessunitoverridecode/entries"
},
"application_declines_gift_aid": {
"type": "boolean",
"description": "Indicates whether the application declines gift aid."
},
"application_sponsorship_id": {
"type": "string",
"description": "The application sponsorship ID."
}
},
"description": "NewRevenueBatchRowApplicationBusinessUnits",
"x-display-name": "application_business_units",
"x-display-id": "application_business_units"
},
"NewRevenueBatchRowApplicationRecognitions": {
"type": "object",
"properties": {
"application_id": {
"type": "string",
"description": "The application ID."
},
"application_type_code": {
"type": "integer",
"description": "The application type."
},
"additional_application_type_code": {
"type": "integer",
"description": "The additional application type."
},
"additional_application_designation_id": {
"type": "string",
"description": "The additional application designation ID."
},
"application_amount": {
"type": "number",
"description": "The additional application amount."
},
"application_description": {
"type": "string",
"description": "The application."
},
"collection_description": {
"type": "string",
"description": "The recognition recipients."
},
"recognitions": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowApplicationrecognitionsRecognitions"
},
"description": "Recognitions."
},
"base_currency_id": {
"type": "string",
"description": "The base currency."
},
"additional_application_declines_gift_aid": {
"type": "boolean",
"description": "Indicates whether the additional application declines gift aid."
},
"additional_application_sponsorship_id": {
"type": "string",
"description": "The additional application sponsorship ID."
}
},
"description": "NewRevenueBatchRowApplicationRecognitions",
"x-display-name": "application_recognitions",
"x-display-id": "application_recognitions"
},
"NewRevenueBatchRowApplicationSolicitors": {
"type": "object",
"properties": {
"application_id": {
"type": "string",
"description": "The application ID."
},
"application_type_code": {
"type": "integer",
"description": "The application type."
},
"additional_application_type_code": {
"type": "integer",
"description": "The additional application type."
},
"additional_application_designation_id": {
"type": "string",
"description": "The additional application designation ID."
},
"application_amount": {
"type": "number",
"description": "The additional application amount."
},
"application_description": {
"type": "string",
"description": "The application."
},
"collection_description": {
"type": "string",
"description": "The solicitors."
},
"solicitors": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowApplicationsolicitorsSolicitors"
},
"description": "Solicitors."
},
"additional_application_opportunity_id": {
"type": "string",
"description": "The additional application opportunity ID."
},
"base_currency_id": {
"type": "string",
"description": "The base currency."
},
"additional_application_declines_gift_aid": {
"type": "boolean",
"description": "Indicates whether the additional application declines gift aid."
},
"additional_application_sponsorship_id": {
"type": "string",
"description": "The additional application sponsorship ID."
}
},
"description": "NewRevenueBatchRowApplicationSolicitors",
"x-display-name": "application_solicitors",
"x-display-id": "application_solicitors"
},
"NewRevenueBatchRowApplicationbusinessunitsBusinessUnits": {
"required": [
"business_unit",
"amount"
],
"type": "object",
"properties": {
"business_unit": {
"type": "string",
"description": "The business unit. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/businessunitcode/entries"
},
"amount": {
"type": "number",
"description": "The amount."
},
"base_currency_id": {
"type": "string",
"description": "The base currency."
}
},
"description": "NewRevenueBatchRowApplicationbusinessunitsBusinessUnits",
"x-display-name": "business_units",
"x-display-id": "business_units"
},
"NewRevenueBatchRowApplicationrecognitionsRecognitions": {
"required": [
"constituent_id",
"effective_date",
"amount"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"revenue_recognition_type": {
"type": "string",
"description": "The recognition credit type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuerecognitiontypecode/entries"
},
"constituent_id": {
"type": "string",
"description": "The constituent."
},
"effective_date": {
"type": "string",
"description": "The effective date.",
"format": "date"
},
"amount": {
"type": "number",
"description": "The amount."
},
"base_currency_id": {
"type": "string",
"description": "The base currency."
}
},
"description": "NewRevenueBatchRowApplicationrecognitionsRecognitions",
"x-display-name": "recognitions",
"x-display-id": "recognitions"
},
"NewRevenueBatchRowApplicationsolicitorsSolicitors": {
"required": [
"constituent_id",
"amount"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"constituent_id": {
"type": "string",
"description": "The solicitor."
},
"amount": {
"type": "number",
"description": "The amount."
},
"base_currency_id": {
"type": "string",
"description": "The base currency."
}
},
"description": "NewRevenueBatchRowApplicationsolicitorsSolicitors",
"x-display-name": "solicitors",
"x-display-id": "solicitors"
},
"NewRevenueBatchRowBenefits": {
"required": [
"benefit_id",
"quantity",
"unit_value"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"benefit_id": {
"type": "string",
"description": "The benefit."
},
"quantity": {
"type": "integer",
"description": "The quantity."
},
"unit_value": {
"type": "number",
"description": "The unit value."
},
"total_value": {
"type": "number",
"description": "The total value."
},
"details": {
"type": "string",
"description": "The details."
},
"sequence": {
"type": "integer",
"description": "The sequence."
},
"transaction_total_value": {
"type": "number",
"description": "The transaction total value."
},
"benefit_currency_id": {
"type": "string",
"description": "The benefit currency."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency."
},
"base_currency_id": {
"type": "string",
"description": "The base currency."
}
},
"description": "NewRevenueBatchRowBenefits",
"x-display-name": "benefits",
"x-display-id": "benefits"
},
"NewRevenueBatchRowInstallments": {
"required": [
"date",
"amount",
"receipt_amount"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"date": {
"type": "string",
"description": "The date.",
"format": "date"
},
"amount": {
"type": "number",
"description": "The amount."
},
"applied": {
"type": "number",
"description": "The applied amount."
},
"receipt_amount": {
"type": "number",
"description": "The receipt amount."
},
"sequence": {
"type": "integer",
"description": "The sequence."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency."
},
"installment_splits": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowInstallmentsInstallmentSplits"
},
"description": "Installment splits."
}
},
"description": "NewRevenueBatchRowInstallments",
"x-display-name": "installments",
"x-display-id": "installments"
},
"NewRevenueBatchRowInstallmentsInstallmentSplits": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"installment_split_id": {
"type": "string",
"description": "The installment split ID."
},
"designation": {
"type": "string",
"description": "The designation. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/1a3946b9-a8a2-4732-acad-9eb9ed72f82e?parameters=revenueid,{parent.currentrecordid}."
},
"amount": {
"type": "number",
"description": "The amount."
},
"applied": {
"type": "number",
"description": "The applied amount."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency ID."
},
"revenue_split_id": {
"type": "string",
"description": "The revenue split ID."
},
"payment_count": {
"type": "integer",
"description": "The number of payments applied to this split."
},
"write_off_count": {
"type": "integer",
"description": "The number of write-offs applied to this split."
}
},
"description": "NewRevenueBatchRowInstallmentsInstallmentSplits",
"x-display-name": "installment_splits",
"x-display-id": "installment_splits"
},
"NewRevenueBatchRowMatchingGifts": {
"required": [
"organization_id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"matching_constituent_id": {
"type": "string",
"description": "The matching constituent."
},
"organization_id": {
"type": "string",
"description": "The matching organization."
},
"relationship": {
"type": "string",
"description": "The relationship. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/a1abe614-e21e-4b4c-9b8c-7156137a9c06?parameters=relationshipconstituentid,{matching_constituent_id}¶meters=reciprocalconstituentid,{organization_id}."
},
"relationship_context_id": {
"type": "string",
"description": "The relationship context ID."
},
"matching_gift_condition": {
"type": "string",
"description": "The mg condition type. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/e229a06b-4ca1-4d12-b91a-8a202573c4d3?parameters=constituent_id,{organization_id}¶meters=currencyid,{original_gift_transaction_currency_id}."
},
"amount": {
"type": "number",
"description": "The amount."
},
"date": {
"type": "string",
"description": "The date.",
"format": "date"
},
"single_designation_id": {
"type": "string",
"description": "The designation."
},
"splits": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowMatchinggiftsSplits"
},
"description": "Splits."
},
"could_not_default_matching_gift": {
"type": "boolean",
"description": "Indicates whether it could not be generated."
},
"base_currency_id": {
"type": "string",
"description": "The base currency."
},
"transaction_currency": {
"type": "string",
"description": "The transaction currency. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/40bf0d4a-5e78-46f4-ab50-56d508e35516?parameters=pdaccountsystemid,{pdaccountsystemid}."
},
"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/c254b16d-ba67-4431-9f7e-ab7f75f4f246?parameters=fromcurrencyid,{transactioncurrencyid}¶meters=tocurrencyid,{base_currency_id}¶meters=typecode,{1}¶meters=asofdate,{date}¶meters=includespotrate,{1}."
},
"exchange_rate": {
"type": "number",
"description": "The exchange rate."
},
"original_gift_transaction_currency_id": {
"type": "string",
"description": "The original gift transaction currency."
},
"pd_account_system_id": {
"type": "string",
"description": "The account system."
},
"apply_by_percent": {
"type": "boolean",
"description": "Indicates whether to apply by percent."
}
},
"description": "NewRevenueBatchRowMatchingGifts",
"x-display-name": "matching_gifts",
"x-display-id": "matching_gifts"
},
"NewRevenueBatchRowMatchinggiftsSplits": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"designation_id": {
"type": "string",
"description": "The designation."
},
"amount": {
"type": "number",
"description": "The amount."
},
"sequence": {
"type": "integer",
"description": "The sequence."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency."
}
},
"description": "NewRevenueBatchRowMatchinggiftsSplits",
"x-display-name": "splits",
"x-display-id": "splits"
},
"NewRevenueBatchRowNewConstituent": {
"required": [
"last_name"
],
"type": "object",
"properties": {
"organization": {
"type": "boolean",
"description": "Indicates whether the constituent is an organization."
},
"group": {
"type": "boolean",
"description": "Indicates whether the constituent is a group."
},
"household": {
"type": "boolean",
"description": "Indicates whether the constituent is a household."
},
"last_name": {
"type": "string",
"description": "The last\\org\\group\\household name."
},
"first_name": {
"type": "string",
"description": "The first name."
},
"middle_name": {
"type": "string",
"description": "The middle name."
},
"title": {
"type": "string",
"description": "The title. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries"
},
"suffix": {
"type": "string",
"description": "The suffix. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries"
},
"nick_name": {
"type": "string",
"description": "The nickname."
},
"maiden_name": {
"type": "string",
"description": "The maiden name."
},
"birth_date": {
"$ref": "#/$defs/FuzzyDate"
},
"gender": {
"type": "string",
"description": "The gender. Available values are unknown, male, female, other"
},
"marital_status": {
"type": "string",
"description": "The marital status. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/maritalstatuscode/entries"
},
"web_address": {
"type": "string",
"description": "The website."
},
"industry": {
"type": "string",
"description": "The industry. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/industrycode/entries"
},
"num_employees": {
"type": "integer",
"description": "The number of employees."
},
"num_subsidiaries": {
"type": "integer",
"description": "The number of subsidiary organizations."
},
"parent_corp_id": {
"type": "string",
"description": "The parent organization."
},
"address_address_type": {
"type": "string",
"description": "The address type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries"
},
"address_country": {
"type": "string",
"description": "The country. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/c9649672-353d-42e8-8c25-4d34bbabfbba."
},
"address_address_block": {
"type": "string",
"description": "The address."
},
"address_city": {
"type": "string",
"description": "The city."
},
"address_state": {
"type": "string",
"description": "The state. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=countryid,{address_countryid}."
},
"address_post_code": {
"type": "string",
"description": "The zip."
},
"address_do_not_mail": {
"type": "boolean",
"description": "Indicates whether to suppress mail to this address."
},
"address_do_not_mail_reason": {
"type": "string",
"description": "The reason. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/donotmailreasoncode/entries"
},
"phone_type": {
"type": "string",
"description": "The phone type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/phonetypecode/entries"
},
"phone_number": {
"type": "string",
"description": "The phone number."
},
"email_address_type": {
"type": "string",
"description": "The email type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/emailaddresstypecode/entries"
},
"email_address": {
"type": "string",
"description": "The email address."
},
"existing_spouse": {
"type": "boolean",
"description": "The existing constituent."
},
"spouse_id": {
"type": "string",
"description": "The spouse full name."
},
"spouse_last_name": {
"type": "string",
"description": "The spouse last name."
},
"spouse_first_name": {
"type": "string",
"description": "The spouse first name."
},
"spouse_middle_name": {
"type": "string",
"description": "The spouse middle name."
},
"spouse_title": {
"type": "string",
"description": "The spouse title. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries"
},
"spouse_suffix": {
"type": "string",
"description": "The spouse suffix. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries"
},
"spouse_nick_name": {
"type": "string",
"description": "The spouse nickname."
},
"spouse_maiden_name": {
"type": "string",
"description": "The spouse maiden name."
},
"spouse_birth_date": {
"$ref": "#/$defs/FuzzyDate"
},
"spouse_gender": {
"type": "string",
"description": "The spouse gender. Available values are unknown, male, female, other"
},
"spouse_relationship_type": {
"type": "string",
"description": "The spouse relationship type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/relationshiptypecode/entries"
},
"spouse_reciprocal_type": {
"type": "string",
"description": "The spouse reciprocal relationship type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/relationshiptypecode/entries"
},
"spouse_start_date": {
"type": "string",
"description": "The spouse start date.",
"format": "date"
},
"spouse_is_spouse": {
"type": "boolean",
"description": "Indicates whether the constituent is a spouse."
},
"spouse_class_of": {
"type": "integer",
"description": "The spouse class of."
},
"copy_primary_information": {
"type": "boolean",
"description": "Indicates whether to copy the primary contact information."
},
"primary_relationship_exists": {
"type": "boolean",
"description": "Indicates whether to apply recognition credit to the individual for the constituent's payments."
},
"primary_match_factor": {
"type": "number",
"description": "The primary recognition credit factor."
},
"reciprocal_relationship_exists": {
"type": "boolean",
"description": "Indicates whether to apply recognition credit to the constituent for the individual's payments."
},
"reciprocal_match_factor": {
"type": "number",
"description": "The reciprocal recognition credit factor."
},
"existing_business": {
"type": "string",
"description": "Indicates whether the business is an existing constituent."
},
"business_id": {
"type": "string",
"description": "The organization name."
},
"business_name": {
"type": "string",
"description": "The business organization name."
},
"business_address_type": {
"type": "string",
"description": "The business address type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries"
},
"business_country": {
"type": "string",
"description": "The business country. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/c9649672-353d-42e8-8c25-4d34bbabfbba."
},
"business_address_block": {
"type": "string",
"description": "The business address."
},
"business_city": {
"type": "string",
"description": "The business city."
},
"business_state": {
"type": "string",
"description": "The business state. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=countryid,{address_countryid}."
},
"business_post_code": {
"type": "string",
"description": "The business zip."
},
"business_do_not_mail": {
"type": "boolean",
"description": "Indicates whether to suppress mail to this business address."
},
"business_phone_type": {
"type": "string",
"description": "The business phone type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/phonetypecode/entries"
},
"business_number": {
"type": "string",
"description": "The business phone number."
},
"business_relationship_type": {
"type": "string",
"description": "The business relationship type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/relationshiptypecode/entries"
},
"business_reciprocal_type": {
"type": "string",
"description": "The business reciprocal relationship type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/relationshiptypecode/entries"
},
"business_start_date": {
"type": "string",
"description": "The business start date.",
"format": "date"
},
"contact": {
"type": "boolean",
"description": "Indicates whether the constituent is a contact."
},
"contact_type": {
"type": "string",
"description": "The contact type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/contacttypecode/entries"
},
"primary_contact": {
"type": "boolean",
"description": "The primary contact."
},
"position": {
"type": "string",
"description": "The position."
},
"matching_gift_relationship": {
"type": "boolean",
"description": "Indicates whether this organization will match the individual's contributions."
},
"gives_anonymously": {
"type": "boolean",
"description": "Indicates whether the constituent gives anonymously."
},
"group_description": {
"type": "string",
"description": "The group\\household description."
},
"group_primary_contact": {
"type": "string",
"description": "The group primary contact."
},
"group_start_date": {
"type": "string",
"description": "The group start date.",
"format": "date"
},
"group_group_type": {
"type": "string",
"description": "The group type. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/927b11bc-3f88-44b0-a8fb-cfc1d5c627ea."
},
"household_primary_contact_id": {
"type": "string",
"description": "The existing household primary contact."
},
"household_primary_contact_key_name": {
"type": "string",
"description": "The new household primary contact last name."
},
"household_primary_contact_first_name": {
"type": "string",
"description": "The new household primary contact first name."
},
"household_primary_contact_middle_name": {
"type": "string",
"description": "The new household primary contact middle initial."
},
"household_primary_contact_title": {
"type": "string",
"description": "The new household primary contact title. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries"
},
"household_primary_contact_suffix": {
"type": "string",
"description": "The new household primary contact suffix. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries"
},
"household_primary_contact_copy_household_contact": {
"type": "boolean",
"description": "Indicates whether the new household primary contact copies the household contact information."
},
"household_second_member_id": {
"type": "string",
"description": "The existing second household member."
},
"household_second_member_key_name": {
"type": "string",
"description": "The new second household member last name."
},
"household_second_member_first_name": {
"type": "string",
"description": "The new second household member first name."
},
"household_second_member_middle_name": {
"type": "string",
"description": "The new second household member middle initial."
},
"household_second_member_title": {
"type": "string",
"description": "The new second household member title. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries"
},
"household_second_member_suffix": {
"type": "string",
"description": "The new second household member suffix. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries"
},
"household_second_member_copy_household_contact": {
"type": "boolean",
"description": "Indicates whether the new second household member copies the household contact information."
},
"household_second_member_relationship_reciprocal_type": {
"type": "string",
"description": "The household members reciprocal relationship type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/relationshiptypecode/entries"
},
"household_second_member_relationship_relationship_type": {
"type": "string",
"description": "The household members relationship type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/relationshiptypecode/entries"
},
"household_second_member_relationship_start_date": {
"type": "string",
"description": "The household members relationship start date.",
"format": "date"
},
"household_second_member_relationship_is_spouse": {
"type": "boolean",
"description": "Indicates whether the household members' relationship is spousal."
},
"spouse_relationship_type_code_id_simple_list": {
"type": "string",
"description": "The spouse relationship type. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/4e869c5a-9b9d-4e84-b6e0-1fc66bafbafc?parameters=gender,{gender_code}¶meters=appliestoconstituenttype,{0}."
},
"spouse_reciprocal_type_code_id_simple_list": {
"type": "string",
"description": "The spouse reciprocal relationship type. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/c3018803-2ea5-4f62-91cf-412e88d15f9b?parameters=appliestoconstituenttype,{0}¶meters=constituent_id,{spouse_id}¶meters=appliestorelationshiptypeid,{spouse_relationshiptypecodeid}¶meters=gender,{spouse_gender_code}¶meters=relatestoconstituenttype,{0}."
},
"business_relationship_type_code_id_simple_list": {
"type": "string",
"description": "The business relationship type. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/4e869c5a-9b9d-4e84-b6e0-1fc66bafbafc?parameters=gender,{gender_code}¶meters=appliestoconstituenttype,{0}."
},
"business_reciprocal_type_code_id_simple_list": {
"type": "string",
"description": "The business reciprocal relationship type. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/c3018803-2ea5-4f62-91cf-412e88d15f9b?parameters=appliestoconstituenttype,{0}¶meters=constituent_id,{business_id}¶meters=appliestorelationshiptypeid,{business_relationshiptypecodeid}¶meters=relatestoconstituenttype,{1}."
},
"household_second_member_relationship_reciprocal_type_code_id_simple_list": {
"type": "string",
"description": "The household members reciprocal relationship type. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/4e869c5a-9b9d-4e84-b6e0-1fc66bafbafc?parameters=gender,{gender_code}¶meters=appliestoconstituenttype,{0}."
},
"household_second_member_relationship_relationship_type_code_id_simple_list": {
"type": "string",
"description": "The household members relationship type. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/c3018803-2ea5-4f62-91cf-412e88d15f9b?parameters=appliestoconstituenttype,{0}¶meters=constituent_id,{household_second_member_id}¶meters=appliestorelationshiptypeid,{household_second_member_relationship_relationship_type_code_id_simple_list}¶meters=relatestoconstituenttype,{0}."
},
"business_primary_relationship_exists": {
"type": "string",
"description": "Indicates whether to apply to the individual for revenue from the organization."
},
"business_primary_match_factor": {
"type": "integer",
"description": "The recognition credit match percent."
},
"business_reciprocal_relationship_exists": {
"type": "string",
"description": "Indicates whether to apply to the organization for revenue from the individual."
},
"business_reciprocal_match_factor": {
"type": "integer",
"description": "The recognition credit match percent."
},
"business_primary_recognition_type": {
"type": "string",
"description": "The recognition credit type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuerecognitiontypecode/entries"
},
"business_reciprocal_recognition_type": {
"type": "string",
"description": "The recognition credit type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuerecognitiontypecode/entries"
},
"address_id": {
"type": "string",
"description": "The address ID."
},
"email_address_id": {
"type": "string",
"description": "The email ID."
},
"phone_id": {
"type": "string",
"description": "The phone ID."
},
"constituency_code": {
"type": "string",
"description": "The constituency. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/836499cc-5dc1-4731-9e82-c66fbe64cc69."
},
"site_id": {
"type": "string",
"description": "The constituent site."
},
"constituent_security_group": {
"type": "string",
"description": "The constituent security group. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/060cd243-2e24-4159-b327-7bb4dd7a8c3b."
},
"info_source_code_id": {
"type": "string",
"description": "The information source code ID."
},
"name_formats": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowNewconstituentNameFormats"
},
"description": "Name formats."
},
"original_first_name": {
"type": "string",
"description": "The original first name."
},
"original_last_name": {
"type": "string",
"description": "The original last name."
}
},
"description": "NewRevenueBatchRowNewConstituent",
"x-display-name": "new_constituent",
"x-display-id": "new_constituent"
},
"NewRevenueBatchRowNewconstituentNameFormats": {
"type": "object",
"properties": {
"name_format_type": {
"type": "string",
"description": "The name format type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/nameformattypecode/entries"
},
"custom_name": {
"type": "string",
"description": "The custom name."
}
},
"description": "NewRevenueBatchRowNewconstituentNameFormats",
"x-display-name": "name_formats",
"x-display-id": "name_formats"
},
"NewRevenueBatchRowPercentageBenefits": {
"required": [
"benefit_id",
"percent_applicable_amount",
"value_percent"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"benefit_id": {
"type": "string",
"description": "The benefit."
},
"percent_applicable_amount": {
"type": "number",
"description": "The amount."
},
"value_percent": {
"type": "number",
"description": "The percent value."
},
"total_value": {
"type": "number",
"description": "The total value."
},
"details": {
"type": "string",
"description": "The details."
},
"sequence": {
"type": "integer",
"description": "The sequence."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency."
},
"transaction_total_value": {
"type": "number",
"description": "The transaction total value."
},
"base_currency_id": {
"type": "string",
"description": "The base currency."
}
},
"description": "NewRevenueBatchRowPercentageBenefits",
"x-display-name": "percentage_benefits",
"x-display-id": "percentage_benefits"
},
"NewRevenueBatchRowRecognitions": {
"required": [
"constituent_id",
"effective_date",
"amount"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"revenue_recognition_type": {
"type": "string",
"description": "The recognition credit type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuerecognitiontypecode/entries"
},
"constituent_id": {
"type": "string",
"description": "The constituent."
},
"effective_date": {
"type": "string",
"description": "The effective date.",
"format": "date"
},
"amount": {
"type": "number",
"description": "The amount."
},
"base_currency_id": {
"type": "string",
"description": "The base currency."
}
},
"description": "NewRevenueBatchRowRecognitions",
"x-display-name": "recognitions",
"x-display-id": "recognitions"
},
"NewRevenueBatchRowRevenueStreams": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"application_id": {
"type": "string",
"description": "The application ID."
},
"constituent_id": {
"type": "string",
"description": "The constituent ID."
},
"constituent_name": {
"type": "string",
"description": "The constituent name."
},
"applied": {
"type": "number",
"description": "The applied amount."
},
"applied_percent": {
"type": "number",
"description": "The applied percent."
},
"balance": {
"type": "number",
"description": "The balance."
},
"amount_due": {
"type": "number",
"description": "The amount due."
},
"date_due": {
"type": "string",
"description": "The date due.",
"format": "date"
},
"type": {
"type": "string",
"description": "The typecode. Available values are gift, pledge, recurring gift, planned gift, matching gift claim, membership, event registration fee, grant award, donor challenge claim, opportunity"
},
"receipt_amount": {
"type": "number",
"description": "The receipt amount."
},
"do_not_receipt": {
"type": "boolean",
"description": "Indicates whether to suppress the receipt."
},
"description": {
"type": "string",
"description": "The description."
},
"was_generated": {
"type": "boolean",
"description": "Indicates whether it was generated."
},
"pledges": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowRevenuestreamsPledges"
},
"description": "Pledges."
},
"memberships": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowRevenuestreamsMemberships"
},
"description": "Memberships."
},
"batch_revenue_registrant_id": {
"type": "string",
"description": "The batch registrant ID."
},
"over_payment_application_type": {
"type": "string",
"description": "The overpayment to. Available values are pledge balance, next installment"
},
"designation_list": {
"type": "string",
"description": "The designations."
},
"application_commitment_id": {
"type": "string",
"description": "Used to look up revenue, event registrations, or memberships by lookup ID."
},
"sponsorship_opportunity": {
"type": "string",
"description": "The sponsorship opportunity."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency."
},
"application_currency_id": {
"type": "string",
"description": "The application currency."
},
"application_exchange_rate_id": {
"type": "string",
"description": "The application exchange rate."
},
"application_applied_amount": {
"type": "number",
"description": "The application applied amount."
},
"pd_account_system_id": {
"type": "string",
"description": "The PD account system."
},
"sponsorship_rg_additional_gift": {
"type": "boolean",
"description": "The sponsorship recurring-gift additional gift."
},
"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."
},
"membership_program_name": {
"type": "string",
"description": "The membership program name."
},
"membership_level_name": {
"type": "string",
"description": "The membership level name."
},
"sort_order": {
"type": "integer",
"description": "The sort order."
}
},
"description": "NewRevenueBatchRowRevenueStreams",
"x-display-name": "revenue_streams",
"x-display-id": "revenue_streams"
},
"NewRevenueBatchRowRevenuestreamsMemberships": {
"required": [
"membership_program",
"membership_level",
"membership_level_term"
],
"type": "object",
"properties": {
"membership_program": {
"type": "string",
"description": "The program. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/eb44b0ac-c3b3-4f3f-986e-e5ac8887509a."
},
"membership_level": {
"type": "string",
"description": "The level. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/6ef82fa0-f3d8-4f2b-b47d-872c57dd61d9?parameters=membershipprogramid,{membershipprogramid}."
},
"membership_level_term": {
"type": "string",
"description": "The term. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/0e2e7741-0069-4558-b14c-d2f81aaa41bc?parameters=membershiplevelid,{membershiplevelid}."
},
"membership_type_code": {
"type": "string",
"description": "The type. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/135ac6e3-fd74-4cbe-9529-a2ce43e921f3?parameters=membershiplevelid,{membershiplevelid}."
},
"number_of_children": {
"type": "integer",
"description": "The number of children."
},
"comments": {
"type": "string",
"description": "The comments."
},
"gift": {
"type": "boolean",
"description": "Indicates whether this membership is a gift."
},
"send_renewal": {
"type": "string",
"description": "The send renewal notice to. Available values are giver, primary member, giver and primary member"
},
"expiration_date": {
"type": "string",
"description": "The expiration date.",
"format": "date"
},
"given_by_id": {
"type": "string",
"description": "The constituent who gave this."
},
"amount": {
"type": "number",
"description": "The amount."
},
"members": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowRevenuestreamsMembershipsMembers"
},
"description": "Members."
}
},
"description": "NewRevenueBatchRowRevenuestreamsMemberships",
"x-display-name": "memberships",
"x-display-id": "memberships"
},
"NewRevenueBatchRowRevenuestreamsMembershipsMembers": {
"required": [
"constituent_id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"constituent_id": {
"type": "string",
"description": "The name."
},
"primary": {
"type": "boolean",
"description": "The primary."
},
"membership_cards": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowRevenuestreamsMembershipsMembersMembershipCards"
},
"description": "Membership cards."
}
},
"description": "NewRevenueBatchRowRevenuestreamsMembershipsMembers",
"x-display-name": "members",
"x-display-id": "members"
},
"NewRevenueBatchRowRevenuestreamsMembershipsMembersMembershipCards": {
"required": [
"name_on_card"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"name_on_card": {
"type": "string",
"description": "The name on the card."
},
"expiration_date": {
"type": "string",
"description": "The expiration date.",
"format": "date"
}
},
"description": "NewRevenueBatchRowRevenuestreamsMembershipsMembersMembershipCards",
"x-display-name": "membership_cards",
"x-display-id": "membership_cards"
},
"NewRevenueBatchRowRevenuestreamsPledges": {
"required": [
"constituent_id",
"date",
"amount",
"post_status",
"frequency",
"number_of_installments",
"start_date",
"installment_amount",
"splits",
"installments"
],
"type": "object",
"properties": {
"sequence": {
"type": "integer",
"description": "The sequence."
},
"constituent_id": {
"type": "string",
"description": "The constituent."
},
"date": {
"type": "string",
"description": "The date.",
"format": "date"
},
"amount": {
"type": "number",
"description": "The amount."
},
"post_date": {
"type": "string",
"description": "The post date.",
"format": "date"
},
"post_status": {
"type": "string",
"description": "The post status. Available values are not posted, do not post"
},
"send_pledge_reminder": {
"type": "boolean",
"description": "Indicates whether to send pledge reminders."
},
"frequency": {
"type": "string",
"description": "The frequency. Available values are annually, semi-annually, quarterly, monthly, irregular, single installment, semi-monthly, biweekly"
},
"number_of_installments": {
"type": "integer",
"description": "The number of installments."
},
"start_date": {
"type": "string",
"description": "The start date.",
"format": "date"
},
"installment_amount": {
"type": "number",
"description": "The installment amount."
},
"splits": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowRevenuestreamsPledgesSplits"
},
"description": "Splits."
},
"installments": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowRevenuestreamsPledgesInstallments"
},
"description": "Installments."
},
"finder_number": {
"type": "integer",
"description": "The finder number."
},
"source_code": {
"type": "string",
"description": "The source code."
},
"appeal_id": {
"type": "string",
"description": "The appeal."
},
"benefits": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowRevenuestreamsPledgesBenefits"
},
"description": "Benefits."
},
"benefits_waived": {
"type": "boolean",
"description": "Indicates whether the benefits for the pledge were waived by the user."
},
"given_anonymously": {
"type": "string",
"description": "Indicates whether the pledge was given anonymously."
},
"mailing_id": {
"type": "string",
"description": "The marketing effort for the pledge."
},
"channel": {
"type": "string",
"description": "The channel for the pledge. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/channelcode/entries"
},
"do_not_acknowledge": {
"type": "boolean",
"description": "Indicates whether the pledge should not be acknowledged."
},
"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."
},
"single_designation_id": {
"type": "string",
"description": "The designation."
},
"reference": {
"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."
},
"opportunity_id": {
"type": "string",
"description": "The opportunity."
},
"opportunity_constituent_name": {
"type": "string",
"description": "The opportunity constituent name."
},
"opportunity_ask_date": {
"type": "string",
"description": "The opportunity ask date.",
"format": "date"
},
"opportunity_ask_amount": {
"type": "number",
"description": "The opportunity ask amount."
},
"opportunity_status": {
"type": "string",
"description": "The opportunity status."
},
"percentage_benefits": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowRevenuestreamsPledgesPercentageBenefits"
},
"description": "Percentage benefits."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency."
},
"base_currency_id": {
"type": "string",
"description": "The base currency."
},
"base_exchange_rate": {
"type": "string",
"description": "The exchange rate. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/c254b16d-ba67-4431-9f7e-ab7f75f4f246?parameters=fromcurrencyid,{transactioncurrencyid}¶meters=tocurrencyid,{base_currency_id}¶meters=typecode,{1}¶meters=asofdate,{date}¶meters=includespotrate,{1}."
},
"exchange_rate": {
"type": "number",
"description": "The exchange rate."
},
"do_not_post": {
"type": "boolean",
"description": "Indicates whether to suppress posting."
}
},
"description": "NewRevenueBatchRowRevenuestreamsPledges",
"x-display-name": "pledges",
"x-display-id": "pledges"
},
"NewRevenueBatchRowRevenuestreamsPledgesBenefits": {
"required": [
"benefit_id",
"quantity",
"unit_value"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"benefit_id": {
"type": "string",
"description": "The benefit."
},
"quantity": {
"type": "integer",
"description": "The quantity."
},
"unit_value": {
"type": "number",
"description": "The unit value."
},
"total_value": {
"type": "number",
"description": "The total value."
},
"details": {
"type": "string",
"description": "The details."
},
"sequence": {
"type": "integer",
"description": "The sequence."
},
"transaction_total_value": {
"type": "number",
"description": "The transaction total value."
},
"benefit_currency_id": {
"type": "string",
"description": "The benefit currency."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency."
},
"base_currency_id": {
"type": "string",
"description": "The base currency."
}
},
"description": "NewRevenueBatchRowRevenuestreamsPledgesBenefits",
"x-display-name": "benefits",
"x-display-id": "benefits"
},
"NewRevenueBatchRowRevenuestreamsPledgesInstallments": {
"required": [
"date",
"amount",
"receipt_amount"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"date": {
"type": "string",
"description": "The date.",
"format": "date"
},
"amount": {
"type": "number",
"description": "The amount."
},
"receipt_amount": {
"type": "number",
"description": "The receipt amount."
},
"sequence": {
"type": "integer",
"description": "The sequence."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency."
},
"installment_splits": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowRevenuestreamsPledgesInstallmentsInstallmentSplits"
},
"description": "Installment splits."
}
},
"description": "NewRevenueBatchRowRevenuestreamsPledgesInstallments",
"x-display-name": "installments",
"x-display-id": "installments"
},
"NewRevenueBatchRowRevenuestreamsPledgesInstallmentsInstallmentSplits": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"installment_split_id": {
"type": "string",
"description": "The installment split ID."
},
"designation": {
"type": "string",
"description": "The designation. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/1a3946b9-a8a2-4732-acad-9eb9ed72f82e?parameters=revenueid,{parent.currentrecordid}."
},
"amount": {
"type": "number",
"description": "The amount."
},
"applied": {
"type": "number",
"description": "The applied amount."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency ID."
}
},
"description": "NewRevenueBatchRowRevenuestreamsPledgesInstallmentsInstallmentSplits",
"x-display-name": "installment_splits",
"x-display-id": "installment_splits"
},
"NewRevenueBatchRowRevenuestreamsPledgesPercentageBenefits": {
"required": [
"benefit_id",
"percent_applicable_amount",
"value_percent"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"benefit_id": {
"type": "string",
"description": "The benefit."
},
"percent_applicable_amount": {
"type": "number",
"description": "The amount."
},
"value_percent": {
"type": "number",
"description": "The percent value."
},
"total_value": {
"type": "number",
"description": "The total value."
},
"details": {
"type": "string",
"description": "The details."
},
"sequence": {
"type": "integer",
"description": "The sequence."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency."
},
"transaction_total_value": {
"type": "number",
"description": "The transaction total value."
},
"base_currency_id": {
"type": "string",
"description": "The base currency."
}
},
"description": "NewRevenueBatchRowRevenuestreamsPledgesPercentageBenefits",
"x-display-name": "percentage_benefits",
"x-display-id": "percentage_benefits"
},
"NewRevenueBatchRowRevenuestreamsPledgesSplits": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"designation_id": {
"type": "string",
"description": "The designation."
},
"amount": {
"type": "number",
"description": "The amount."
},
"application_code": {
"type": "integer",
"description": "The application code."
},
"type_code": {
"type": "integer",
"description": "The type code."
},
"declines_gift_aid": {
"type": "boolean",
"description": "Indicates whether gift aid is declined."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency."
},
"sponsorship_id": {
"type": "string",
"description": "The sponsorship ID."
}
},
"description": "NewRevenueBatchRowRevenuestreamsPledgesSplits",
"x-display-name": "splits",
"x-display-id": "splits"
},
"NewRevenueBatchRowSolicitors": {
"required": [
"constituent_id",
"amount"
],
"type": "object",
"properties": {
"constituent_id": {
"type": "string",
"description": "The solicitor."
},
"amount": {
"type": "number",
"description": "The amount."
},
"sequence": {
"type": "integer",
"description": "The sequence."
},
"base_currency_id": {
"type": "string",
"description": "The transaction currency."
}
},
"description": "NewRevenueBatchRowSolicitors",
"x-display-name": "solicitors",
"x-display-id": "solicitors"
},
"NewRevenueBatchRowSplits": {
"type": "object",
"properties": {
"revenue_split_id": {
"type": "string",
"description": "The revenue split ID."
},
"id": {
"type": "string",
"description": "The ID."
},
"designation_id": {
"type": "string",
"description": "The designation."
},
"amount": {
"type": "number",
"description": "The amount."
},
"sequence": {
"type": "integer",
"description": "The sequence."
},
"application_code": {
"type": "integer",
"description": "The application code."
},
"type_code": {
"type": "integer",
"description": "The type code."
},
"did_campaigns_default": {
"type": "boolean",
"description": "Indicates whether campaigns were defaulted."
},
"campaigns": {
"type": "array",
"items": {
"$ref": "#/$defs/NewRevenueBatchRowSplitsCampaigns"
},
"description": "Campaigns."
},
"declines_gift_aid": {
"type": "boolean",
"description": "Indicates whether gift aid is declined."
},
"gift_aid_sponsorship": {
"type": "boolean",
"description": "The gift aid sponsorship."
},
"opportunity_id": {
"type": "string",
"description": "The opportunity."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency."
}
},
"description": "NewRevenueBatchRowSplits",
"x-display-name": "splits",
"x-display-id": "splits"
},
"NewRevenueBatchRowSplitsCampaigns": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"campaign_id": {
"type": "string",
"description": "The campaign."
},
"campaign_sub_priority": {
"type": "string",
"description": "The campaign subpriority. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/e3e9e22a-85f2-4a77-ba74-25b391252dab?parameters=campaign_id,{campaign_id}."
}
},
"description": "NewRevenueBatchRowSplitsCampaigns",
"x-display-name": "campaigns",
"x-display-id": "campaigns"
},
"NewRevenueBatchRowTaxDeclarations": {
"required": [
"charity_claim_reference_number",
"declaration_starts",
"declaration_indicator",
"pays_tax"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"charity_claim_reference_number": {
"type": "string",
"description": "The reference number. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/9a4fcffc-0366-4971-882e-0c4f7836466a."
},
"declaration_made": {
"type": "string",
"description": "The date the declaration was made.",
"format": "date"
},
"declaration_starts": {
"type": "string",
"description": "The start date.",
"format": "date"
},
"declaration_ends": {
"type": "string",
"description": "The end date.",
"format": "date"
},
"declaration_indicator": {
"type": "string",
"description": "The indicator. Available values are written, oral, internet"
},
"declaration_source": {
"type": "string",
"description": "The source. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/declarationsourcecode/entries"
},
"pays_tax": {
"type": "string",
"description": "The pays tax. Available values are no, yes, unknown"
}
},
"description": "NewRevenueBatchRowTaxDeclarations",
"x-display-name": "tax_declarations",
"x-display-id": "tax_declarations"
},
"NewRevenueBatchRowTributes": {
"required": [
"tribute_id",
"amount"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"tribute_id": {
"type": "string",
"description": "The tribute."
},
"amount": {
"type": "number",
"description": "The amount."
},
"designation_id": {
"type": "string",
"description": "The default designation."
},
"sequence": {
"type": "integer",
"description": "The sequence."
},
"base_currency_id": {
"type": "string",
"description": "The base currency."
}
},
"description": "NewRevenueBatchRowTributes",
"x-display-name": "tributes",
"x-display-id": "tributes"
},
"NewRevenueBatchRowUnappliedMatchingGiftSplits": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID."
},
"designation_id": {
"type": "string",
"description": "The designation."
},
"amount": {
"type": "number",
"description": "The amount."
},
"sequence": {
"type": "integer",
"description": "The sequence."
},
"transaction_currency_id": {
"type": "string",
"description": "The transaction currency."
}
},
"description": "NewRevenueBatchRowUnappliedMatchingGiftSplits",
"x-display-name": "unapplied_matching_gift_splits",
"x-display-id": "unapplied_matching_gift_splits"
}
}
}