Collecting Write Off gifts through Gifts API

Peter Kungania

I am currently using the Gifts list API to get a paginated list of all gifts within RE but I am not able to retrieve gifts with type — ' write off'. https://developer.sky.blackbaud.com/api#api=58bdd5edd7dcde06046081d6&operation=ListGifts

I have noticed that I can get these writeoffs from the 'Gift (Get)' endpoint but I need to specify the Gift ID in order to get them. Is there an endpoint I can use to get a paginated list of writeoffs without specifying the writeoffs gift id?

Alex Wong

1. Execute Query by a saved query using the query's ID
   1. or execute query using JSON via adhoc querying
   2. this is also where you will specify if you want CSV, JSON, or JSONL data format
2. wait and loop until job completed (interval of 30 seconds) using the execution's job status with the Job ID returned from step 1
3. if job completed successfully, there will be a URI that you can use to download the data.

Alex Wong

Use Query API to run a gift query for write off gifts. This is how I add all write off into my data warehouse for reporting/dashboarding for pledges/installments/payments/writeoff.

James Belich

@Alex Wong, how do you connect the write-offs to the original pledge in your data warehouse? I know there is a field on the back-end (GFLink) that indicates the original pledge for a payment or write-off, but this field can't be included in a query output, which makes pledge reporting difficult.

Alex Wong

Connecting the pledge gift record to the installment records (one pledge can have multiple installments), then connecting each installment to the payment records (one installment can have multiple "payment records", and payment record can be a pledge payment OR can be pledge write off). These relationships are detailed ONLY in the Gift V2 API endpoint for getting installments per pledge and getting payments per pledge. There is currently no way to get all pledge's installment and payments in bulk.

The "issue" that you need to use Query API for is, the get payments per pledge returns the payment gift id, not directly any "real" payment details (i.e. payment gift date, payment gift amount, write off gift date, write off gift amount). So in order for you to do proper gift reporting, you will need the data from the gift table, which is FINE for pledge payment, as they exists in the Get Gift List API endpoint. However, as you know, Write off does not come in from Get Gift List API endpoint, so you need to use Query API to filter on ONLY pledge write off gift type, and that store the important details in the same area you save all your other gift details.

Peter Kungania

https://community.blackbaud.com/discussion/comment/309477#Comment_309477

Hi Alex,

Can you provide some additional detail regarding the Query API. My understanding of this API is that it returns the configuration options for the Query but doesn't actually return the Query results.

If there is an endpoint that returns the results can you point me to that endpoint.

Thanks,

Peter