USP_DATAFORMTEMPLATE_ADD_OPPORTUNITYPAYMENT

Stored procedure used to save an opportunity payment.
Parameters

Parameter	Parameter Type	Mode
@APPLICATIONID	uniqueidentifier	IN
@ID	uniqueidentifier	INOUT
@CHANGEAGENTID	uniqueidentifier	IN
@CONSTITUENTID	uniqueidentifier	IN
@DATE	datetime	IN
@AMOUNT	money	IN
@PAYMENTMETHODCODE	tinyint	IN
@CHECKDATE	UDT_FUZZYDATE	IN
@CHECKNUMBER	nvarchar(20)	IN
@REFERENCEDATE	UDT_FUZZYDATE	IN
@REFERENCENUMBER	nvarchar(20)	IN
@CARDHOLDERNAME	nvarchar(255)	IN
@CREDITCARDNUMBER	nvarchar(4)	IN
@CREDITTYPECODEID	uniqueidentifier	IN
@AUTHORIZATIONCODE	nvarchar(20)	IN
@EXPIRESON	UDT_FUZZYDATE	IN
@ISSUER	nvarchar(100)	IN
@NUMBEROFUNITS	decimal(20, 3)	IN
@SYMBOL	nvarchar(25)	IN
@MEDIANPRICE	decimal(19, 4)	IN
@GIFTINKINDSUBTYPECODEID	uniqueidentifier	IN
@PROPERTYSUBTYPECODEID	uniqueidentifier	IN
@RECEIPTAMOUNT	money	IN
@CONSTITUENTACCOUNTID	uniqueidentifier	IN
@POSTSTATUSCODE	tinyint	IN
@POSTDATE	datetime	IN
@FINDERNUMBER	bigint	IN
@SOURCECODE	nvarchar(50)	IN
@APPEALID	uniqueidentifier	IN
@TRIBUTEID	uniqueidentifier	IN
@BENEFITS	xml	IN
@BENEFITSWAIVED	bit	IN
@GIVENANONYMOUSLY	bit	IN
@MAILINGID	uniqueidentifier	IN
@LETTERCODEID	uniqueidentifier	IN
@CHANNELCODEID	uniqueidentifier	IN
@DONOTACKNOWLEDGE	bit	IN
@DONOTRECEIPT	bit	IN
@OTHERPAYMENTMETHODCODEID	uniqueidentifier	IN
@REFERENCE	nvarchar(255)	IN
@LOWPRICE	decimal(19, 4)	IN
@HIGHPRICE	decimal(19, 4)	IN
@DIRECTDEBITRESULTCODE	nvarchar(10)	IN
@GIFTINKINDITEMNAME	nvarchar(100)	IN
@GIFTINKINDDISPOSITIONCODE	tinyint	IN
@GIFTINKINDNUMBEROFUNITS	int	IN
@GIFTINKINDFAIRMARKETVALUE	money	IN
@PERCENTAGEBENEFITS	xml	IN
@PDACCOUNTSYSTEMID	uniqueidentifier	IN
@TRANSACTIONCURRENCYID	uniqueidentifier	IN
@BASEEXCHANGERATEID	uniqueidentifier	IN
@EXCHANGERATE	decimal(20, 8)	IN
@CURRENTAPPUSERID	uniqueidentifier	IN
@SEPAMANDATEID	uniqueidentifier	IN
@TRANSACTIONID	uniqueidentifier	IN
@MERCHANTACCOUNTID	uniqueidentifier	IN
@VENDORID	nvarchar(50)	IN
Definition

