Endpoint gift (Soft Credits)

Question

Hi everyone,

I am using the following endpoint to pull all gift data, but I am wondering how the soft-credits are being flagged in the backend. Is there any end-point I can use it?

I do not see anything that I can use to link as soft credit attribute.

https://api.sky.blackbaud.com/gift/v1/gifts/

Alex Wong · Answer

{

    "pledge_id": "1",

    "pledge_payments": [{

        "installment_id": "30",

        "payment_gift_id": "12",

        "amount_applied": {

            "value": 10

        }

    }, {

        "installment_id": "31",

        "payment_gift_id": "13",

        "amount_applied": {

            "value": 10

        }

    }]

}

this means:

* in pledge with gift system record id 1, there are 2 "payment gifts" applied to 2 installments
* installment_id 30 has $10 "paid" by gift payment system record id 12* gift payment system record id 12 CAN be pay-cash (real cash payment) OR write off, you will need to look up this gift and look at the gift_type
* gift payment system record id 12 (if pay-cash) can be any gift amount more than or equals to $10, as a payment cash gift can be applied to multiple pledge or even if same pledge, can be multiple installments within the pledge

* installment_id 31 has $10 "paid" by gift payment system record id 13

Giovanni Franco · Answer

For this par, I think it is clear. As far of my understanding the soft credit array coming up from gift v1 end point. I saw on a few entries.

From the v2 get payment.

https://api.sky.blackbaud.com/gft-gifts/v2/gifts/{gift_id}/pledgepayments

I am assuming that from the query I run for write-off it should be an entry for any installment id (eg.30,31) associated to the pledge id (1). Am I right?

Thx.

{
    "pledge_id": "1",
    "pledge_payments": [{
        "installment_id": "30",
        "payment_gift_id": "12",
        "amount_applied": {
            "value": 10
        }
    }, {
        "installment_id": "31",
        "payment_gift_id": "13",
        "amount_applied": {
            "value": 10
        }
    }]
}

Alex Wong · Answer

I'm not sure I understand what you are trying to do, so i'll try to answer in pieces I think you are asking:

1 gift can have 0 or more soft credit, so for each gift object, you will potentially have no soft_credits proeprty, if there is soft credit, the property will be an array with the soft credit constituent's system record id and the amount being soft credited

to run query api and get its data, there are template available you to take advantage on in the template showcase

To get link between pledge, payment, and write off, you need to use gift v2 get payment endpoint, note that in BB terminology, payment is both actual payment received and write off on the pledge.