Funds

List All

GET /settings/funds.xml

Returns a list of funds for the organization. The list is paginated using the page parameter. To specify a page number, request a url like /settings/funds.xml?page=2.

Response

<funds type="array">
  <current_page type="integer">1</current_page>
  <per_page type="integer">30</per_page>
  <total_entries type="integer">7</total_entries>
  <fund>
    <id type="integer">10003</id>
    <name>Building Project</name>
    ...
  </fund>
  <fund>
    ...
  </fund>
</funds>

Show

GET /settings/funds/10003.xml

Response

<fund>
  <id type="integer">10003</id>
  <name>Building Project</name>
  ...
</fund>

Retrieving a list of donors to a Fund

GET /settings/funds/10003.xml?include_donors=true

Response

<fund>
  <id type="integer">10003</id>
  <name>Building Project</name>
  ...
  <donors type="array">
    <donor>
      <recognition-name>Joe Donor</recognition-name>
      <id type="integer">123456</id>
      <total-in-cents type="integer">50000</total-in-cents>
      <total type="Money">500.00</total>
      <number-of-donations type="integer">2</number-of-donations>
    </donor>
  </donors>
</fund>

Update

<fund>
  <id type="integer">10003</id>
  <name>Building Project</name>
  <goal type="integer">40000</goal>
  <alias>Optional fund alias</alias>
  <description>A description</description>
  <donation-splits-count type="integer">100</donation-splits-count>
  <starts-on type="date" nil="true"></starts-on>
  <ends-on type="date" nil="true"></ends-on>
  <archived type="boolean">false</archived>
  <meta type="yaml"></meta>
  <published type="boolean">false</published>
  <tax-deductible type="boolean">true</tax-deductible>
</fund>

Response

Create

<?xml version="1.0" encoding="UTF-8"?>
<fund>
  <name>The Name of the New Fund</name>
  <!-- Turn on the fundraising page: -->
  <published type="boolean">true</published>
  <!-- The following line sets up the HTML text that appears on the fundraising page:  -->
  <description><![CDATA[
This is my [Markdown](https://daringfireball.net/projects/markdown/syntax) formatted text.

I can use merge fields like this:

{{ fund.number_of_donors }} donors have helped us raise {{ fund.raised }} of our {{ fund.goal }} goal - that's {{ fund.percent_raised }}%!

<p>I can also use <acronym title="Hyper Text Markup Language">HTML</acronym> tags.</p>

<script>alert("However, anything potentially nefarious (such as JavaScript) will be stripped out");</script>.
]]></description>
  <excerpt>This is a short description of the fund for use on the index page.</excerpt>
  <!-- Optional: set whether or not this fund is tax deductible: -->
  <tax-deductible type="boolean">true</tax-deductible>
  <!-- Optional fundraising goal: -->
  <goal type="Money">25000.00</goal>
</fund>

Required Attributes

• name (must be unique)
• organization_id

Response

<fund>
  <name>Building Project</name>
  ...
</fund>

Delete

You must pass a replacement fund ID in order to delete a fund. All donations assigned to the fund being deleted will be reassigned to the replacement fund.

DELETE /settings/funds/1.xml?replacement_fund_id=2

Response