API Individual Contributions

Available Here


List/Search

HTTP Method: GET

URL: https://www.aplos.com/hermes/api/v1/individual_contributions

Parameters:

  • 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

Headers:

  • Authorization = Bearer: [ACCESS TOKEN]
    The access token obtained via the authentication resource.
  • aplos-account-id = [ACCOUNT ID]
    The Aplos account (organization) you are accessing (OPTIONAL)

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
      }
    ]
  }
}

Get

HTTP Method: GET

URL: https://www.aplos.com/hermes/api/v1/individual_contributions/:contributionId

Parameters:

  • [NONE]

Headers:

  • Authorization = Bearer: [ACCESS TOKEN]
    The access token obtained via the authentication resource.
  • aplos-account-id = [ACCOUNT ID]
    The Aplos account (organization) you are accessing (OPTIONAL)

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
    }
  }
}

Post

HTTP Method: POST

URL: https://www.aplos.com/hermes/api/v1/individual_contributions

Parameters:

  • [NONE]

Headers:

  • Authorization = Bearer: [ACCESS TOKEN]
    The access token obtained via the authentication resource.
  • aplos-account-id = [ACCOUNT ID]
    The Aplos account (organization) you are accessing (OPTIONAL)

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
    }
  }

Put

HTTP Method: PUT

URL: https://www.aplos.com/hermes/api/v1/individual_contributions/:contributionId

Parameters:

  • [NONE]

Headers:

  • Authorization = Bearer: [ACCESS TOKEN]
    The access token obtained via the authentication resource.
  • aplos-account-id = [ACCOUNT ID]
    The Aplos account (organization) you are accessing (OPTIONAL)

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
    }
  }
}

Delete

HTTP Method: DELETE

URL: https://www.aplos.com/hermes/api/v1/individual_contributions/:contributionId

Parameters:

  • [NONE]

Headers:

  • Authorization = Bearer: [ACCESS TOKEN]
    The access token obtained via the authentication resource.
  • aplos-account-id = [ACCOUNT ID]
    The Aplos account (organization) you are accessing (OPTIONAL)

Example JSON Response:


{
  "version": "v2_0_0",
  "message": "deleted: 1",
  "status": 200
}


Create Your Aplos Account

Try everything free for 15-days!

Must include min. 8 characters and 3 of the following: upper case letter, lower case letter, number, symbol
What year is it (e.g. 2000)?

By creating your Aplos account, you are agreeing to our
Terms and Conditions.