HTTP Method: GET
URL: https://www.aplos.com/hermes/api/v1/individual_contributions
Parameters:
Headers:
Example JSON:
{
"version": "v2_0_1",
"status": 200,
"meta": {
"available_filters": {
"f_contact": "Contact ID",
"f_contactname": "Any part of any contact name (first, last, and/or company), case insensitive",
"f_lastupdated": "Last updated (created or modified). Format: yyyy-MM-ddTHH:mm:ss.SSSZ",
"f_rangeend": "Maximum date range (inclusive). Format: yyyy-MM-dd",
"f_rangestart": "Minimum date range (inclusive). Format: yyyy-MM-dd"
},
"resource_count": 1
},
"links": {
"self": "/api/v1/individual_contributions?page_size=50&page_num=1"
},
"data": {
"contributions": [
{
"id": 1,
"contact": {
"id": 1,
"firstname": "Aplos",
"lastname": "Donor"
},
"date": "2019-12-31",
"purpose": {
"id": 1,
"name": "General"
},
"note": "Example contribution",
"amount": 123.45,
"is_ntd": false,
"expense_amount": 12.34
}
]
}
}
HTTP Method: GET
URL: https://www.aplos.com/hermes/api/v1/individual_contributions/:contributionId
Parameters:
Headers:
Example JSON:
{
"version": "v2_0_1",
"status": 200,
"meta": {
"resource_count": 1
},
"links": {
"self": "/api/v1/individual_contributions/1"
},
"data": {
"contribution": {
"id": 1,
"contact": {
"id": 1,
"firstname": "Aplos",
"lastname": "Donor"
},
"date": "2019-12-31",
"purpose": {
"id": 1,
"name": "General"
},
"note": "Example contribution",
"amount": 123.45,
"is_ntd": false,
"expense_amount": 12.34
}
}
}
HTTP Method: POST
URL: https://www.aplos.com/hermes/api/v1/individual_contributions
Parameters:
Headers:
Example JSON Body:
{
"contact": {
"id": 1,
"firstname": "Aplos",
"lastname": "Donor"
},
"date": "2019-12-31",
"purpose": {
"id": 1,
"name": "General"
},
"note": "Example contribution",
"amount": 123.45,
"is_ntd": false,
"expense_amount": 12.34
}
Example JSON Response:
{
"version": "v2_0_1",
"message": "posted: 1",
"status": 200,
"meta": {
"resource_count": 1
},
"links": {
"self": "/api/v1/individual_contributions/1"
},
"data": {
"contribution": {
"id": 1,
"contact": {
"id": 1,
"firstname": "Aplos",
"lastname": "Donor"
},
"date": "2019-12-31",
"purpose": {
"id": 1,
"name": "General"
},
"note": "Example contribution",
"amount": 123.45,
"is_ntd": false,
"expense_amount": 12.34
}
}
HTTP Method: PUT
URL: https://www.aplos.com/hermes/api/v1/individual_contributions/:contributionId
Parameters:
Headers:
Example JSON Body:
{
"id": 1,
"contact": {
"id": 1,
"firstname": "Aplos",
"lastname": "Donor"
},
"date": "2019-12-31",
"purpose": {
"id": 1,
"name": "General"
},
"note": "Example contribution",
"amount": 123.45,
"is_ntd": false,
"expense_amount": 12.34
}
Example JSON Response:
{
"version": "v2_0_1",
"message": "put: 1",
"status": 200,
"meta": {
"resource_count": 1
},
"links": {
"self": "/api/v1/individual_contributions/1"
},
"data": {
"contribution": {
"id": 1,
"contact": {
"id": 1,
"firstname": "Aplos",
"lastname": "Donor"
},
"date": "2019-12-31",
"purpose": {
"id": 1,
"name": "General"
},
"note": "Example contribution",
"amount": 123.45,
"is_ntd": false,
"expense_amount": 12.34
}
}
}
HTTP Method: DELETE
URL: https://www.aplos.com/hermes/api/v1/individual_contributions/:contributionId
Parameters:
Headers:
Example JSON Response:
{
"version": "v2_0_0",
"message": "deleted: 1",
"status": 200
}