Adding to Gift Receipt "Name"

Daniel At Calm

I'm working with the RE NXT API and have donations running successfully.

I've been asked to populate a field which is shown below bottom right with a 4 in it, however this doesn't seem to be within the RE API reference documentation to send this through in any form - https://developer.sky.blackbaud.com/api#api=58bdd5edd7dcde06046081d6&operation=CreateGift

I believe it's to do with the receipt “name” as if I add this field in the database view and load the record with the API I get the following response :

'{"id": "223984", "acknowledgements": [{"status": "NEEDSACKNOWLEDGEMENT"}], "amount": {"value": 0.0}, "constituent_id": "125863", "date": "2024-12-12T00:00:00", "date_added": "2024-12-12T12:08:08.17+00:00", "date_modified": "2024-12-12T12:22:26.875+00:00", "fundraisers": [], "gift_aid_amount": {"value": 0.0}, "gift_aid_qualification_status": "Qualified", "gift_splits": [{"id": "221800", "amount": {"value": 0.0}, "appeal_id": "82", "campaign_id": "1", "fund_id": "3", "gift_aid_amount": {"value": 0.0}, "gift_aid_qualification_status": "Qualified"}], "gift_status": "Active", "is_anonymous": false, "linked_gifts": [], "constituency": "Supporter", "lookup_id": "207479", "origin": "{\\\\"name\\\\": \\\\"Website Donation\\\\"}", "payments": [{"payment_method": "CreditCard"}], "post_date": "2024-12-12T00:00:00", "post_status": "NotPosted", "receipts": [{"amount": {"value": 0.0}, "number": 4, "status": "NEEDSRECEIPT"}], "soft_credits": [], "subtype": "4350", "type": "Donation"}'

I just need to know how I add to this field in my API calls, so it does not need to be manually added in.

Thanks for any help.
Dan

Alex Wong

@Daniel At Calm
Log Details is definitely not something I have seen in RE before, so either you are not in U.S. (most likely not as your currency symbol is different) and that international version of RE has this field named differently, or your org RE admin make a choice to change the “label” of the field from Receipt to Log Details

SKY API (and RE NXT webview) will not care about your custom labelling of field that is allowed in dbview, so the field you are seeking is receipts.

Also, it is not a “name” field, so you cannot use any characters. It is a Receipt Number field, which only allows whole number.

So to add this automatically to gift create API, you just add the receipts property as an array (even though there can ONLY be ONE object of receipt).

"receipts": [{"amount": {"value": 0}, "number": 4, "status": "NEEDSRECEIPT"}]

Daniel At Calm

@Alex Wong thanks for the information, that makes total sense. We're based in the UK, however I'm guessing the client may have renamed the field at some point in their setup.

Unfortunately your solution hasn't worked for me, but it's less urgent as we've come up with an alternative.

Alex Wong

@Daniel At Calm
Ok, when you feel you want to tackle this again, please send error message and screenshot of what doesn't work.

Not sure what your alternative is, but you can always set the receipt after gift creation with this endpoint

https://developer.sky.blackbaud.com/api#api=58bdd5edd7dcde06046081d6&operation=EditGiftReceipt