Faith Teams API Introduction
Faith Teams API is available for churches and organizations signed up with our product, as well as 3rd parties which may request authorization.
A church may use the Faith Teams Web Portal or use our Restful API. This will allow customization of your church’s experience when using our platform. You can design your own app, mobile app or integrate with your existing systems.
Authorization
To authorize, use this code:
# With shell, you can just pass the correct header with each request
curl -i -H "Accept: application/json" -H "Content-Type: application/json" -X GET --user key:secret https://api-v2.faithteams.com/[faithteams-service]
#You must replace [faithteams-service] with the correct service you wish to consume.
<?php
$username='key';
$password='secret';
$URL='https://api.faithteams.com/api/v1/[faithteams-service]';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,$URL);
curl_setopt($ch, CURLOPT_TIMEOUT, 30); //timeout after 30 seconds
curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
$result=curl_exec ($ch);
$status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE); //get status code
curl_close ($ch);
echo $status_code.' '.$result
?>
You must replace key and secret with your key/secret and [faithteams-service] with the correct service you wish to consume
Faith Teams uses an API key and secret to allow access to the API. If you are a user of our Faith Teams product, you can create one for your organization within the application on the Admin > Your Organization’s Profile Tab. If you are a third party developer, you can request one from us by mailing us at support@faithteams.com
Faith Teams requires that you pass the key and secret as a Basic Auth header for all requests to the server in a header that looks like the following:
Authorization: Basic key-base64:secret-base64
People
The Person Object
{
"personId": 3122,
"firstName": "Eddie",
"middleName": "",
"lastName": "Burns",
"birthdate": "1993-06-21",
"gender": "M",
"status": "A",
"membership": "Member",
"homeAddressStreetLine_1": "8709 Royal Ln",
"homeAddressStreetLine_2": "",
"homeAddressCity": "Lansing",
"homeAddressState": "CT",
"homeAddressZip": "44958",
"homeAddressCountry": "US",
"homePhoneNumber": "8803325278",
"mobilePhoneNumber": "1228917171",
"email": "eddie.burns@example.com",
"createdDtm": "2016-09-13 10:48:00.0",
"updatedDtm": "2020-06-14 08:40:54.0",
"doMobileNotify": "Y",
"doHomeEmailNotify": "Y",
"familyRole": "Head of Household",
"image": "https://s3-us-west-2.amazonaws.com/faithteams-demo-75/faces/3.jpg",
"custom": {
"baptized": "Yes",
"anniversary": "2017-06-17T04:00:00.000Z"
},
"customFields": [
{
"customId": 630582,
"orgId": 75,
"customType": "Boolean",
"customName": "Baptized",
"sort": 0,
"personId": 3122,
"customValue": "Yes",
"id": 53
},
{
"customId": 630583,
"orgId": 75,
"customType": "Date",
"customName": "Anniversary",
"sort": 5,
"personId": 3122,
"customValue": "2017-06-17T04:00:00.000Z",
"id": 2007
}
]
The Person object is a Person in your organization. You can create and edit a Person through the Faith Teams Portal or through the API.
Attributes
Attribute | Type | Description |
---|---|---|
personId | integer |
The id of the Person |
firstName | string |
The first name of a Person |
middleName | string |
The middle name of a Person |
lastName | string |
The last name of a Person |
birthdate | date |
The birthdate Person YYYY-MM-DD |
status | string |
The status of the Person. ‘A’ for Active, ‘I’ for Inactive |
membership | string |
The membership value of a Person |
homeAddressStreetLine_1 | string |
The street adddress of a Person |
homeAddressCity | string |
The adddress city of a Person |
homeAddressState | string |
The adddress state/province of a Person |
homeAddressZip | string |
The adddress zip/postal code of a Person |
homeAddressCountry | string |
The adddress country code of a Person |
homePhoneNumber | string |
The home phone number of a Person (non SMS) |
mobilePhoneNumber | string |
The mobile phone number of a Person (SMS capable) |
string |
The email of a Person | |
mobileNotify | string |
Flag for setting mobile notify ‘Y’ for Yes, ‘N’ for No |
emailNotify | string |
Flag for setting email notify ‘Y’ for Yes, ‘N’ for No |
familyRole | string |
The family role of a Person |
image | url |
The profile picture URL of a Person |
custom | list |
An object holding the name:value for Custom Fields for a Person |
customFields | customfields |
A list of Custom Fields for a Person |
isDefault | string
| ‘Y’ for Yes, ‘N’ for No. Only 1 Person should be set to the default person
Get People
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/people
The above command returns JSON structured like this:
{
"success": true,
"message": "People Retrieved",
"authenticated": true,
"data": [
{
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
},
{
"fundId": 2,
"name": "General Offering",
"description": "General Offering Person",
"status": "A",
"onlineStatus": "A",
"sort": 2,
"taxDeductible": "Y",
"isDefault": "N",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:46",
"updatedUser": 18
}]
}
Retrieves all People for an organization.
HTTP Request
GET https://api-v2.faithteams.com/people
Get Person
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/people/<fundId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Person Retrieved",
"authenticated": true,
"data": {
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
}
Retrieves a single Person for an organization.
HTTP Request
GET https://api-v2.faithteams.com/people/<fundId>
Create Person
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X POST https://api-v2.faithteams.com/people
The above command returns JSON structured like this:
{
"success": true,
"message": "Person Created",
"authenticated": true,
"data": {
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
}
Creates a new Person
HTTP Request
POST https://api-v2.faithteams.com/people
Parameters
Parameter | Required | Description |
---|---|---|
name | true | The name of the Person (i.e. Offering, Missions, etc.) |
description | false | A description of the person |
status | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the person is visible for contributions for internal admins |
onlineStatus | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the person is visible for online contributions |
sort | true | Integer representing the sort order of the people list |
taxDeductible | true | ‘Y’ for Yes, ‘N’ for No. |
isDefault | true | ‘Y’ for Yes, ‘N’ for No. Only 1 Person should be set to the default person |
Update Person
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X PUT https://api-v2.faithteams.com/people/<fundId>
The above command returns JSON structured like this:
{
"success": true,
"message": "People Updated",
"authenticated": true,
"data": {
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
}
Updates an existing Person
HTTP Request
PUT https://api-v2.faithteams.com/people/<fundId>
Parameters
Parameter | Required | Description |
---|---|---|
name | true | The name of the Person (i.e. Offering, Missions, etc.) |
description | false | A description of the person |
status | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the person is visible for contributions for internal admins |
onlineStatus | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the person is visible for online contributions |
sort | true | Integer representing the sort order of the people list |
taxDeductible | true | ‘Y’ for Yes, ‘N’ for No. |
isDefault | true | ‘Y’ for Yes, ‘N’ for No. Only 1 Person should be set to the default person |
Delete Person
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X DELETE https://api-v2.faithteams.com/people/<fundId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Person Deleted",
"authenticated": true,
"authorized": true
}
Deletes an existing Person
Deleting a Person which is in use fails with success: false
and message: "Person is in use"
HTTP Request
DELETE https://api-v2.faithteams.com/people/<fundId>
Custom Fields
The Custom Field Object
{
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
The Custom Field object is used to categorize Contributions into your customfields. Examples are ‘General Offering’, ‘Missions’, ‘Building’, ‘Tithing’, etc. Custom Field status for displaying internally on the Faith Teams Portal
Attributes
Attribute | Type | Description |
---|---|---|
fundId | integer |
The id of the Custom Field |
name | string |
The name of a Custom Field |
description | string |
A description of the Custom Field |
status | string |
The status of the Custom Field. ‘A’ for Active, ‘I’ for Inactive |
onlineStatus | string |
The online status of the Custom Field. ‘A’ for Active, ‘I’ for Inactive |
sort | integer |
Allows you to set the order of the customfields for display |
taxDeductible | string |
‘Y’ for Yes, ‘N’ for No. |
isDefault | string |
‘Y’ for Yes, ‘N’ for No. Only 1 Custom Field should be set to the default customfield |
Get Custom Fields
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/customfields
The above command returns JSON structured like this:
{
"success": true,
"message": "Custom Fields Retrieved",
"authenticated": true,
"data": [
{
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
},
{
"fundId": 2,
"name": "General Offering",
"description": "General Offering Custom Field",
"status": "A",
"onlineStatus": "A",
"sort": 2,
"taxDeductible": "Y",
"isDefault": "N",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:46",
"updatedUser": 18
}]
}
Retrieves all Custom Fields for an organization.
HTTP Request
GET https://api-v2.faithteams.com/customfields
Get Custom Field
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/customfields/<fundId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Custom Field Retrieved",
"authenticated": true,
"data": {
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
}
Retrieves a single Custom Field for an organization.
HTTP Request
GET https://api-v2.faithteams.com/customfields/<fundId>
Create Custom Field
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X POST https://api-v2.faithteams.com/customfields
The above command returns JSON structured like this:
{
"success": true,
"message": "Custom Field Created",
"authenticated": true,
"data": {
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
}
Creates a new Custom Field
HTTP Request
POST https://api-v2.faithteams.com/customfields
Parameters
Parameter | Required | Description |
---|---|---|
name | true | The name of the Custom Field (i.e. Offering, Missions, etc.) |
description | false | A description of the customfield |
status | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the customfield is visible for contributions for internal admins |
onlineStatus | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the customfield is visible for online contributions |
sort | true | Integer representing the sort order of the customfields list |
taxDeductible | true | ‘Y’ for Yes, ‘N’ for No. |
isDefault | true | ‘Y’ for Yes, ‘N’ for No. Only 1 Custom Field should be set to the default customfield |
Update Custom Field
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X PUT https://api-v2.faithteams.com/customfields/<fundId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Custom Fields Updated",
"authenticated": true,
"data": {
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
}
Updates an existing Custom Field
HTTP Request
PUT https://api-v2.faithteams.com/customfields/<fundId>
Parameters
Parameter | Required | Description |
---|---|---|
name | true | The name of the Custom Field (i.e. Offering, Missions, etc.) |
description | false | A description of the customfield |
status | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the customfield is visible for contributions for internal admins |
onlineStatus | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the customfield is visible for online contributions |
sort | true | Integer representing the sort order of the customfields list |
taxDeductible | true | ‘Y’ for Yes, ‘N’ for No. |
isDefault | true | ‘Y’ for Yes, ‘N’ for No. Only 1 Custom Field should be set to the default customfield |
Delete Custom Field
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X DELETE https://api-v2.faithteams.com/customfields/<fundId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Custom Field Deleted",
"authenticated": true,
"authorized": true
}
Deletes an existing Custom Field
Deleting a Custom Field which is in use fails with success: false
and message: "Custom Field is in use"
HTTP Request
DELETE https://api-v2.faithteams.com/customfields/<fundId>
Tags
The Tag Object
{
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
The Tag object is used to categorize Contributions into your tags. Examples are ‘General Offering’, ‘Missions’, ‘Building’, ‘Tithing’, etc. Tag status for displaying internally on the Faith Teams Portal
Attributes
Attribute | Type | Description |
---|---|---|
fundId | integer |
The id of the Tag |
name | string |
The name of a Tag |
description | string |
A description of the Tag |
status | string |
The status of the Tag. ‘A’ for Active, ‘I’ for Inactive |
onlineStatus | string |
The online status of the Tag. ‘A’ for Active, ‘I’ for Inactive |
sort | integer |
Allows you to set the order of the tags for display |
taxDeductible | string |
‘Y’ for Yes, ‘N’ for No. |
isDefault | string |
‘Y’ for Yes, ‘N’ for No. Only 1 Tag should be set to the default tag |
Get Tags
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/tags
The above command returns JSON structured like this:
{
"success": true,
"message": "Tags Retrieved",
"authenticated": true,
"data": [
{
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
},
{
"fundId": 2,
"name": "General Offering",
"description": "General Offering Tag",
"status": "A",
"onlineStatus": "A",
"sort": 2,
"taxDeductible": "Y",
"isDefault": "N",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:46",
"updatedUser": 18
}]
}
Retrieves all Tags for an organization.
HTTP Request
GET https://api-v2.faithteams.com/tags
Get Tag
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/tags/<fundId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Tag Retrieved",
"authenticated": true,
"data": {
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
}
Retrieves a single Tag for an organization.
HTTP Request
GET https://api-v2.faithteams.com/tags/<fundId>
Create Tag
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X POST https://api-v2.faithteams.com/tags
The above command returns JSON structured like this:
{
"success": true,
"message": "Tag Created",
"authenticated": true,
"data": {
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
}
Creates a new Tag
HTTP Request
POST https://api-v2.faithteams.com/tags
Parameters
Parameter | Required | Description |
---|---|---|
name | true | The name of the Tag (i.e. Offering, Missions, etc.) |
description | false | A description of the tag |
status | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the tag is visible for contributions for internal admins |
onlineStatus | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the tag is visible for online contributions |
sort | true | Integer representing the sort order of the tags list |
taxDeductible | true | ‘Y’ for Yes, ‘N’ for No. |
isDefault | true | ‘Y’ for Yes, ‘N’ for No. Only 1 Tag should be set to the default tag |
Update Tag
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X PUT https://api-v2.faithteams.com/tags/<fundId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Tags Updated",
"authenticated": true,
"data": {
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
}
Updates an existing Tag
HTTP Request
PUT https://api-v2.faithteams.com/tags/<fundId>
Parameters
Parameter | Required | Description |
---|---|---|
name | true | The name of the Tag (i.e. Offering, Missions, etc.) |
description | false | A description of the tag |
status | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the tag is visible for contributions for internal admins |
onlineStatus | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the tag is visible for online contributions |
sort | true | Integer representing the sort order of the tags list |
taxDeductible | true | ‘Y’ for Yes, ‘N’ for No. |
isDefault | true | ‘Y’ for Yes, ‘N’ for No. Only 1 Tag should be set to the default tag |
Delete Tag
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X DELETE https://api-v2.faithteams.com/tags/<fundId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Tag Deleted",
"authenticated": true,
"authorized": true
}
Deletes an existing Tag
Deleting a Tag which is in use fails with success: false
and message: "Tag is in use"
HTTP Request
DELETE https://api-v2.faithteams.com/tags/<fundId>
Funds
The Fund Object
{
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
The Fund object is used to categorize Contributions into your funds. Examples are ‘General Offering’, ‘Missions’, ‘Building’, ‘Tithing’, etc. Fund status for displaying internally on the Faith Teams Portal
Attributes
Attribute | Type | Description |
---|---|---|
fundId | integer |
The id of the Fund |
name | string |
The name of a Fund |
description | string |
A description of the Fund |
status | string |
The status of the Fund. ‘A’ for Active, ‘I’ for Inactive |
onlineStatus | string |
The online status of the Fund. ‘A’ for Active, ‘I’ for Inactive |
sort | integer |
Allows you to set the order of the funds for display |
taxDeductible | string |
‘Y’ for Yes, ‘N’ for No. |
isDefault | string |
‘Y’ for Yes, ‘N’ for No. Only 1 Fund should be set to the default fund |
Get Funds
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/funds
The above command returns JSON structured like this:
{
"success": true,
"message": "Funds Retrieved",
"authenticated": true,
"data": [
{
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
},
{
"fundId": 2,
"name": "General Offering",
"description": "General Offering Fund",
"status": "A",
"onlineStatus": "A",
"sort": 2,
"taxDeductible": "Y",
"isDefault": "N",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:46",
"updatedUser": 18
}]
}
Retrieves all Funds for an organization.
HTTP Request
GET https://api-v2.faithteams.com/funds
Get Fund
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/funds/<fundId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Fund Retrieved",
"authenticated": true,
"data": {
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
}
Retrieves a single Fund for an organization.
HTTP Request
GET https://api-v2.faithteams.com/funds/<fundId>
Create Fund
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X POST https://api-v2.faithteams.com/funds
The above command returns JSON structured like this:
{
"success": true,
"message": "Fund Created",
"authenticated": true,
"data": {
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
}
Creates a new Fund
HTTP Request
POST https://api-v2.faithteams.com/funds
Parameters
Parameter | Required | Description |
---|---|---|
name | true | The name of the Fund (i.e. Offering, Missions, etc.) |
description | false | A description of the fund |
status | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the fund is visible for contributions for internal admins |
onlineStatus | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the fund is visible for online contributions |
sort | true | Integer representing the sort order of the funds list |
taxDeductible | true | ‘Y’ for Yes, ‘N’ for No. |
isDefault | true | ‘Y’ for Yes, ‘N’ for No. Only 1 Fund should be set to the default fund |
Update Fund
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X PUT https://api-v2.faithteams.com/funds/<fundId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Funds Updated",
"authenticated": true,
"data": {
"fundId": 1,
"name": "Tithes",
"description": "Tithes",
"status": "A",
"onlineStatus": "A",
"sort": 1,
"taxDeductible": "Y",
"isDefault": "Y",
"createdDtm": "2020-07-16 10:00:00",
"createdUser": 18,
"updatedDtm": "2020-07-16 01:51:51",
"updatedUser": 18
}
}
Updates an existing Fund
HTTP Request
PUT https://api-v2.faithteams.com/funds/<fundId>
Parameters
Parameter | Required | Description |
---|---|---|
name | true | The name of the Fund (i.e. Offering, Missions, etc.) |
description | false | A description of the fund |
status | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the fund is visible for contributions for internal admins |
onlineStatus | true | ‘A’ for Active. ‘I’ for Inactive. Sets whether the fund is visible for online contributions |
sort | true | Integer representing the sort order of the funds list |
taxDeductible | true | ‘Y’ for Yes, ‘N’ for No. |
isDefault | true | ‘Y’ for Yes, ‘N’ for No. Only 1 Fund should be set to the default fund |
Delete Fund
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X DELETE https://api-v2.faithteams.com/funds/<fundId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Fund Deleted",
"authenticated": true,
"authorized": true
}
Deletes an existing Fund
Deleting a Fund which is in use fails with success: false
and message: "Fund is in use"
HTTP Request
DELETE https://api-v2.faithteams.com/funds/<fundId>
Contribution Types
The Contribution Type Object
{
"contributionTypeId": 200,
"name": "Cash",
"description": "Cash",
"status": "A",
"createdDtm": "2020-07-17 10:00:00",
"createdUser": 0,
"updatedDtm": "2020-07-17 10:00:00",
"updatedUser": 0
}
The Contribution Type object represents the type of contribution such as Cash, Check, Faith Teams or other types. This is not editable through the Faith Teams Web Portal but you can make changes through the API.
Several Contribution Types are shared across the entire platform (Faith Teams, Tithely, Stripe) and cannot be edited.
By default, Cash and Check are added for your organization.
Attributes
Attribute | Type | Description |
---|---|---|
contributionTypeId | integer |
The id of the Contribution Type |
name | string |
The name of the Contribution Type |
description | string |
The description of the Contribution Type |
status | string |
The status of the Contribution Type. ‘A’ Active, ‘I’ for Inactive |
createdDtm | datetime |
The date/time record creation |
createdUser | integer |
The userkey of the record creation |
updatedDtm | datetime |
The date/time record last update |
updatedUser | integer |
The userkey of the record last update |
Get Contribution Types
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/contributiontypes
The above command returns JSON structured like this:
{
"success": true,
"message": "Contribution Types Retrieved",
"data": [
{
"contributionTypeId": 200,
"name": "Cash",
"description": "Cash",
"status": "A",
"createdDtm": "2016-07-17 10:00:00",
"createdUser": 0,
"updatedDtm": "2016-07-17 10:00:00",
"updatedUser": 0
},
...
],
"authenticated": true,
"authorized": true
}
Retrieves all Contribution Types for an organization.
HTTP Request
GET https://api-v2.faithteams.com/contributiontypes
Get Contribution Type
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/contributiontypes/<contributionTypeId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Contribution Type Retrieved",
"data": {
"contributionTypeId": 200,
"name": "Cash",
"description": "Cash",
"status": "A",
"createdDtm": "2016-07-17 10:00:00",
"createdUser": 0,
"updatedDtm": "2016-07-17 10:00:00",
"updatedUser": 0
},
"authenticated": true,
"authorized": true
}
Retrieves a single Contribution Type for an organization.
HTTP Request
GET https://api-v2.faithteams.com/contributiontypes/<contributionTypeId>
Create Contribution Type
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X POST https://api-v2.faithteams.com/contributiontypes
The above command returns JSON structured like this:
{
"success": true,
"message": "Contribution Type Created",
"data": {
"contributionTypeId": 4789,
"name": "Bitcoin",
"description": "Bitcoin",
"status": "A",
"createdDtm": "2020-06-12 12:17:15",
"createdUser": 18,
"updatedDtm": "2020-06-12 12:17:15",
"updatedUser": 18
},
"authenticated": true,
"authorized": true
}
Creates a new Contribution Type
HTTP Request
POST https://api-v2.faithteams.com/contributiontypes
Parameters
Parameter | Required | Description |
---|---|---|
name | true | The name of the Contribution Type |
description | false | A description for the Contribution Type |
status | true | The status of the Contribution Type. ‘A’ for Active, ‘I’ for Inactive |
Update Contribution Type
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X PUT https://api-v2.faithteams.com/contributiontytpes/<contributionTypeId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Contribution Type Created",
"data": {
"contributionTypeId": 4789,
"name": "Gitcoin",
"description": "Gitcoin",
"status": "A",
"createdDtm": "2020-06-12 12:17:15",
"createdUser": 18,
"updatedDtm": "2020-06-12 12:17:15",
"updatedUser": 18
},
"authenticated": true,
"authorized": true
}
Updates an existing Contribution Type
HTTP Request
PUT https://api-v2.faithteams.com/contributiontytpes/<contributionTypeId>
Parameters
Parameter | Required | Description |
---|---|---|
name | true | The name of the Contribution Type |
description | false | A description for the Contribution Type |
status | true | The status of the Contribution Type. ‘A’ for Active, ‘I’ for Inactive |
Delete Contribution Type
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X DELETE https://api-v2.faithteams.com/contributiontytpes/<contributionTypeId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Contribution Type Deleted",
"authenticated": true,
"authorized": true
}
Deletes an existing Contribution Type
Deleting a Contribution Type which is in use fails with success: false
and message: "Contribution Type is in use"
HTTP Request
DELETE https://api-v2.faithteams.com/contributiontytpes/<contributionTypeId>
Batches
The Batch Object
{
"batchId": 39252,
"orgId": 1500,
"status": "O",
"serviceId": 35000,
"title": "Worship Service",
"dtm": "2020-01-05 11:00:00",
"updatedDtm": "2020-01-21 03:01:39",
"updatedUser": 18,
"contributions": [{
"contributionId": 1029955,
"parentId": 1029955,
"recordType": "H",
"personId": 24000,
"personId2": 0,
"batchId": 39252,
"sortIndex": 0,
"amount": 43.00,
"fee": 0.00,
"netAmount": 43.00,
"contributionTypeId": 1,
"fundId": 0,
"status": "A",
"onlineContributionId": -1,
"note": "",
"createdDtm": "2020-01-05 17:39:50",
"createdUser": 0,
"updatedDtm": "2020-01-05 17:39:50",
"updatedUser": 0
},
...
]
}
The batch object is used to group Contributions to your church. It represents a logical group of donations like a Sunday Offering. It includes the date, time, title of the event and will contain 1 or more Contributions (donations).
Attributes
Attribute | Type | Description |
---|---|---|
batchId | integer |
The id of the batch |
title | string |
The title of a batch |
description | string |
A description of the batch |
status | string |
The status of the batch. ‘O’ for Open, ‘C’ for Closed |
dtm | datetime |
The date/time of the donation (service, etc.) YYYY-MM-DD HH:MM:SS |
serviceId | integer |
The id of the event (can be 0 or null) |
contributions | Contribution |
A list of Contributions |
Get Batches
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/batches?sort=dtm
The above command returns JSON structured like this:
{
"success": true,
"message": "Batches Retrieved",
"authenticated": true,
"data": [{
"batchId": 10000,
"orgId": 1500,
"status": "O",
"serviceId": 45,
"title": "Sunday Offering",
"info": "Sunday/Wednesday Offering",
"dtm": "2020-06-21 09:00:00",
"updatedDtm": "2020-06-21 15:10:00",
"updatedUser": 18
}, {
"batchId": 10001,
"orgId": 1500,
"status": "O",
"serviceId": 40,
"title": "Online Offering",
"info": "",
"dtm": "2020-06-23 09:00:00",
"updatedDtm": "2020-06-23 15:10:00",
"updatedUser": 0
}]
}
Retrieves all batches for an organization.
HTTP Request
GET https://api-v2.faithteams.com/batches
Parameters
Parameter | Required | Description |
---|---|---|
sort | true | The field to sort by (batchId, title, status, dtm, updatedDtm) |
sortDirection | false | The direction of sort of a batch ‘asc’ or ‘desc’ |
status | false | The status of the batch. ‘O’ for Open, ‘C’ for Closed |
title | false | The title of a batch. |
dtm | false | The year or year/month of a batch in YYYY or YYYY-MM format |
description | false | A description of the batch |
limit | false | For paging, the size of records to return |
start | false | For paging, what record to start on. Should be a factor of limit |
batchIds | false | A comma-separated list of batches: 15000,15051,15092 |
Get Batch
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/batches/{batchId}
The above command returns JSON structured like this:
{
"success": true,
"message": "Batch Retrieved",
"data": {
"batchId": 39252,
"orgId": 1500,
"status": "O",
"serviceId": 35000,
"title": "Worship Service",
"dtm": "2020-01-05 11:00:00",
"updatedDtm": "2020-01-21 03:01:39",
"updatedUser": 18,
"contributions": [{
"contributionId": 1029955,
"parentId": 1029955,
"recordType": "H",
"personId": 24000,
"personId2": 0,
"batchId": 39252,
"sortIndex": 0,
"amount": 43.00,
"fee": 0.00,
"netAmount": 43.00,
"contributionTypeId": 1,
"fundId": 0,
"status": "A",
"onlineContributionId": -1,
"note": "",
"createdDtm": "2020-01-05 17:39:50",
"createdUser": 0,
"updatedDtm": "2020-01-05 17:39:50",
"updatedUser": 0
},
...
]
},
"authenticated": true,
"authorized": true
}
Retrieves all batches for an organization.
HTTP Request
GET https://api-v2.faithteams.com/batches/{batchId}
Create Batch
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X POST https://api-v2.faithteams.com/batches
The above command returns JSON structured like this:
{
"success": true,
"message": "Batch Created",
"authenticated": true,
"data": {
"batchId": 10000,
"orgId": 1500,
"status": "O",
"serviceId": 45,
"title": "Sunday Offering",
"info": "Sunday/Wednesday Offering",
"dtm": "2020-06-21 09:00:00",
"updatedDtm": "2020-06-21 15:10:00",
"updatedUser": 18
}
}
Creates a new Batch
HTTP Request
POST https://api-v2.faithteams.com/batches
Parameters
Parameter | Required | Description |
---|---|---|
title | true | The title of a batch |
info | false | An info line for the batch |
status | true | The status of the batch. ‘O’ for Open, ‘C’ for Closed |
dtm | true | The date/time of the donation (service, etc.) in the format YYYY-MM-DD HH:MM:SS |
Update Batch
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X PUT https://api-v2.faithteams.com/batches/{batchId}
The above command returns JSON structured like this:
{
"success": true,
"message": "Batch Updated",
"authenticated": true,
"data": {
"batchId": 10000,
"orgId": 1500,
"status": "O",
"serviceId": 45,
"title": "Sunday Offering",
"info": "Sunday/Wednesday Offering",
"dtm": "2020-06-21 09:00:00",
"updatedDtm": "2020-06-21 15:10:00",
"updatedUser": 18
}
}
Updates a new Batch
HTTP Request
PUT https://api-v2.faithteams.com/batches/{batchId}
Parameters
Parameters
Parameter | Required | Description |
---|---|---|
title | true | The title of a batch |
info | false | An info line for the batch |
status | true | The status of the batch. ‘O’ for Open, ‘C’ for Closed |
dtm | true | The date/time of the donation (service, etc.) in the format YYYY-MM-DD HH:MM:SS |
Delete Batch
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X DELETE https://api-v2.faithteams.com/batches/<batchId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Batch Deleted",
"authenticated": true,
"authorized": true
}
Deletes an existing Batch
Deleting a Batch is a soft-delete. The records still exist, but the following updates are made on the records which prevents them from showing on in the app or in reports:
"status" : "D"
on the Batch"status" : "D"
on the Contributions within the Batch
HTTP Request
DELETE https://api-v2.faithteams.com/batches/<batchId>
Contributions
The Contribution Object
Example Contribution object - Note it is an array of at least 2 records
[{
"contributionId": 1811649,
"parentId": 1811649,
"recordType": "H",
"personId": 18,
"personId2": -98,
"batchId": 62419,
"sortIndex": 0,
"amount": 10,
"fee": 0.00,
"netAmount": 10,
"contributionTypeId": 2,
"fundId": 0,
"checkNumber": "123",
"status": "A",
"note": "test",
"createdDtm": "2020-06-12 17:49:51",
"createdUser": 18,
"updatedDtm": "2020-06-12 17:49:51",
"updatedUser": 18
}, {
"contributionId": 1811650,
"parentId": 1811649,
"recordType": "D",
"personId": 18,
"personId2": -98,
"batchId": 62419,
"sortIndex": 1,
"amount": 10.00,
"fee": 0.00,
"netAmount": 10.00,
"contributionTypeId": 2,
"fundId": 1,
"status": "A",
"createdDtm": "2020-06-12 17:49:51",
"createdUser": 18,
"updatedDtm": "2020-06-12 17:49:51",
"updatedUser": 18
}]
}
The contribution object is represents a donation to your organization. It is a list of at least 2 records including a Header "recordType": "H"
and 1 or more Detail records "recordType": "D"
.
The parentId
is the overall identier for the entire list of records. The parentId
is carried on every record, and is how a Contribution is retrieved when doing a Get Contribution
When performing an Update Contribution, all prior records in the list are set to "status" : "T"
(for termed). The new values are added to the list with a "status" : "A"
(for active). In this way, an audit trail version is maintained for all Contributions. Only active contributions are shown in the Faith Teams Web Portal and in reports.
Attributes
Attribute | Type | Description |
---|---|---|
contributionId | integer |
The id of the contribution |
title | string |
The title of a contribution |
description | string |
A description of the contribution |
status | string |
The status of the contribution. ‘O’ for Open, ‘C’ for Closed |
dtm | datetime |
The date/time of the donation (service, etc.) YYYY-MM-DD HH:MM:SS |
serviceId | integer |
The id of the event (can be 0 or null) |
contributions | Contribution |
A list of Contributions |
Get Contributions
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/contributions?sort=dtm
The above command returns JSON structured like this:
{
"success": true,
"message": "Contributions Retrieved",
"authenticated": true,
"data": [{
"contributionId": 10000,
"orgId": 1500,
"status": "O",
"serviceId": 45,
"title": "Sunday Offering",
"info": "Sunday/Wednesday Offering",
"dtm": "2020-06-21 09:00:00",
"updatedDtm": "2020-06-21 15:10:00",
"updatedUser": 18
}, {
"contributionId": 10001,
"orgId": 1500,
"status": "O",
"serviceId": 40,
"title": "Online Offering",
"info": "",
"dtm": "2020-06-23 09:00:00",
"updatedDtm": "2020-06-23 15:10:00",
"updatedUser": 0
}]
}
Retrieves/Searches Contributions for an organization.
HTTP Request
GET https://api-v2.faithteams.com/contributions
Parameters
Parameter | Required | Description |
---|---|---|
sort | true | The field to sort by (contributionId, title, status, dtm, updatedDtm) |
sortDirection | false | The direction of sort of a contribution ‘asc’ or ‘desc’ |
status | false | The status of the contribution. ‘O’ for Open, ‘C’ for Closed |
title | false | The title of a contribution. |
dtm | false | The year or year/month of a contribution in YYYY or YYYY-MM format |
description | false | A description of the contribution |
limit | false | For paging, the size of records to return |
start | false | For paging, what record to start on. Should be a factor of limit |
batchIds | false | A comma-separated list of contributions: 15000,15051,15092 |
Get Contribution
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/contributions/<parentId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Contribution Retrieved",
"data": {
"contributionId": 39252,
"orgId": 1500,
"status": "O",
"serviceId": 35000,
"title": "Worship Service",
"dtm": "2020-01-05 11:00:00",
"updatedDtm": "2020-01-21 03:01:39",
"updatedUser": 18,
"contributions": [{
"contributionId": 1029955,
"parentId": 1029955,
"recordType": "H",
"personId": 24000,
"personId2": 0,
"contributionId": 39252,
"sortIndex": 0,
"amount": 43.00,
"fee": 0.00,
"netAmount": 43.00,
"contributionTypeId": 1,
"fundId": 0,
"status": "A",
"onlineContributionId": -1,
"note": "",
"createdDtm": "2020-01-05 17:39:50",
"createdUser": 0,
"updatedDtm": "2020-01-05 17:39:50",
"updatedUser": 0
},
...
]
},
"authenticated": true,
"authorized": true
}
Retrieves a Contribution by parentId
HTTP Request
GET https://api-v2.faithteams.com/contributions/<parentId>
Create Contribution
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X POST https://api-v2.faithteams.com/contributions
Example Create Contribution request
[{
"amount": 10,
"contributionTypeId": 2,
"checkNumber": "123",
"note": "test",
"batchId": "62419",
"fee": "0.00",
"netAmount": 10,
"recordType": "H",
"personId": 18
}, {
"batchId": "62419",
"personId": 18,
"amount": "10.00",
"fee": "0.00",
"netAmount": "10.00",
"fundId": 1,
"recordType": "D"
}]
Example Create Contribution Response:
{
"success": true,
"message": "Contribution Created",
"data": [{
"contributionId": 1811649,
"parentId": 1811649,
"recordType": "H",
"personId": 18,
"personId2": -98,
"batchId": 62419,
"sortIndex": 0,
"amount": 10,
"fee": 0.00,
"netAmount": 10,
"contributionTypeId": 2,
"fundId": 0,
"checkNumber": "123",
"status": "A",
"note": "test",
"createdDtm": "2020-06-12 17:49:51",
"createdUser": 18,
"updatedDtm": "2020-06-12 17:49:51",
"updatedUser": 18
}, {
"contributionId": 1811650,
"parentId": 1811649,
"recordType": "D",
"personId": 18,
"personId2": -98,
"batchId": 62419,
"sortIndex": 1,
"amount": 10.00,
"fee": 0.00,
"netAmount": 10.00,
"contributionTypeId": 2,
"fundId": 1,
"status": "A",
"createdDtm": "2020-06-12 17:49:51",
"createdUser": 18,
"updatedDtm": "2020-06-12 17:49:51",
"updatedUser": 18
}],
"authenticated": true,
"authorized": true
}
Creates a new Contribution
HTTP Request
POST https://api-v2.faithteams.com/contributions
Header Record
- A Header Record which must include the following
"batchId" : integer
validbatchId
from Batch"recordType" : "H"
"contributionTypeId" : integer
validcontributionTypeId
from Contribution Type"personId" : integer
validpersonId
from Person"amount" : currency
valid amount in XX.XX format"fee" : currency
valid amount in XX.XX format"netAmount" : currency
valid amount in XX.XX format
Detail Record(s)
- 1 or More Detail Records which must include the following
"batchId" : integer
validbatchId
from Batch"recordType" : "D"
"contributionTypeId" : integer
validcontributionTypeId
from Contribution Type"fundId" : integer
validfundId
from Fund"personId" : integer
validpersonId
from Person"amount" : currency
valid amount in XX.XX format"fee" : currency
valid amount in XX.XX format"netAmount" : currency
valid amount in XX.XX format
Parameters
Parameter | Required | Description |
---|---|---|
title | true | The title of a contribution |
info | false | An info line for the contribution |
status | true | The status of the contribution. ‘O’ for Open, ‘C’ for Closed |
dtm | true | The date/time of the donation (service, etc.) in the format YYYY-MM-DD HH:MM:SS |
Update Contribution
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X POST https://api-v2.faithteams.com/contributions/<parentId>
Example Create Contribution request
[{
"amount": 10,
"contributionTypeId": 2,
"checkNumber": "123",
"note": "test",
"batchId": "62419",
"fee": "0.00",
"netAmount": 10,
"recordType": "H",
"personId": 18
}, {
"batchId": "62419",
"personId": 18,
"amount": "10.00",
"fee": "0.00",
"netAmount": "10.00",
"fundId": 1,
"recordType": "D"
}]
Example Create Contribution Response:
{
"success": true,
"message": "Contribution Created",
"data": [{
"contributionId": 1811649,
"parentId": 1811649,
"recordType": "H",
"personId": 18,
"personId2": -98,
"batchId": 62419,
"sortIndex": 0,
"amount": 10,
"fee": 0.00,
"netAmount": 10,
"contributionTypeId": 2,
"fundId": 0,
"checkNumber": "123",
"status": "A",
"note": "test",
"createdDtm": "2020-06-12 17:49:51",
"createdUser": 18,
"updatedDtm": "2020-06-12 17:49:51",
"updatedUser": 18
}, {
"contributionId": 1811650,
"parentId": 1811649,
"recordType": "D",
"personId": 18,
"personId2": -98,
"batchId": 62419,
"sortIndex": 1,
"amount": 10.00,
"fee": 0.00,
"netAmount": 10.00,
"contributionTypeId": 2,
"fundId": 1,
"status": "A",
"createdDtm": "2020-06-12 17:49:51",
"createdUser": 18,
"updatedDtm": "2020-06-12 17:49:51",
"updatedUser": 18
}],
"authenticated": true,
"authorized": true
}
Updates an existing Contribution
HTTP Request
PUT https://api-v2.faithteams.com/contributions/<parentId>
Header Record
- A Header Record which must include the following
"batchId" : integer
validbatchId
from Batch"recordType" : "H"
"contributionTypeId" : integer
validcontributionTypeId
from Contribution Type"personId" : integer
validpersonId
from Person"amount" : currency
valid amount in XX.XX format"fee" : currency
valid amount in XX.XX format"netAmount" : currency
valid amount in XX.XX format
Detail Record(s)
- 1 or More Detail Records which must include the following
"batchId" : integer
validbatchId
from Batch"recordType" : "D"
"contributionTypeId" : integer
validcontributionTypeId
from Contribution Type"fundId" : integer
validfundId
from Fund"personId" : integer
validpersonId
from Person"amount" : currency
valid amount in XX.XX format"fee" : currency
valid amount in XX.XX format"netAmount" : currency
valid amount in XX.XX format
Parameters
Parameter | Required | Description |
---|---|---|
title | true | The title of a contribution |
info | false | An info line for the contribution |
status | true | The status of the contribution. ‘O’ for Open, ‘C’ for Closed |
dtm | true | The date/time of the donation (service, etc.) in the format YYYY-MM-DD HH:MM:SS |
Assignments
The Assignment Object
{
"assignmentId": 1,
"assignmentTypeId": 1,
"assignedPersonId": 25000,
"recipientPersonId": 25001,
"title": "New Assignment",
"details": "text",
"notes": "text",
"assignDtm": "2020-07-16 10:00:00",
"dueDtm": "2020-07-16 10:00:00",
"status": "O",
"uuid": "d9e592a5-5d42-11ef-ac84-0a5efbc0ff04"
}
The Assignment object is used to categorize Contributions into your assignments. Examples are ‘General Offering’, ‘Missions’, ‘Building’, ‘Tithing’, etc. Assignment status for displaying internally on the Faith Teams Portal
Attributes
Attribute | Type | Description |
---|---|---|
assignmentId | integer |
The id of the Assignment |
assignmentTypeId | integer |
The id of the AssignmentType category |
assignedPersonId | integer |
The id of the Person to whom the assignment is assigned |
recipientPersonId | integer |
The id of the Person the assignment is about |
title | string |
The title of a Assignment |
details | string |
The details of the Assignment |
notes | string |
The notes of the Assignment |
assignDtm | datetime |
The assign date/time of the Assignment |
dueDtm | datetime |
The due date date/time of the Assignment |
status | string |
The statues Assignment ‘O’ or Open, ‘C’ for closed |
uuid | string |
The unique uuid of the Assignment |
Get Assignments
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/assignments
The above command returns JSON structured like this:
{
"success": true,
"message": "Assignments Retrieved",
"authenticated": true,
"data": [
{
"assignmentId": 1,
"assignmentTypeId": 1,
"assignedPersonId": 25000,
"recipientPersonId": 25001,
"title": "New Assignment",
"details": "text",
"notes": "text",
"assignDtm": "2020-07-16 10:00:00",
"dueDtm": "2020-07-16 10:00:00",
"status": "O",
"uuid": "d9e592a5-5d42-11ef-ac84-0a5efbc0ff04"
},
{
"assignmentId": 2,
"assignmentTypeId": 1,
"assignedPersonId": 25000,
"recipientPersonId": 25001,
"title": "Another Assignment",
"details": "text",
"notes": "text",
"assignDtm": "2020-07-16 10:00:00",
"dueDtm": "2020-07-16 10:00:00",
"status": "O",
"uuid": "d9e592a5-5d42-11ef-ac84-0a5efbc0ff04"
}]
}
Retrieves all Assignments for an organization.
HTTP Request
GET https://api-v2.faithteams.com/assignments
Parameters
Parameter | Required | Description |
---|---|---|
status | false | The statues Assignment ‘O’ or Open, ‘C’ for closed |
Get Assignment
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/assignments/<assignmentId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Assignment Retrieved",
"authenticated": true,
"data": {
"assignmentId": 1,
"assignmentTypeId": 1,
"assignedPersonId": 25000,
"recipientPersonId": 25001,
"title": "New Assignment",
"details": "text",
"notes": "text",
"assignDtm": "2020-07-16 10:00:00",
"dueDtm": "2020-07-16 10:00:00",
"status": "O",
"uuid": "d9e592a5-5d42-11ef-ac84-0a5efbc0ff04"
}
}
Retrieves a single Assignment for an organization.
HTTP Request
GET https://api-v2.faithteams.com/assignments/<assignmentId>
Create Assignment
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X POST https://api-v2.faithteams.com/assignments
The above command returns JSON structured like this:
{
"success": true,
"message": "Assignment Created",
"authenticated": true,
"data": {
"assignmentId": 1,
"assignmentTypeId": 1,
"assignedPersonId": 25000,
"recipientPersonId": 25001,
"title": "New Assignment",
"details": "text",
"notes": "text",
"assignDtm": "2020-07-16 10:00:00",
"dueDtm": "2020-07-16 10:00:00",
"status": "O",
"uuid": "d9e592a5-5d42-11ef-ac84-0a5efbc0ff04"
}
}
Creates a new Assignment
HTTP Request
POST https://api-v2.faithteams.com/assignments
Parameters
Parameter | Type | Description |
---|---|---|
assignmentTypeId | true | The id of the AssignmentType category |
assignedPersonId | true | The id of the Person to whom the assignment is assigned |
recipientPersonId | true | The id of the Person the assignment is about |
title | true | The title of a Assignment |
details | true | The details of the Assignment |
notes | true | The notes of the Assignment |
dueDtm | true | The due date date/time of the Assignment |
status | true | The statues Assignment ‘O’ or Open, ‘C’ for closed |
Update Assignment
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X PUT https://api-v2.faithteams.com/assignments/<assignmentId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Assignments Updated",
"authenticated": true,
"data": {
"assignmentId": 1,
"assignmentTypeId": 1,
"assignedPersonId": 25000,
"recipientPersonId": 25001,
"title": "New Assignment",
"details": "text",
"notes": "text",
"assignDtm": "2020-07-16 10:00:00",
"dueDtm": "2020-07-16 10:00:00",
"status": "O",
"uuid": "d9e592a5-5d42-11ef-ac84-0a5efbc0ff04"
}
}
Updates an existing Assignment
HTTP Request
PUT https://api-v2.faithteams.com/assignments/<assignmentId>
Parameters
Parameter | Type | Description |
---|---|---|
assignmentTypeId | true | The id of the AssignmentType category |
assignedPersonId | true | The id of the Person to whom the assignment is assigned |
recipientPersonId | true | The id of the Person the assignment is about |
title | true | The title of a Assignment |
details | true | The details of the Assignment |
notes | true | The notes of the Assignment |
dueDtm | true | The due date date/time of the Assignment |
status | true | The statues Assignment ‘O’ or Open, ‘C’ for closed |
Delete Assignment
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X DELETE https://api-v2.faithteams.com/assignments/<assignmentId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Assignment Deleted",
"authenticated": true,
"authorized": true
}
Deletes an existing Assignment
Deleting a Assignment which is in use fails with success: false
and message: "Assignment is in use"
HTTP Request
DELETE https://api-v2.faithteams.com/assignments/<assignmentId>
Assignment Types
The Assignment Type Object
{
"assignmentTypeId": 1,
"title": "Guest Phone Call",
"description": "Make a Phone Call to Guest",
"status": "A"
}
The Assignment Type object is used to categorize Assignments. Examples are ‘Guest Phone Call’, ‘Hospital Visit’, ‘Send Birthday Card’ and other assignments type categories.
Attributes
Attribute | Type | Description |
---|---|---|
assignmentTypeId | integer |
The id of the Assignment Type |
title | string |
The title of the Assignment Type |
description | string |
The description the Assignment Type |
status | string |
The status of the Assignment Type |
Get Assignment Types
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/assignmenttypes
The above command returns JSON structured like this:
{
"success": true,
"message": "Assignment Types Retrieved",
"authenticated": true,
"data": [
{
"assignmentTypeId": 1,
"title": "Guest Phone Call",
"description": "Make a Phone Call to Guest",
"status": "A"
},
{
"assignmentTypeId": 2,
"title": "Hospital Visit",
"description": "Make a visit to see someone in the hospital",
"status": "A"
}]
}
Retrieves all Assignment Types for an organization.
HTTP Request
GET https://api-v2.faithteams.com/assignmenttypes
Get Assignment Type
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X GET https://api-v2.faithteams.com/assignmenttypes/<assignmentTypeId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Assignment Type Retrieved",
"authenticated": true,
"data": {
"assignmentTypeId": 1,
"title": "Guest Phone Call",
"description": "Make a Phone Call to Guest",
"status": "A"
}
}
Retrieves a single Assignment Type for an organization.
HTTP Request
GET https://api-v2.faithteams.com/assignmenttypes/<assignmentTypeId>
Create Assignment Type
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X POST https://api-v2.faithteams.com/assignmenttypes
The above command returns JSON structured like this:
{
"assignmentTypeId": 1,
"title": "Guest Phone Call",
"description": "Make a Phone Call to Guest",
"status": "A"
}
Creates a new Assignment Type
HTTP Request
POST https://api-v2.faithteams.com/assignmenttypes
Parameters
Parameter | Required | Description |
---|---|---|
title | true | The title of the Assignment Type |
description | false | The description the Assignment Type |
status | true | The status of the Assignment Type ‘A’ for active, ‘I’ for inactive |
Update Assignment Type
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X PUT https://api-v2.faithteams.com/assignmenttypes/<assignmentTypeId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Assignment Types Updated",
"authenticated": true,
"data": {
"assignmentTypeId": 1,
"title": "Guest Phone Call",
"description": "Make a Phone Call to Guest",
"status": "A"
}
}
Updates an existing Assignment Type
HTTP Request
PUT https://api-v2.faithteams.com/assignmenttypes/<assignmentTypeId>
Parameters
Parameter | Required | Description |
---|---|---|
title | true | The title of the Assignment Type |
description | false | The description the Assignment Type |
status | true | The status of the Assignment Type ‘A’ for active, ‘I’ for inactive |
Delete Assignment Type
curl -H "token: auth-token" -H "Accept: application/json" -H "Content-Type: application/json"
-X DELETE https://api-v2.faithteams.com/assignmenttypes/<assignmentTypeId>
The above command returns JSON structured like this:
{
"success": true,
"message": "Assignment Type Deleted",
"authenticated": true,
"authorized": true
}
Deletes an existing Assignment Type
Deleting a Assignment Type which is in use fails with success: false
and message: "Assignment Type is in use"
HTTP Request
DELETE https://api-v2.faithteams.com/assignmenttypes/<assignmentTypeId>
Errors
The Faith Teams API uses the following error codes:
Error Code | Meaning |
---|---|
400 | Bad Request – Your request is bad. Make sure to check the documentation. |
401 | Unauthorized – Your API key and/or is wrong |
403 | Forbidden – The request is hidden |
404 | Not Found – The specified record could not be found |
405 | Method Not Allowed – This method not allowed |
406 | Not Acceptable – You requested a format that isn’t json |
410 | Gone – The record requested has been removed from our servers |
429 | Too Many Requests – You’re requesting too many requests. Plesase slow down. |
500 | Internal Server Error – We had a problem with our server. Try again later. |
503 | Service Unavailable – We’re temporarily offline for maintenance. Please try again later. |