NAV
shell ruby python csharp php

Fee

The Fee object

The Fee object looks like this in JSON:

{
    "object": "fee",
    "id": 10,
    "name": "Important Textbook",
    "description": null,
    "type": "flat",
    "amount": 1000,
    "applies_over_units": 0,
    "max_amount": 20,
    "allow_zero": false,
    "refundable": false,
    "condition": "and",
    "finaid_applies": true,
    "status": "active",
    "external_accountid": null,
    "account_id": 1,
    "fee_class": "fee",
    "report_on_1098t": true,
    "report_on_t2202a": true,
    "campus_life_permission": false,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}
Attribute Required Data Type
id Yes int
name Yes text (50)
description Yes text (500)
type Yes enum (flat, per_credit, per_hour, per_course, per_clinical_hour)
amount Yes decimal
applies_over_units Yes decimal
max_amount Yes decimal
allow_zero Yes bool
refundable Yes bool
condition Yes enum (and, or)
finaid_applies Yes bool
status Yes enum (construction, active, retired, deleted)
external_accountid Yes int
account_id Yes int
fee_class Yes enum (fee, deposit, payment_plan)
report_on_1098t Yes bool
report_on_t2202a Yes bool
campus_life_permission Yes bool
added_at No datetime
added_by_id No int
sandbox No bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/fees" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/fees',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/fees',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/fees"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/fees');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "list",
    "count": 2,
    "results": 2,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "fee",
            "id": 10,
            "name": "Important Textbook",
            "description": null,
            "type": "flat",
            "amount": 1000,
            "applies_over_units": 0,
            "max_amount": 20,
            "allow_zero": false,
            "refundable": false,
            "condition": "and",
            "finaid_applies": true,
            "status": "active",
            "external_accountid": null,
            "account_id": 1,
            "fee_class": "fee",
            "report_on_1098t": true,
            "report_on_t2202a": true,
            "campus_life_permission": false,
            "added_at": null,
            "added_by_id": null
        }
    ],
    "sandbox": true
}

Retrieves all Fee objects.

HTTP Request

GET /fees

Parameters

None

Permissions

One of the following roles is required to call this method:

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/fees/(fee)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/fees/(fee)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/fees/(fee)',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/fees/(fee)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/fees/(fee)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "fee",
    "id": 10,
    "name": "Important Textbook",
    "description": null,
    "type": "flat",
    "amount": 1000,
    "applies_over_units": 0,
    "max_amount": 20,
    "allow_zero": false,
    "refundable": false,
    "condition": "and",
    "finaid_applies": true,
    "status": "active",
    "external_accountid": null,
    "account_id": 1,
    "fee_class": "fee",
    "report_on_1098t": true,
    "report_on_t2202a": true,
    "campus_life_permission": false,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

Retrieves a specific Fee object.

HTTP Request

GET /fees/(fee)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Expandable Properties

Permissions

One of the following roles is required to call this method:

shell ruby python csharp php