Copy


            CREATE procedure dbo.USP_DATAFORMTEMPLATE_ADD_OPPORTUNITYPAYMENT
            (
                @APPLICATIONID uniqueidentifier,
                @ID uniqueidentifier = null output,
                @CHANGEAGENTID uniqueidentifier,
                @CONSTITUENTID uniqueidentifier,                    
                @DATE datetime,
                @AMOUNT money = 0,
                @PAYMENTMETHODCODE tinyint = 1,
                @CHECKDATE dbo.UDT_FUZZYDATE = '00000000',
                @CHECKNUMBER nvarchar(20) = '',
                @REFERENCEDATE dbo.UDT_FUZZYDATE = '00000000',
                @REFERENCENUMBER nvarchar(20) = '',
                @CARDHOLDERNAME nvarchar(255) = '',
                @CREDITCARDNUMBER nvarchar(4) = '',
                @CREDITTYPECODEID uniqueidentifier = null,
                @AUTHORIZATIONCODE nvarchar(20) = '',
                @EXPIRESON dbo.UDT_FUZZYDATE = '00000000',
                @ISSUER nvarchar(100) = '',
                @NUMBEROFUNITS decimal(20,3) = 0,
                @SYMBOL nvarchar(25) = '',
                @MEDIANPRICE decimal(19,4) = 0,
                @GIFTINKINDSUBTYPECODEID uniqueidentifier = null,
                @PROPERTYSUBTYPECODEID uniqueidentifier = null,
                @RECEIPTAMOUNT money = 0,
                @CONSTITUENTACCOUNTID uniqueidentifier = null,
                @POSTSTATUSCODE tinyint = 1,
                @POSTDATE datetime = null,
                @FINDERNUMBER bigint = null,
                @SOURCECODE nvarchar(50) = null,
                @APPEALID uniqueidentifier = null,
                @TRIBUTEID uniqueidentifier = null,
                @BENEFITS xml = null,
                @BENEFITSWAIVED bit = 0,
                @GIVENANONYMOUSLY bit = null,
                @MAILINGID uniqueidentifier = null,
                @LETTERCODEID uniqueidentifier = null,
                @CHANNELCODEID uniqueidentifier = null,
                @DONOTACKNOWLEDGE bit = 0,
                @DONOTRECEIPT bit = 0,
                @OTHERPAYMENTMETHODCODEID uniqueidentifier = null,
                @REFERENCE nvarchar(255) = null,
                @LOWPRICE decimal(19,4) = 0,
                @HIGHPRICE decimal(19,4) = 0,
                @DIRECTDEBITRESULTCODE nvarchar(10) = '',
                @GIFTINKINDITEMNAME nvarchar(100) = '',
                @GIFTINKINDDISPOSITIONCODE tinyint = 0,
                @GIFTINKINDNUMBEROFUNITS int = 0,
                @GIFTINKINDFAIRMARKETVALUE money = 0,
                @PERCENTAGEBENEFITS xml = null,
                @PDACCOUNTSYSTEMID uniqueidentifier = null,
                @TRANSACTIONCURRENCYID uniqueidentifier = null,
                @BASEEXCHANGERATEID uniqueidentifier = null,
                @EXCHANGERATE decimal(20,8) = null,
                @CURRENTAPPUSERID uniqueidentifier = null,
                @SEPAMANDATEID uniqueidentifier = null,
                @TRANSACTIONID uniqueidentifier = null,
                @MERCHANTACCOUNTID uniqueidentifier = null,
                @VENDORID nvarchar(50) = ''
            )
            as
            set nocount on;

            if @CHANGEAGENTID is null
                exec dbo.USP_CHANGEAGENT_GETORCREATECHANGEAGENT @CHANGEAGENTID output;

            declare @CURRENTDATE datetime;

            declare @APPLYDONATIONSENABLED bit;
            select top 1 @APPLYDONATIONSENABLED = APPLYTODONATIONS from dbo.SOLICITORCREDITRULES;

            --TODO WHAT DO WE DO WITH THIS NOW

            declare @UNAPPLIEDMATCHINGGIFTSPLITS xml

            if @ID is null
                set @ID = newid();

            set @CURRENTDATE = GetDate();

            begin try
                set @POSTDATE = @DATE;

                if @PDACCOUNTSYSTEMID is null
                    set @PDACCOUNTSYSTEMID = '4B121C2C-CCE6-440D-894C-EA0DEF80D50B';

                -- Check GL business rule for this account system and set to 'Do not post' if needed.

                if dbo.UFN_PDACCOUNTSYSTEM_ALLOWGLDISTRIBUTIONS(@PDACCOUNTSYSTEMID) = 0
                begin
                  set @POSTSTATUSCODE = 2        -- Do not post

                  set @POSTDATE = null
                end

                declare @PROSPECTPLANID uniqueidentifier;
                select
                    @PROSPECTPLANID = PROSPECTPLANID
                from
                    dbo.OPPORTUNITY
                where
                    ID = @APPLICATIONID

                --Multicurrency - Retrieve base currency from the account system's currency set.

                declare @CURRENCYSETID uniqueidentifier;
                select @CURRENCYSETID = CURRENCYSETID from dbo.PDACCOUNTSYSTEM where ID = @PDACCOUNTSYSTEMID;

                declare @BASECURRENCYID uniqueidentifier;
                declare @ORGANIZATIONCURRENCYID uniqueidentifier = dbo.UFN_CURRENCY_GETORGANIZATIONCURRENCY();
                declare @ORGANIZATIONEXCHANGERATEID uniqueidentifier;

                select 
                    @BASECURRENCYID = BASECURRENCYID
                from 
                    dbo.CURRENCYSET
                where 
                    ID = coalesce(@CURRENCYSETID,dbo.UFN_CURRENCYSET_GETAPPUSERDEFAULTCURRENCYSET());

                set @ORGANIZATIONEXCHANGERATEID = dbo.UFN_CURRENCYEXCHANGERATE_GETLATESTORGANIZATIONRATE(@BASECURRENCYID, @ORGANIZATIONCURRENCYID, @DATE, null, @TRANSACTIONCURRENCYID)

                -- Ensure that we can add a payment of this transaction currency to the account system.

                if not exists(
                    select 1
                    from 
                        dbo.CURRENCYSETTRANSACTIONCURRENCY
                        inner join dbo.PDACCOUNTSYSTEM on PDACCOUNTSYSTEM.CURRENCYSETID = CURRENCYSETTRANSACTIONCURRENCY.CURRENCYSETID
                    where 
                        PDACCOUNTSYSTEM.ID = @PDACCOUNTSYSTEMID
                        and CURRENCYSETTRANSACTIONCURRENCY.CURRENCYID = @TRANSACTIONCURRENCYID
                )
                begin
                    raiserror('TRANSACTIONCURRENCYINVALIDFORACCOUNTSYSTEM',13,1);
                end

                exec dbo.USP_PAYMENT_ADDBASE @ID output, @CHANGEAGENTID, @CURRENTDATE, @CONSTITUENTID,
                                        @DATE, @AMOUNT, @PAYMENTMETHODCODE, @CHECKDATE, @CHECKNUMBER,
                                        @REFERENCEDATE, @REFERENCENUMBER, @CARDHOLDERNAME, @CREDITCARDNUMBER,
                                        @CREDITTYPECODEID, @AUTHORIZATIONCODE, @EXPIRESON, @ISSUER,
                                        @NUMBEROFUNITS, @SYMBOL, @MEDIANPRICE, @GIFTINKINDSUBTYPECODEID,
                                        @PROPERTYSUBTYPECODEID, @RECEIPTAMOUNT, @CONSTITUENTACCOUNTID,
                                        @POSTSTATUSCODE, @POSTDATE, @FINDERNUMBER,
                                        @SOURCECODE, @APPEALID, @BENEFITS, @BENEFITSWAIVED, @GIVENANONYMOUSLY, 
                                        @MAILINGID, @CHANNELCODEID, @DONOTACKNOWLEDGE,@DONOTRECEIPT,
                                        '', @OTHERPAYMENTMETHODCODEID, @REFERENCE, @TRIBUTEID, @LETTERCODEID,
                                        @DIRECTDEBITRESULTCODE, @LOWPRICE, @HIGHPRICE, @GIFTINKINDITEMNAME, 
                                        @GIFTINKINDDISPOSITIONCODE, @GIFTINKINDNUMBEROFUNITS, 
                                        @GIFTINKINDFAIRMARKETVALUE, @PERCENTAGEBENEFITS, @TRANSACTIONCURRENCYID,
                                        @BASECURRENCYID, @BASEEXCHANGERATEID, @EXCHANGERATE, @CURRENTAPPUSERID,
                                        @SEPAMANDATEID, @TRANSACTIONID, @MERCHANTACCOUNTID, @VENDORID;

                declare @SPLITS xml;
                declare @SPLITSAMOUNT money;

                declare @DECIMALDIGITS tinyint;
                select @DECIMALDIGITS = DECIMALDIGITS from dbo.CURRENCY where ID = @TRANSACTIONCURRENCYID;

                select @SPLITSAMOUNT =sum(AMOUNT)
                from dbo.OPPORTUNITYDESIGNATION
                where OPPORTUNITYID = @APPLICATIONID

                -- Update the xml so that it has the proper root element

                set @SPLITS = (
                    select AMOUNT, DESIGNATIONID as ID 
                        from dbo.OPPORTUNITYDESIGNATION
                        where OPPORTUNITYID = @APPLICATIONID
                        for xml raw('ITEM'),type,elements,root('AMOUNTSTOPRORATE'),binary base64
                );



                declare SPLITCURSOR cursor local fast_forward for
                select AMOUNT, ID as DESIGNATIONID
                    from dbo.UFN_SPLITS_PRORATEAMOUNTS(@SPLITSAMOUNT, @AMOUNT, @DECIMALDIGITS, @SPLITS)

                declare @DESIGNATIONID uniqueidentifier
                declare @SPLITID uniqueidentifier
                declare @SPLITAMOUNT money

                open SPLITCURSOR;
                fetch next from SPLITCURSOR into @SPLITAMOUNT, @DESIGNATIONID;

                while (@@FETCH_STATUS = 0)
                begin

                    exec dbo.USP_GIFT_ADDPAYMENT
                        @REVENUEID = @ID,
                        @AMOUNT = @SPLITAMOUNT,
                        @DESIGNATIONID = @DESIGNATIONID,
                        @OPPORTUNITYID = @APPLICATIONID,
                        @CAMPAIGNS = null,
                        @SOLICITORS = null,
                        @RECOGNITIONCREDITS = null,
                        @CATEGORYCODEID = null,
                        @CREATIONDATE = @CURRENTDATE,
                        @CHANGEAGENTID = @CHANGEAGENTID,
                        @ID = @SPLITID output

                    --Default Recognition

                    exec dbo.USP_REVENUEDETAIL_CREATERECOGNITIONS @SPLITID, @CHANGEAGENTID, @CURRENTDATE;

                    declare @CURRENTSPLITAMOUNT money = (select AMOUNT from dbo.REVENUESPLIT where ID = @SPLITID)

                    if @APPLYDONATIONSENABLED = 1
                    begin
                    --Default Solicitors

                        insert into dbo.REVENUESOLICITOR
                        (
                            REVENUESPLITID,
                            CONSTITUENTID,
                            AMOUNT,
                            SEQUENCE,
                            DATEADDED,
                            DATECHANGED,
                            ADDEDBYID,
                            CHANGEDBYID,
                            BASECURRENCYID,
                            ORGANIZATIONAMOUNT,
                            ORGANIZATIONEXCHANGERATEID
                        )
                        select
                            @SPLITID,
                            SOLICITORS.ID,
                            (SOLICITORS.CREDITPERCENTAGE * @CURRENTSPLITAMOUNT) / 100.0,
                            SOLICITORS.SEQUENCE,
                            @CURRENTDATE,
                            @CURRENTDATE,
                            @CHANGEAGENTID,
                            @CHANGEAGENTID,
                            @BASECURRENCYID BASECURRENCYID,
                            case
                                when @BASECURRENCYID <> @ORGANIZATIONCURRENCYID
                                    then dbo.UFN_CURRENCY_CONVERT((SOLICITORS.CREDITPERCENTAGE * @CURRENTSPLITAMOUNT) / 100.0, @ORGANIZATIONEXCHANGERATEID)
                                else (SOLICITORS.CREDITPERCENTAGE * @CURRENTSPLITAMOUNT) / 100.0
                            end ORGANIZATIONAMOUNT,
                            @ORGANIZATIONEXCHANGERATEID ORGANIZATIONEXCHANGERATEID
                        from
                            dbo.UFN_PROSPECTPLAN_GETFUNDRAISERSANDCREDITS_2(@PROSPECTPLANID,@APPLICATIONID) as SOLICITORS
                    end

                    --Bug 74765 - AdamBu 1/13/10 - Clear SPLITID so that we don't reuse it for the next split.

                    set @SPLITID = null

                    fetch next from SPLITCURSOR into @SPLITAMOUNT, @DESIGNATIONID;
                end

                --When a cursor is used, it should be explicitly closed/deallocated in case of blocking or USP running long

                close SPLITCURSOR;
                deallocate SPLITCURSOR;

                exec dbo.USP_PAYMENT_ADDGIFTFEES @ID, @CONSTITUENTID, @CHANGEAGENTID, @CURRENTDATE;

                exec dbo.USP_GIFTAIDREVENUESPLIT_ADDUPDATESPLITS @ID, @APPEALID, @PAYMENTMETHODCODE, @CREDITTYPECODEID, @CHANGEAGENTID, @DATE, 0, null, null, null; --revenue transaction type code for payment is 0


                --Default Campaigns

                exec dbo.USP_PLEDGE_CLEARANDADDCAMPAIGNS @REVENUEID = @ID,
                    @OPPORTUNITYID = @APPLICATIONID,
                    @CHANGEAGENTID = @CHANGEAGENTID,
                    @CHANGEDATE = @CURRENTDATE

                if @AMOUNT <> (select sum(TRANSACTIONAMOUNT) from dbo.REVENUESPLIT where REVENUEID = @ID)
                    raiserror('BBERR_ALLMONEYNOTAPPLIED', 13, 1);

                if (select count(*) from dbo.REVENUESPLIT where REVENUEID = @ID) = 0
                    raiserror('BBERR_NOAPPLICATIONS', 13, 1);

                exec dbo.USP_PDACCOUNTSYSTEM_LINKTOREVENUE
                    @ID = @ID,
                    @PDACCOUNTSYSTEMID = @PDACCOUNTSYSTEMID,
                    @CHANGEDATE = @CURRENTDATE,
                    @CHANGEAGENTID = @CHANGEAGENTID    

                --Add the GL distributions

                if @POSTSTATUSCODE <> 2
                  exec dbo.USP_SAVE_REVENUEGLDISTRIBUTION @ID, @CHANGEAGENTID, @CURRENTDATE;

            end try

            begin catch
                exec dbo.USP_RAISE_ERROR;

                return 1;
            end catch

            return 0;