API Funds

Available Here


List/Search

HTTP Method: GET

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

Parameters:

  • f_accountnumber: The fund balance account number
  • f_name: Any part of the name, case insensitive

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_0",
  "status": 200,
  "meta": {
    "resource_count": 1,
    "available_filters": {
      "f_accountnumber": "The fund balance account number",
      "f_name": "Any part of the name, case insensitive"
    }
  },
  "links": {
    "next": "/api/v1/funds?page_size=1&page_num=2",
    "self": "/api/v1/funds?page_size=1&page_num=1"
  },
  "data": {
    "funds": [
      {
        "id": 1,
        "name": "General Fund",
        "balance_account_name": "General Fund Balance",
        "balance_account_number": 3000
      }
    ]
  }
}

Get

HTTP Method: GET

URL: https://www.aplos.com/hermes/api/v1/funds/:fundId

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_0",
  "status": 200,
  "meta": {
    "resource_count": 1
  },
  "links": {
    "self": "/api/v1/funds/1"
  },
  "data": {
    "fund": {
      "id": 1,
      "name": "General Fund",
      "balance_account_name": "General Fund Balance",
      "balance_account_number": 3000
    }
  }
}

Post

NOT AVAILABLE

HTTP Method: POST

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

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:


{
   "todo": "implement this method"
}

Example JSON Response:


{
  "version": "v2_0_0",
  "status": 405,
  "exception": {
    "message": "Caller requested a resource that is not available.",
    "code": 3001
  }
}

Put

NOT AVAILABLE

HTTP Method: PUT

URL: https://www.aplos.com/hermes/api/v1/funds/:fundId

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:


{
   "todo": "implement this method"
}

Example JSON Response:


{
  "version": "v2_0_0",
  "status": 405,
  "exception": {
    "message": "Caller requested a resource that is not available.",
    "code": 3001
  }
}

Delete

NOT AVAILABLE

HTTP Method: DELETE

URL: https://www.aplos.com/hermes/api/v1/funds/:fundId

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:


{
   "todo": "implement this method"
}

Example JSON Response:


{
  "version": "v2_0_0",
  "status": 405,
  "exception": {
    "message": "Caller requested a resource that is not available.",
    "code": 3001
  }
}


Create Your Aplos Account

Try everything free for 15-days!

Must include min. 8 characters, upper and lower case letter, number & special character
What day of the week is it (e.g. Sunday)?

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