-
- Pricing
- Organizations
- Churches
- Nonprofits
- Aplos Nonprofit Software
- What's Included:
- Nonprofit CRM
- Donor Management
- Nonprofit Accounting
- Membership Management
- Fundraising Tools
- Online Donations & Payments
- Marketing & Communication
- Event Registration
- Website Builder
- Reporting & Analytics
- Popular Add-ons:
- Text to Give
- Bill Pay
- Payroll
- Prepaid Cards
Available Here
List/Search
HTTP Method: GET
URL: https://www.aplos.com/hermes/api/v1/accounts
Parameters:
- f_enabled: Whether the account is enabled: y, n
- f_name: Any part of the name, case insensitive
- f_type: Type of account: asset, liability, equity, income, expense
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_enabled": "Whether the account is enabled: y, n",
"f_name": "Any part of the name, case insensitive",
"f_type": "Type of account: asset, liability, equity, income, expense"
}
},
"links": {
"next": "/api/v1/accounts?page_size=1&page_num=2",
"self": "/api/v1/accounts?page_size=1&page_num=1"
},
"data": {
"accounts": [
{
"account_number": 1000,
"name": "Cash",
"category": "asset",
"account_group": {
"id": 1,
"name": "Cash",
"seq": 1
},
"is_enabled": true,
"type": "Register",
"activity": "cash"
}
]
}
}
Get
HTTP Method: GET
URL: https://www.aplos.com/hermes/api/v1/accounts/:accountNumber
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/accounts/1000"
},
"data": {
"account": {
"account_number": 1000,
"name": "Cash",
"category": "asset",
"account_group": {
"id": 1,
"name": "Cash"
},
"is_enabled": true,
"type": "Register",
"activity": "cash"
}
}
}
Post
NOT AVAILABLE
HTTP Method: POST
URL: https://www.aplos.com/hermes/api/v1/accounts
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/accounts/:accountNumber
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/accounts/:accountNumber
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
}
}
