The following APIs are available:
The Financial GL API returns financial transaction details at the GL level, including information for transactions, GL accounts, receipts, and customers.
Path: `/financialGL`
Verb: `GET`
The following table describes the query parameters used for the GET method.
Note:
The maximum date range that can be retrieved in a single API call is 31 days.
| Parameter | Type | Required | Description |
| page | int | Index page
default: 1 (the first page) |
|
| pageSize | int | Number of records per page
default: 100 |
|
| startDate | string |
Yes | The start date must be a valid date formatted `yyyy-mm-dd` No default value |
| endDate | string |
Yes | The end date must be a valid date formatted `yyyy-mm-dd` No default value |
| transactionSiteId | string |
Transaction site ID |
|
| receiptNumber | string |
Requested receipt number |
|
| glAccountNumber | string |
Requested number of the GL account |
The response body of the GET method is formatted in JSON:
| Key | Type | Description |
| page | int | Requested page number |
| pageSize | int | Number of records per page |
| pageRowCount | string | Number of records on the Index page |
| filteredRowCount | string | Number of filter results by query parameters |
| data | array | List of financial transaction records |
The following table describes the data returned by the API:
| Key | Description |
| account_name | GL account name |
| Account_number | GL account number |
| transaction_site | Name of the transaction site |
| transaction_site_id | ID of the transaction site |
| workstation_name | Name of the workstation where the transaction occurred |
| revenue_site | Name of the site where the revenue is recognized |
| revenue_site_id | ID of the site where the revenue is recognized |
| transaction_date | Transaction date |
| receipt_number | Number of the receipt for the transaction |
| activity_number | If this transaction relates to an activity, then this field displays the activity number, otherwise this is hidden. |
| activity_id | If this transaction relates to an activity, then this field displays the activity ID, otherwise this is hidden. |
| package_id | If this transaction relates to a membership package, then this field displays the package ID, otherwise this is hidden. |
| program_id | If this transaction relates to a FlexReg program, then this field displays the program ID, otherwise this is hidden. |
| resource_id | If this transaction relates to a resource reservation, then this field displays the resource ID, otherwise this is hidden. |
| permit_number | If this transaction relates to a resource reservation, then this field displays the permit number |
| parent_season | If this transaction relates to an activity, then this field displays the parent season, otherwise this is hidden. |
| child_season | If this transaction relates to an activity, then this field displays the child season, otherwise this is hidden. |
| session_name | If the transaction relates to any program sessions, then this field displays names of the sessions, otherwise this is hidden. |
| customer_first_name | Customer's first name |
| customer_last_name | Customer's last name |
| customer_id | Customer ID |
| system_user | Name of the system user |
| amount | Total charged amount for the transaction |
| CC/ECP/DC_amount | Amount paid by credit card/ ECP/ debit card |
| transaction_fee | Transaction fee amount |
| credit_card_fee | Credit card fee amount |
| convenience_fee | Convenience fee amount |
This API will retrieve multiple records per API call depending on the specified request parameters.
One record will contain all information of a matching GL transaction.
**GET**
https://api.amp.active.com/ANETGateway/rest/anet-insightsapi/financialGL?startDate=2017-01-05&endDate=2017-11-06&api_key=xxx
{
"page": 1,
"pageSize": 100,
"pageRowCount": 2,
"filteredRowCount": 2,
"totalRowCount": 2,
"data": [
{
"account_name": "gl account1",
"account_number": "cgl1",
"transaction_site_id": 21,
"transaction_site": "Organization",
"workstation_name": "Internet",
"revenue_site_id": 21,
"revenue_site": "Organization",
"transaction_date": "2017-11-05",
"receipt_number": "1000518.0020",
"customer_first_name": "Claire",
"customer_last_name": "Blue",
"customer_id": 4187,
"system_user": "Payments",
"amount": "-25.0000",
"cc_ecp_dc_amount": "50.0000",
"transaction_fee": "0.5000",
"credit_card_fee": "5.5000",
"convenience_fee": "0.0000"
},
{
"account_name": "Payment Account: Credit Card",
"account_number": "TBA",
"transaction_site_id": 25,
"transaction_site": "acl",
"workstation_name": "Internet",
"revenue_site_id": 25,
"revenue_site": "acl",
"transaction_date": "2017-11-05",
"receipt_number": "1001028.0210",
"package_id": 482,
"customer_first_name": "Smith",
"customer_last_name": "John",
"customer_id": 1223,
"system_user": "Payments",
"amount": "13.0000",
"cc_ecp_dc_amount": "13.0000",
"transaction_fee": "0.2600",
"credit_card_fee": "0.3900",
"convenience_fee": "0.0000"
}
]
}
The GL Accounts API returns GL accounts for the specified request parameters.
Note that pagination is not supported.
Path: `/glaccounts`
Verb: `GET`
The following table describes the query parameters used for the GET method.
| Parameter | Type | Required | Description |
| startWith | string | Yes | Retrieve GL accounts start with the specified text. |
The following table describes the data returned by the API:
| Key | Description |
glaccount_id |
GL account ID. |
| site_id | Site ID. |
| account_name | GL account name. |
| account_number | GL account number. |
| account_type | Type ID of the GL account. |
| account_type_name | Type name of the GL account. |
| system_account | System GL account number. |
| system_account_name | System GL account name. |
| activated | The Activated flag of the GL account. |
| retired | The Retired flag of the GL account. |
This API will retrieve multiple records per API call depending on the specified request parameters.
One record will contain all information of a matching GL account.
**GET**
https://api.amp.active.com/ANETGateway/rest/anet-insightsapi/glaccounts?startWith=g&api_key=xxx
[
{
"glaccount_id": 54,
"site_id": 20,
"account_name": "GL account A",
"account_number": "134679",
"account_type": "3",
"account_type_name": "Income",
"system_account": "0",
"system_account_name": "None",
"activated": false,
"retired": false
},
{
"glaccount_id": 55,
"site_id": 0,
"account_name": "GL account B",
"account_number": "Discount",
"account_type": "5",
"account_type_name": "Expense",
"system_account": "0",
"system_account_name": "None",
"activated": false,
"retired": false
}
]
Retrieving data from ACTIVE Net Insights