Fundraising API vs NXT Data Integration API

Ben Wong

Is there any particular reason why entities returned by GET methods in Fundraising API are different from records returned by Get a Fund/Campaign/Appeal methods in NXT Data Integration API?


Unfortunately I can't confirm that it actually is the case (getting "Permission denied. This API is currently in a private preview available to selected ISV Partners" error), but based on the documentation it looks like the records are different.


Example:

GET Fund in Fundraising API response contains Fund entity:

{<br/> "id": "26",<br/> "category": "Annual",<br/> "date_added": "2001-11-16T11:26:53.52+00:00",<br/> "date_modified": "2017-03-23T13:10:46.64+00:00",<br/> "description": "2004 Annual Fund",<br/> "end_date": "2004-12-31T00:00:00",<br/> "goal": {<br/> "value": 500000<br/> },<br/> "inactive": false,<br/> "lookup_id": "2004ANNUAL",<br/> "start_date": "2004-01-01T00:00:00",<br/> "type": "Donor Advised Fund"<br/>}
Meanwhile GET Get a Fund in Integration API response contains Fund record as:

{<br/> "fund_category": "string",<br/> "campaign": "string",<br/> "default_appeal": "string",<br/> "id": 0,<br/> "fund_id": "string",<br/> "description": "string",<br/> "fund_category_id": 0,<br/> "campaign_id": 0,<br/> "start_date": "string",<br/> "end_date": "string",<br/> "inactive": true,<br/> "default_appeal_id": 0,<br/> "notes": "string",<br/> "goal": 0.0,<br/> "restricted": true<br/>}

Comments

  • Paul Gibson
    Paul Gibson Blackbaud Employee
    Tenth Anniversary Kudos 2 Participant Facilitator 1
    Hi Szymon. You are correct that the types in the NXT Data Integration API are different from types in other apis. That is by design because the NXT Data Integration API is a new api where we are applying some lessons learned and making an effort to optimize for developers that are familiar with the classic RE7 schema and RE7 API object model as well as correct some unnecessary complexities you might see in some of the other apis (such as the goal field being a complex type rather than a simple decimal value).
  • Just reiterating that we are also champing at the bit for access to the NXT Data Integration API asap so we can add/test long-awaited functionality to our Springbaud NeXT and Springbaud Direct integrations. #NXTDataIntegrationAPI

  • Thanks Paul Gibson‍ , it makes sense.


    Follow up question: is there a reason why fund_category is included in the NXT Data Integration record and fund_type is not?

    They are both RE7 fields we're consistently using and not being able set up the value through SKY API significantly limits the functionality. It's actually not the first case, where for whatever reason, SKY API record implementation includes all but one of the existing fields (examples - Opportunity Rating, Fundraiser Assignment Notes), which in some cases makes it useless to us unless we completely change the way we currently organize some data.
  • Paul Gibson
    Paul Gibson Blackbaud Employee
    Tenth Anniversary Kudos 2 Participant Facilitator 1
    fund_type was not intentionally omitted, it was just a miss. Our internal consumer called that to our attention last week and we have a work item now to track adding fund_type.
  • Paul‍ is there any timeline on when the NXT Data Integration API will move to general access beta?


    We have an integration that we still can't fully release because we need to be able to test against this API.


    We've highlighted this several times to date but have not had any success in eliciting a response.


    A forecast on access to the API would help us mollify our customers.


    Cheers and thanks,


    Steve
  • Hi Paul - Putting on my Financial Edge NXT hat, please consider adding the ability to add or edit the FENXT Project associated with the Fund record in RE. The entire GL dist is less important since their are options to copy from, but adding at least the project allows for your Data Integration solution to tie in nicely wiith Financial Edge NXT. Overall, really exciting to see CRUD with RE Funds!!!
  • Paul Gibson‍ a couple of months ago elsewhere on this thread, I requested some idea of a timeline on general availability of the NXT Data Integration API but have not yet seen a reply.


    In the interests of visibility and planning, would you - or someone - please provide some guidance as to when we will be able to test with this API? We'd prefer to not be working in the dark.


    Thank you.

  • Paul Gibson
    Paul Gibson Blackbaud Employee
    Tenth Anniversary Kudos 2 Participant Facilitator 1
    Szymon Zaleski‍ I have an update on fund_type missing from the NXT Data Integration fund endpoints. This field has been added to the POST/PATCH/GET(2) endpoints for the Fund record. This is now live and available to use.