Contribution Receipts

A contribution receipt or collection of contribution receipts are used to display contribution receipts

Notes ::

  • By passing in the content-type of application/help in the accept header or using the {format} parameter help from https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts, the API will return an html representation of the help documents for this resource (authentication not required)

Authentication

This method requires Authentication

Resource Structure

This resource conforms to the following XSD

Methods

Contribution Receipts ::

  • search [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/search?{parameter}
  • show [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/{id}
  • new [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/new
  • edit [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/{id}/edit
  • create [POST] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts
  • update [PUT] [POST(Low REST)] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/{id}

Method: search [GET]

The search method will return a list of contribution receipts.

Notes ::

  • By passing in the content-type of application/xsd in the accept header or using the {format} parameter xsd the API will return an xsd for a single version of this resource (authentication not required)
  • If the recordsPerPage parameter is not used or its value is less than 1, the API will default the parameter to 20
  • If the recordsPerPage parameter's value is less than 10, the API will default the parameter to 10
  • If the page parameter is not used or its value is less than 1, the API will default the parameter to 1

Content-types ::

  • application/json
  • application/xml
  • application/xsd
  • application/help

Format ::

  • json
  • xml
  • xsd
  • help

Parameters ::

  • {format}

    • [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/search.{format}?{parameters}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/search?format={format}&{parameters}
    • [Header] Accept : {Content-type}
  • {parameters}

    • batchID = search for receipts containing the batchID this is passed with this parameter.
    • individualID = search for receipts containing the individualID that is passed with this parameter.
    • householdID = search for receipts containing the householdID that is passed with this parameter.
    • startReceivedDate = search for receipts with a received date greater than or equal to this parameter (format: yyyy-mm-dd).
    • endReceivedDate = search for receipts with a received date less than or equal to this parameter. Must be used in conjunction with startReceivedDate (format: yyyy-mm-dd).
      • ex. startReceivedDate=2014-12-15&endReceivedDate=2014-12-16 will give you a 24 hour period.
    • lastupdatedDate = will return all records where the last update date is greater than or equal to the parameter passed to the API. The results will also be sorted by the lastUpdatedDate in ascending order.
    • fundTypeID = search for receipts containing the fundTypeID that is passed with this parameter (this query param can only be used in conjunction with other parameters and not alone).

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/search?batchid=971632

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 20 Oct 2011 03:58:46 GMT
Content-Length: 3574

<?xml version="1.0" encoding="utf-8"?>
<results count="2" pageNumber="1" totalRecords="2" additionalPages="0">
  <contributionReceipt json:Array="true" id="101705914" uri="https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914" oldID="">
    <accountReference></accountReference>
    <amount>23.3333</amount>
    <fund id="4787" uri="https://demo.fellowshiponeapi.com/giving/v1/funds/4787">
      <name>Bible Study Classes</name>
      <fundTypeID>1</fundTypeID>
    </fund>
    <subFund id="" uri="">
      <name />
    </subFund>
    <pledgeDrive id="" uri="">
      <name></name>
    </pledgeDrive>
    <household id="" uri="" />
    <person id="" uri="" />
    <account id="" uri="" />
    <referenceImage id="22332185" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceimages/22332185" />
    <batch id="971632" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/971632">
      <name>Paul Johnston Test</name>
    </batch>
    <activityInstance id="" uri="" />
    <contributionType id="2" uri="https://demo.fellowshiponeapi.com/giving/v1/contributiontypes/2">
      <name>Cash</name>
    </contributionType>
    <contributionSubType id="" uri="">
      <name />
    </contributionSubType>
    <receivedDate>2008-08-25T00:00:00</receivedDate>
    <transmitDate></transmitDate>
    <returnDate></returnDate>
    <retransmitDate></retransmitDate>
    <glPostDate></glPostDate>
    <isSplit>false</isSplit>
    <addressVerification>false</addressVerification>
    <memo></memo>
    <statedValue></statedValue>
    <trueValue></trueValue>
    <thank>true</thank>
    <thankedDate></thankedDate>
    <isMatched>0</isMatched>
    <createdDate>2008-08-25T11:38:51</createdDate>
    <createdByPerson id="" uri="" />
    <lastUpdatedDate>2010-02-07T00:41:17</lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
  </contributionReceipt>
  <contributionReceipt json:Array="true" id="101706745" uri="https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101706745" oldID="">
    ...
  </contributionReceipt>
</results>

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/search.json?batchid=971632

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 20 Oct 2011 04:13:43 GMT
Content-Length: 2738

{
   "results":{
      "@count":"2",
      "@pageNumber":"1",
      "@totalRecords":"2",
      "@additionalPages":"0",
      "contributionReceipt":[
         {
            "@array":"true",
            "@id":"101705914",
            "@uri":"https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914",
            "@oldID":"",
            "accountReference":null,
            "amount":"23.3333",
            "fund":{
               "@id":"4787",
               "@uri":"https://demo.fellowshiponeapi.com/giving/v1/funds/4787",
               "name":"Bible Study Classes"
            },
            "subFund":{
               "@id":"",
               "@uri":"",
               "name":null
            },
            "pledgeDrive":{
               "@id":"",
               "@uri":"",
               "name":null
            },
            "household":{
               "@id":"",
               "@uri":""
            },
            "person":{
               "@id":"",
               "@uri":""
            },
            "account":{
               "@id":"",
               "@uri":""
            },
            "referenceImage":{
               "@id":"22332185",
               "@uri":"https://demo.fellowshiponeapi.com/giving/v1/referenceimages/22332185"
            },
            "batch":{
               "@id":"971632",
               "@uri":"https://demo.fellowshiponeapi.com/giving/v1/batches/971632",
               "name":"Paul Johnston Test"
            },
            "activityInstance":{
               "@id":"",
               "@uri":""
            },
            "contributionType":{
               "@id":"2",
               "@uri":"https://demo.fellowshiponeapi.com/giving/v1/contributiontypes/2",
               "name":"Cash"
            },
            "contributionSubType":{
               "@id":"",
               "@uri":"",
               "name":null
            },
            "receivedDate":"2008-08-25T00:00:00",
            "transmitDate":null,
            "returnDate":null,
            "retransmitDate":null,
            "glPostDate":null,
            "isSplit":"false",
            "addressVerification":"false",
            "memo":null,
            "statedValue":null,
            "trueValue":null,
            "thank":"true",
            "thankedDate":null,
            "isMatched":"0",
            "createdDate":"2008-08-25T11:38:51",
            "createdByPerson":{
               "@id":"",
               "@uri":""
            },
            "lastUpdatedDate":"2010-02-07T00:41:17",
            "lastUpdatedByPerson":{
               "@id":"",
               "@uri":""
            }
         },
         {
            ...
         }
      ]
   }
}

Method: show [GET]

The show method will return a single contributionreceipt for a given id.

Notes ::

  • By passing in the content-type of application/xsd in the accept header or using the {format} parameter xsd the API will return an xsd for a single version of this resource (authentication not required)

Content-types ::

  • application/json
  • application/xml
  • application/xsd
  • application/help

Format ::

  • json
  • xml
  • xsd
  • help

Parameters ::

  • {format}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/{id}.{format}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/{id}?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/{id}

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 20 Oct 2011 04:19:30 GMT
Content-Length: 1662

<?xml version="1.0" encoding="utf-8"?>
<contributionReceipt id="101705914" uri="https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914" oldID="">
  <accountReference></accountReference>
  <amount>23.3333</amount>
  <fund id="4787" uri="https://demo.fellowshiponeapi.com/giving/v1/funds/4787">
    <name>Bible Study Classes</name>
  </fund>
  <subFund id="" uri="">
    <name />
  </subFund>
  <pledgeDrive id="" uri="">
    <name></name>
  </pledgeDrive>
  <household id="" uri="" />
  <person id="" uri="" />
  <account id="" uri="" />
  <referenceImage id="22332185" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceimages/22332185" />
  <batch id="971632" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/971632">
    <name>Paul Johnston Test</name>
  </batch>
  <activityInstance id="" uri="" />
  <contributionType id="2" uri="https://demo.fellowshiponeapi.com/giving/v1/contributiontypes/2">
    <name>Cash</name>
  </contributionType>
  <contributionSubType id="" uri="">
    <name />
  </contributionSubType>
  <receivedDate>2008-08-25T00:00:00</receivedDate>
  <transmitDate></transmitDate>
  <returnDate></returnDate>
  <retransmitDate></retransmitDate>
  <glPostDate></glPostDate>
  <isSplit>false</isSplit>
  <addressVerification>false</addressVerification>
  <memo></memo>
  <statedValue></statedValue>
  <trueValue></trueValue>
  <thank>true</thank>
  <thankedDate></thankedDate>
  <isMatched>0</isMatched>
  <createdDate>2008-08-25T11:38:51</createdDate>
  <createdByPerson id="" uri="" />
  <lastUpdatedDate>2010-02-07T00:41:17</lastUpdatedDate>
  <lastUpdatedByPerson id="" uri="" />
</contributionReceipt>

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 20 Oct 2011 04:37:20 GMT
Content-Length: 1320

{
   "contributionReceipt":{
      "@id":"101705914",
      "@uri":"https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914",
      "@oldID":"",
      "accountReference":null,
      "amount":"23.3333",
      "fund":{
         "@id":"4787",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/funds/4787",
         "name":"Bible Study Classes"
      },
      "subFund":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "pledgeDrive":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "household":{
         "@id":"",
         "@uri":""
      },
      "person":{
         "@id":"",
         "@uri":""
      },
      "account":{
         "@id":"",
         "@uri":""
      },
      "referenceImage":{
         "@id":"22332185",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/referenceimages/22332185"
      },
      "batch":{
         "@id":"971632",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/batches/971632",
         "name":"Paul Johnston Test"
      },
      "activityInstance":{
         "@id":"",
         "@uri":""
      },
      "contributionType":{
         "@id":"2",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/contributiontypes/2",
         "name":"Cash"
      },
      "contributionSubType":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "receivedDate":"2008-08-25T00:00:00",
      "transmitDate":null,
      "returnDate":null,
      "retransmitDate":null,
      "glPostDate":null,
      "isSplit":"false",
      "addressVerification":"false",
      "memo":null,
      "statedValue":null,
      "trueValue":null,
      "thank":"true",
      "thankedDate":null,
      "isMatched":"0",
      "createdDate":"2008-08-25T11:38:51",
      "createdByPerson":{
         "@id":"",
         "@uri":""
      },
      "lastUpdatedDate":"2010-02-07T00:41:17",
      "lastUpdatedByPerson":{
         "@id":"",
         "@uri":""
      }
   }
}

Method: edit [GET]

The edit method will return a single contribution receipt for a given id. The purpose of the edit method is to retrieve a resource in its most recent condition with its latest values.

Content-types ::

  • application/json
  • application/xml
  • application/help

Format ::

  • json
  • xml
  • help

Parameters ::

  • {format}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/{id}/edit.{format}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/{id}/edit?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/{id}/edit

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914/edit

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914/edit
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 20 Oct 2011 04:42:42 GMT
Content-Length: 1662

<?xml version="1.0" encoding="utf-8"?>
<contributionReceipt id="101705914" uri="https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914" oldID="">
  <accountReference></accountReference>
  <amount>23.3333</amount>
  <fund id="4787" uri="https://demo.fellowshiponeapi.com/giving/v1/funds/4787">
    <name>Bible Study Classes</name>
  </fund>
  <subFund id="" uri="">
    <name />
  </subFund>
  <pledgeDrive id="" uri="">
    <name></name>
  </pledgeDrive>
  <household id="" uri="" />
  <person id="" uri="" />
  <account id="" uri="" />
  <referenceImage id="22332185" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceimages/22332185" />
  <batch id="971632" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/971632">
    <name>Paul Johnston Test</name>
  </batch>
  <activityInstance id="" uri="" />
  <contributionType id="2" uri="https://demo.fellowshiponeapi.com/giving/v1/contributiontypes/2">
    <name>Cash</name>
  </contributionType>
  <contributionSubType id="" uri="">
    <name />
  </contributionSubType>
  <receivedDate>2008-08-25T00:00:00</receivedDate>
  <transmitDate></transmitDate>
  <returnDate></returnDate>
  <retransmitDate></retransmitDate>
  <glPostDate></glPostDate>
  <isSplit>false</isSplit>
  <addressVerification>false</addressVerification>
  <memo></memo>
  <statedValue></statedValue>
  <trueValue></trueValue>
  <thank>true</thank>
  <thankedDate></thankedDate>
  <isMatched>0</isMatched>
  <createdDate>2008-08-25T11:38:51</createdDate>
  <createdByPerson id="" uri="" />
  <lastUpdatedDate>2010-02-07T00:41:17</lastUpdatedDate>
  <lastUpdatedByPerson id="" uri="" />
</contributionReceipt>

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914/edit.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914/edit.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 20 Oct 2011 04:45:27 GMT
Content-Length: 1320


{
   "contributionReceipt":{
      "@id":"101705914",
      "@uri":"https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/101705914",
      "@oldID":"",
      "accountReference":null,
      "amount":"23.3333",
      "fund":{
         "@id":"4787",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/funds/4787",
         "name":"Bible Study Classes"
      },
      "subFund":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "pledgeDrive":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "household":{
         "@id":"",
         "@uri":""
      },
      "person":{
         "@id":"",
         "@uri":""
      },
      "account":{
         "@id":"",
         "@uri":""
      },
      "referenceImage":{
         "@id":"22332185",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/referenceimages/22332185"
      },
      "batch":{
         "@id":"971632",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/batches/971632",
         "name":"Paul Johnston Test"
      },
      "activityInstance":{
         "@id":"",
         "@uri":""
      },
      "contributionType":{
         "@id":"2",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/contributiontypes/2",
         "name":"Cash"
      },
      "contributionSubType":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "receivedDate":"2008-08-25T00:00:00",
      "transmitDate":null,
      "returnDate":null,
      "retransmitDate":null,
      "glPostDate":null,
      "isSplit":"false",
      "addressVerification":"false",
      "memo":null,
      "statedValue":null,
      "trueValue":null,
      "thank":"true",
      "thankedDate":null,
      "isMatched":"0",
      "createdDate":"2008-08-25T11:38:51",
      "createdByPerson":{
         "@id":"",
         "@uri":""
      },
      "lastUpdatedDate":"2010-02-07T00:41:17",
      "lastUpdatedByPerson":{
         "@id":"",
         "@uri":""
      }
   }
}

Method: new [GET]

The new method will return a single contribution receipt. The purpose of the new method is to retrieve an empty resource with the proper structure.

Content-types ::

  • application/json
  • application/xml
  • application/help

Format ::

  • json
  • xml
  • help

Parameters ::

  • {format}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/new.{format}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/new?format={format}
    • [Header] Accept : {Content-type}

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/new

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 20 Oct 2011 04:49:31 GMT
Content-Length: 1244

<?xml version="1.0" encoding="utf-8"?>
<contributionReceipt id="" uri="" oldID="">
  <accountReference></accountReference>
  <amount></amount>
  <fund id="" uri="">
    <name />
  </fund>
  <subFund id="" uri="">
    <name />
  </subFund>
  <pledgeDrive id="" uri="">
    <name></name>
  </pledgeDrive>
  <household id="" uri="" />
  <person id="" uri="" />
  <account id="" uri="" />
  <referenceImage id="" uri="" />
  <batch id="" uri="">
    <name />
  </batch>
  <activityInstance id="" uri="" />
  <contributionType id="" uri="">
    <name></name>
  </contributionType>
  <contributionSubType id="" uri="">
    <name />
  </contributionSubType>
  <receivedDate></receivedDate>
  <transmitDate></transmitDate>
  <returnDate></returnDate>
  <retransmitDate></retransmitDate>
  <glPostDate></glPostDate>
  <isSplit>false</isSplit>
  <addressVerification>false</addressVerification>
  <memo></memo>
  <statedValue></statedValue>
  <trueValue></trueValue>
  <thank>false</thank>
  <thankedDate></thankedDate>
  <isMatched></isMatched>
  <createdDate></createdDate>
  <createdByPerson id="" uri="" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id="" uri="" />
</contributionReceipt>

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/new.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 20 Oct 2011 04:50:20 GMT
Content-Length: 914

{
   "contributionReceipt":{
      "@id":"",
      "@uri":"",
      "@oldID":"",
      "accountReference":null,
      "amount":null,
      "fund":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "subFund":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "pledgeDrive":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "household":{
         "@id":"",
         "@uri":""
      },
      "person":{
         "@id":"",
         "@uri":""
      },
      "account":{
         "@id":"",
         "@uri":""
      },
      "referenceImage":{
         "@id":"",
         "@uri":""
      },
      "batch":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "activityInstance":{
         "@id":"",
         "@uri":""
      },
      "contributionType":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "contributionSubType":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "receivedDate":null,
      "transmitDate":null,
      "returnDate":null,
      "retransmitDate":null,
      "glPostDate":null,
      "isSplit":"false",
      "addressVerification":"false",
      "memo":null,
      "statedValue":null,
      "trueValue":null,
      "thank":"false",
      "thankedDate":null,
      "isMatched":null,
      "createdDate":null,
      "createdByPerson":{
         "@id":"",
         "@uri":""
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":"",
         "@uri":""
      }
   }
}

Method: create [POST]

The create method will create a single contribution receipt.

Notes ::

  • This method will return a 201 - Created if successfully created

Content-types ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

  • {format}
    • [POST] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts.{format}
    • [POST] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts?format={format}
    • [Header] Accept : {Content-type}

Required Fields ::

  • fund/@id
  • receivedDate
  • contributiontype/@id

Sample Response ::

Given: [POST] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts

Request body:

<?xml version="1.0" encoding="utf-8"?>
<contributionReceipt>
  <accountReference></accountReference>
  <amount></amount>
  <fund id="4787">
    <name />
  </fund>
  <subFund id="">
    <name />
  </subFund>
  <pledgeDrive id="">
    <name></name>
  </pledgeDrive>
  <household id="" />
  <person id="" uri="" />
  <account id="" uri="" />
  <referenceImage id="22332185" />
  <batch>
    <name />
  </batch>
  <activityInstance />
  <contributionType id="2">
    <name>Cash</name>
  </contributionType>
  <contributionSubType>
    <name />
  </contributionSubType>
  <receivedDate>2008-08-25T00:00:00</receivedDate>
  <transmitDate></transmitDate>
  <returnDate></returnDate>
  <retransmitDate></retransmitDate>
  <glPostDate></glPostDate>
  <isSplit>false</isSplit>
  <addressVerification>false</addressVerification>
  <memo></memo>
  <statedValue></statedValue>
  <trueValue></trueValue>
  <thank>true</thank>
  <thankedDate></thankedDate>
  <isMatched>0</isMatched>
  <createdDate></createdDate>
  <createdByPerson id="" uri=""/>
  <lastUpdatedDate/>
  <lastUpdatedByPerson id="" uri=""/>
</contributionReceipt>

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Location: https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/136261097
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 20 Oct 2011 04:59:54 GMT
Content-Length: 1695

<?xml version="1.0" encoding="utf-8"?>
<contributionReceipt id="136261097" uri="https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/136261097" oldID="">
  <accountReference></accountReference>
  <amount>0.0000</amount>
  <fund id="4787" uri="https://demo.fellowshiponeapi.com/giving/v1/funds/4787">
    <name>Bible Study Classes</name>
  </fund>
  <subFund id="" uri="">
    <name />
  </subFund>
  <pledgeDrive id="" uri="">
    <name></name>
  </pledgeDrive>
  <household id="" uri="" />
  <person id="" uri="" />
  <account id="" uri="" />
  <referenceImage id="22332185" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceimages/22332185" />
  <batch id="" uri="">
    <name>Paul Johnston Test</name>
  </batch>
  <activityInstance id="" uri="" />
  <contributionType id="2" uri="https://demo.fellowshiponeapi.com/giving/v1/contributiontypes/2">
    <name>Cash</name>
  </contributionType>
  <contributionSubType id="" uri="">
    <name />
  </contributionSubType>
  <receivedDate>2008-08-25T00:00:00</receivedDate>
  <transmitDate></transmitDate>
  <returnDate></returnDate>
  <retransmitDate></retransmitDate>
  <glPostDate></glPostDate>
  <isSplit>false</isSplit>
  <addressVerification>false</addressVerification>
  <memo></memo>
  <statedValue></statedValue>
  <trueValue></trueValue>
  <thank>true</thank>
  <thankedDate></thankedDate>
  <isMatched>0</isMatched>
  <createdDate>2011-10-19T23:59:52</createdDate>
  <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
</contributionReceipt>

Given: [POST] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts.json

Request body:

{ "contributionReceipt":{ "@id":"", "@uri":"", "@oldID":"", "accountReference":null, "amount":0.00, "fund":{ "@id":"4787", "@uri":"", "name":"" }, "subFund":{ "@id":"", "@uri":"", "name":null }, "pledgeDrive":{ "@id":"", "@uri":"", "name":null }, "household":{ "@id":"", "@uri":"" }, "person":{ "@id":"", "@uri":"" }, "account":{ "@id":"", "@uri":"" }, "referenceImage":{ "@id":"", "@uri":"" }, "batch":{ "@id":"", "@uri":"", "name":"" }, "activityInstance":{ "@id":"", "@uri":"" }, "contributionType":{ "@id":"2", "@uri":"", "name":null }, "contributionSubType":{ "@id":"", "@uri":"", "name":null }, "receivedDate":"2008-08-25T00:00:00", "transmitDate":null, "returnDate":null, "retransmitDate":null, "glPostDate":null, "isSplit":"false", "addressVerification":"false", "memo":null, "statedValue":null, "trueValue":null, "thank":"false", "thankedDate":null, "isMatched":null, "createdDate":null, "createdByPerson":{ "@id":"", "@uri":"" }, "lastUpdatedDate":null, "lastUpdatedByPerson":{ "@id":"", "@uri":"" } } }

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/json; charset=utf-8
Location: https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts.json/136261098
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 20 Oct 2011 05:12:04 GMT
Content-Length: 1279

{
   "contributionReceipt":{
      "@id":"136261098",
      "@uri":"https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/136261098",
      "@oldID":"",
      "accountReference":null,
      "amount":"0.0000",
      "fund":{
         "@id":"4787",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/funds/4787",
         "name":"Bible Study Classes"
      },
      "subFund":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "pledgeDrive":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "household":{
         "@id":"",
         "@uri":""
      },
      "person":{
         "@id":"",
         "@uri":""
      },
      "account":{
         "@id":"",
         "@uri":""
      },
      "referenceImage":{
         "@id":"",
         "@uri":""
      },
      "batch":{
         "@id":"",
         "@uri":"",
         "name":"Paul Johnston Test"
      },
      "activityInstance":{
         "@id":"",
         "@uri":""
      },
      "contributionType":{
         "@id":"2",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/contributiontypes/2",
         "name":"Cash"
      },
      "contributionSubType":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "receivedDate":"2008-08-25T00:00:00",
      "transmitDate":null,
      "returnDate":null,
      "retransmitDate":null,
      "glPostDate":null,
      "isSplit":"false",
      "addressVerification":"false",
      "memo":null,
      "statedValue":null,
      "trueValue":null,
      "thank":"false",
      "thankedDate":null,
      "isMatched":"0",
      "createdDate":"2011-10-20T00:12:02",
      "createdByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      }
   }
}

Method: update [PUT] [POST (Low REST)]

The update method will update a single contribution receipt.

Content-types ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

  • {format}
    • [PUT] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/{id}.{format}
    • [PUT] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/{id}?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [PUT] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/{id}

Required Fields ::

  • contributionreceipt/@id
  • fund/@id
  • receivedDate
  • addressVerification
  • contributiontype/@id

Sample Response ::

Given: [PUT] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/136261097

Request body:

<?xml version="1.0" encoding="utf-8"?>
<contributionReceipt>
  <accountReference></accountReference>
  <amount></amount>
  <fund id="4787">
    <name />
  </fund>
  <subFund id="">
    <name />
  </subFund>
  <pledgeDrive id="">
    <name></name>
  </pledgeDrive>
  <household id="" />
  <person id="" uri="" />
  <account id="" uri="" />
  <referenceImage id="22332185" />
  <batch>
    <name />
  </batch>
  <activityInstance />
  <contributionType id="2">
    <name>Cash</name>
  </contributionType>
  <contributionSubType>
    <name />
  </contributionSubType>
  <receivedDate>2008-08-25T00:00:00</receivedDate>
  <transmitDate></transmitDate>
  <returnDate></returnDate>
  <retransmitDate></retransmitDate>
  <glPostDate></glPostDate>
  <isSplit>false</isSplit>
  <addressVerification>false</addressVerification>
  <memo></memo>
  <statedValue></statedValue>
  <trueValue></trueValue>
  <thank>true</thank>
  <thankedDate></thankedDate>
  <isMatched>0</isMatched>
  <createdDate></createdDate>
  <createdByPerson />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson />
</contributionReceipt>

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/136261097
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 19:26:32 GMT
Content-Length: 1440

<?xml version="1.0" encoding="utf-8"?>
<contributionReceipt id="136261097" uri="https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/136261097" oldID="">
  <accountReference></accountReference>
  <amount>0.0000</amount>
  <fund id="4787" uri="https://demo.fellowshiponeapi.com/giving/v1/funds/4787">
    <name>Bible Study Classes</name>
  </fund>
  <subFund id="" uri="">
    <name />
  </subFund>
  <pledgeDrive id="" uri="">
    <name></name>
  </pledgeDrive>
  <household id="" uri="" />
  <person id="" uri="" />
  <account id="" uri="" />
  <referenceImage id="22332185" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceimages/22332185" />
  <batch id="" uri="">
    <name>Paul Johnston Test</name>
  </batch>
  <activityInstance id="" uri="" />
  <contributionType id="2" uri="https://demo.fellowshiponeapi.com/giving/v1/contributiontypes/2">
    <name>Cash</name>
  </contributionType>
  <contributionSubType id="" uri="">
    <name />
  </contributionSubType>
  <receivedDate>2008-08-25T00:00:00</receivedDate>
  <transmitDate></transmitDate>
  <returnDate></returnDate>
  <retransmitDate></retransmitDate>
  <glPostDate></glPostDate>
  <isSplit>false</isSplit>
  <addressVerification>false</addressVerification>
  <memo></memo>
  <statedValue></statedValue>
  <trueValue></trueValue>
  <thank>true</thank>
  <thankedDate></thankedDate>
  <isMatched>0</isMatched>
  <createdDate>2011-10-19T23:59:52</createdDate>
  <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
</contributionReceipt>

Given: [PUT] https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/136261097.json

Request body:

 {
   "contributionReceipt":{
      "@id":"136261097",
      "@uri":"",
      "@oldID":"",
      "accountReference":null,
      "amount":0.00,
      "fund":{
         "@id":"4787",
         "@uri":"",
         "name":null
      },
      "subFund":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "pledgeDrive":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "household":{
         "@id":"",
         "@uri":""
      },
      "person":{
         "@id":"",
         "@uri":""
      },
      "account":{
         "@id":"",
         "@uri":""
      },
      "referenceImage":{
         "@id":"",
         "@uri":""
      },
      "batch":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "activityInstance":{
         "@id":"",
         "@uri":""
      },
      "contributionType":{
         "@id":"2",
         "@uri":"",
         "name":null
      },
      "contributionSubType":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "receivedDate":"2008-08-25T00:00:00",
      "transmitDate":null,
      "returnDate":null,
      "retransmitDate":null,
      "glPostDate":null,
      "isSplit":"false",
      "addressVerification":"false",
      "memo":null,
      "statedValue":null,
      "trueValue":null,
      "thank":"false",
      "thankedDate":null,
      "isMatched":null,
      "createdDate":null,
      "createdByPerson":{
         "@id":"",
         "@uri":""
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":"",
         "@uri":""
      }
   }
}

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/136261098.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 19:18:09 GMT
Content-Length: 1091

{
   "contributionReceipt":{
      "@id":"136261098",
      "@uri":"https://demo.fellowshiponeapi.com/giving/v1/contributionreceipts/136261098",
      "@oldID":"",
      "accountReference":null,
      "amount":"0.0000",
      "fund":{
         "@id":"4787",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/funds/4787",
         "name":"Bible Study Classes"
      },
      "subFund":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "pledgeDrive":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "household":{
         "@id":"",
         "@uri":""
      },
      "person":{
         "@id":"",
         "@uri":""
      },
      "account":{
         "@id":"",
         "@uri":""
      },
      "referenceImage":{
         "@id":"",
         "@uri":""
      },
      "batch":{
         "@id":"",
         "@uri":"",
         "name":"Paul Johnston Test"
      },
      "activityInstance":{
         "@id":"",
         "@uri":""
      },
      "contributionType":{
         "@id":"2",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/contributiontypes/2",
         "name":"Cash"
      },
      "contributionSubType":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "receivedDate":"2008-08-25T00:00:00",
      "transmitDate":null,
      "returnDate":null,
      "retransmitDate":null,
      "glPostDate":null,
      "isSplit":"false",
      "addressVerification":"false",
      "memo":null,
      "statedValue":null,
      "trueValue":null,
      "thank":"false",
      "thankedDate":null,
      "isMatched":"0",
      "createdDate":"2011-10-20T00:12:02",
      "createdByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      }
   }
}