NAV
shell ruby python csharp php

AidDisbursement

The AidDisbursement object

The AidDisbursement object looks like this in JSON:

{
    "object": "aid_disbursement",
    "id": 6,
    "academic_term_id": 8,
    "student_id": 1,
    "aid_id": 9,
    "aid_award_id": 7,
    "type": "disbursement",
    "status": "scheduled",
    "amount": 430.7,
    "gross_amount": 430.7,
    "max_amount": 0,
    "multiplier": null,
    "scheduled_date": "2023-02-14",
    "posted_date": null,
    "status_date": "2023-02-14",
    "payment_id": null,
    "refund_id": null,
    "transaction_id": null,
    "disbursement_number": true,
    "sequence_number": false,
    "enrollment_status": null,
    "enrollment_intensity": false,
    "institutional_limit_applied": false,
    "enrollment_status_effective_date": null,
    "enrollment_verified": false,
    "enrollment_verified_by_id": null,
    "enrollment_verified_at": null,
    "cod_status": null,
    "cod_amount": 0,
    "cod_originated": false,
    "cod_net_amount": 0,
    "cod_released": false,
    "cod_needs_sync": true,
    "cod_program_cip_code": null,
    "cod_payment_period_start_date": null,
    "external_id": null,
    "email_message_id": null,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}
Attribute Required Data Type
id Yes int
academic_term_id No int
student_id Yes int
aid_id Yes int
aid_award_id No int
type Yes enum (disbursement, refund_to_student, refund_to_source)
status Yes enum (setup, scheduled, posted, deleted, void)
amount Yes decimal
gross_amount Yes decimal
max_amount Yes decimal
multiplier No decimal
scheduled_date No date
posted_date No date
status_date No date
payment_id No int
refund_id No int
transaction_id No int
disbursement_number Yes bool
sequence_number No bool
enrollment_status No enum (full_time, three_quarter_time, half_time, less_than_half_time)
enrollment_intensity No bool
institutional_limit_applied Yes bool
enrollment_status_effective_date No date
enrollment_verified Yes bool
enrollment_verified_by_id No int
enrollment_verified_at No datetime
cod_status No enum (pending, accepted, rejected, corrected)
cod_amount Yes decimal
cod_originated Yes bool
cod_net_amount Yes decimal
cod_released Yes bool
cod_needs_sync Yes bool
cod_program_cip_code No text (20)
cod_payment_period_start_date No date
external_id No text (50)
email_message_id No int
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/aiddisbursements" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": {"0":{"logic":"ALL","fields":[{"name":"date","value":{"type":"RANGE","start":"2021-01-01","end":"2022-03-17"},"positive":1}]}}
}' \ 

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/aiddisbursements',
 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/aiddisbursements"), 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/aiddisbursements');
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": 9,
    "results": 9,
    "results_per_page": 200,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "aid_disbursement",
            "id": 8,
            "academic_term_id": 8,
            "student_id": 16,
            "aid_id": 9,
            "aid_award_id": 7,
            "type": "disbursement",
            "status": "scheduled",
            "amount": 430.7,
            "gross_amount": 430.7,
            "max_amount": 0,
            "multiplier": null,
            "scheduled_date": "2023-02-14",
            "posted_date": null,
            "status_date": "2023-02-14",
            "payment_id": null,
            "refund_id": null,
            "transaction_id": null,
            "disbursement_number": true,
            "sequence_number": false,
            "enrollment_status": null,
            "enrollment_intensity": false,
            "institutional_limit_applied": false,
            "enrollment_status_effective_date": null,
            "enrollment_verified": false,
            "enrollment_verified_by_id": null,
            "enrollment_verified_at": null,
            "cod_status": null,
            "cod_amount": 0,
            "cod_originated": false,
            "cod_net_amount": 0,
            "cod_released": false,
            "cod_needs_sync": true,
            "cod_program_cip_code": null,
            "cod_payment_period_start_date": null,
            "external_id": null,
            "email_message_id": null,
            "added_at": null,
            "added_by_id": null,
            "report_data": {
                "firstname": "Abby",
                "lastname": "Admin",
                "display_name": "Abby Admin",
                "aid_name": "Institutional Grant",
                "aid_type": "GRANT",
                "is_scholarship": 0,
                "aid_source": "INSTITUTION",
                "aid_abbrv": "INST",
                "require_enrollment_verification": 0,
                "term_name": "Spring 2010 2009-2010",
                "aid_year_id": 1,
                "aid_year_name": "2010-2011",
                "row_id": 8
            }
        }
    ],
    "sandbox": true
}

Retrieves all AidDisbursement objects that match given filter conditions.

HTTP Request

GET /aiddisbursements

Parameters

Name Required Data Type Description
filter No mixed See available filter conditions
page No int The page of results to return if more than 200 records are found.

Expandable Properties

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name Type
date date
student object_id
type awardtype
disbursement_type enum
award object id
award_status enum
percent_award bool
status enum
aid_year object id
academic_term object_id
amount decimal
source choice
campus object id
classification object id
enrollment_verified bool
cod_status enum
tag tag
disbursement_batch_number integer
student_has_courses bool
unapplied_scheduled_aid bool
custom_field custom
added_at datetime

Permissions

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

index_by_award

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements',
 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/people/(person)/aidawards/(aidaward)/disbursements"), 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/people/(person)/aidawards/(aidaward)/disbursements');
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": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "aid_disbursement",
            "id": 15,
            "academic_term_id": 8,
            "student_id": 16,
            "aid_id": 9,
            "aid_award_id": 8,
            "type": "disbursement",
            "status": "scheduled",
            "amount": 440.7,
            "gross_amount": 440.7,
            "max_amount": 0,
            "multiplier": null,
            "scheduled_date": "2023-02-16",
            "posted_date": null,
            "status_date": "2023-02-16",
            "payment_id": null,
            "refund_id": null,
            "transaction_id": null,
            "disbursement_number": true,
            "sequence_number": false,
            "enrollment_status": null,
            "enrollment_intensity": false,
            "institutional_limit_applied": false,
            "enrollment_status_effective_date": null,
            "enrollment_verified": false,
            "enrollment_verified_by_id": null,
            "enrollment_verified_at": null,
            "cod_status": null,
            "cod_amount": 0,
            "cod_originated": false,
            "cod_net_amount": 0,
            "cod_released": false,
            "cod_needs_sync": true,
            "cod_program_cip_code": null,
            "cod_payment_period_start_date": null,
            "external_id": null,
            "email_message_id": null,
            "added_at": null,
            "added_by_id": null
        }
    ],
    "sandbox": true
}

HTTP Request

GET /people/(person)/aidawards/(aidaward)/disbursements

Parameters

None

Permissions

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

create (disbursement)

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X POST
-d '{
    "scheduled_date": "2022-10-20",
    "academic_term_id": 8,
    "amount": 650
}' \ 

require 'httparty'
response = HTTParty.post(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
 body: {
  :scheduled_date => '2022-10-20',
  :academic_term_id => 8,
  :amount => 650
 }.to_json
)
puts response.body

import requests
response = requests.post(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
 json={
  'scheduled_date': '2022-10-20',
  'academic_term_id': 8,
  'amount': 650
 }
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements"), Method.Post);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
request.AddJsonBody(new {
  scheduled_date = "2022-10-20",
  academic_term_id = 8,
  amount = 650
});
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/people/(person)/aidawards/(aidaward)/disbursements');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode([
  'scheduled_date' => '2022-10-20',
  'academic_term_id' => 8,
  'amount' => 650
]));
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "aid_disbursement",
    "id": 16,
    "academic_term_id": 8,
    "student_id": 16,
    "aid_id": 9,
    "aid_award_id": 8,
    "type": "disbursement",
    "status": "scheduled",
    "amount": 650,
    "gross_amount": 650,
    "max_amount": 0,
    "multiplier": null,
    "scheduled_date": "2022-10-20",
    "posted_date": null,
    "status_date": "2022-10-20",
    "payment_id": null,
    "refund_id": null,
    "transaction_id": null,
    "disbursement_number": true,
    "sequence_number": true,
    "enrollment_status": null,
    "enrollment_intensity": false,
    "institutional_limit_applied": false,
    "enrollment_status_effective_date": null,
    "enrollment_verified": false,
    "enrollment_verified_by_id": null,
    "enrollment_verified_at": null,
    "cod_status": null,
    "cod_amount": 650,
    "cod_originated": false,
    "cod_net_amount": 650,
    "cod_released": false,
    "cod_needs_sync": true,
    "cod_program_cip_code": null,
    "cod_payment_period_start_date": null,
    "external_id": null,
    "email_message_id": null,
    "added_at": "2026-07-25T16:24:10+00:00",
    "added_by_id": 22,
    "sandbox": true
}

Creates a new AidDisbursement object.

HTTP Request

POST /people/(person)/aidawards/(aidaward)/disbursements

Parameters

Name Required Data Type Description
scheduled_date Yes date
academic_term_id Yes int
amount Yes decimal
gross_amount No decimal

Permissions

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

show (disbursement)

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)',
 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/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)"), 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/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)');
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": "aid_disbursement",
    "id": 8,
    "academic_term_id": 8,
    "student_id": 16,
    "aid_id": 9,
    "aid_award_id": 7,
    "type": "disbursement",
    "status": "scheduled",
    "amount": 430.7,
    "gross_amount": 430.7,
    "max_amount": 0,
    "multiplier": null,
    "scheduled_date": "2023-02-14",
    "posted_date": null,
    "status_date": "2023-02-14",
    "payment_id": null,
    "refund_id": null,
    "transaction_id": null,
    "disbursement_number": true,
    "sequence_number": false,
    "enrollment_status": null,
    "enrollment_intensity": false,
    "institutional_limit_applied": false,
    "enrollment_status_effective_date": null,
    "enrollment_verified": false,
    "enrollment_verified_by_id": null,
    "enrollment_verified_at": null,
    "cod_status": null,
    "cod_amount": 0,
    "cod_originated": false,
    "cod_net_amount": 0,
    "cod_released": false,
    "cod_needs_sync": true,
    "cod_program_cip_code": null,
    "cod_payment_period_start_date": null,
    "external_id": null,
    "email_message_id": null,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

Retrieves a specific AidDisbursement object.

HTTP Request

GET /people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)

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:

update (disbursement)

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X PUT

require 'httparty'
response = HTTParty.put(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.put(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)',
 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/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)"), Method.Put);
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/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "aid_disbursement",
    "id": 8,
    "academic_term_id": 8,
    "student_id": 16,
    "aid_id": 9,
    "aid_award_id": 7,
    "type": "disbursement",
    "status": "scheduled",
    "amount": 430.7,
    "gross_amount": 430.7,
    "max_amount": 0,
    "multiplier": null,
    "scheduled_date": "2023-02-14",
    "posted_date": null,
    "status_date": "2023-02-14",
    "payment_id": null,
    "refund_id": null,
    "transaction_id": null,
    "disbursement_number": true,
    "sequence_number": false,
    "enrollment_status": null,
    "enrollment_intensity": false,
    "institutional_limit_applied": false,
    "enrollment_status_effective_date": null,
    "enrollment_verified": false,
    "enrollment_verified_by_id": null,
    "enrollment_verified_at": null,
    "cod_status": null,
    "cod_amount": 0,
    "cod_originated": false,
    "cod_net_amount": 0,
    "cod_released": false,
    "cod_needs_sync": true,
    "cod_program_cip_code": null,
    "cod_payment_period_start_date": null,
    "external_id": null,
    "email_message_id": null,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

Updates an existing AidDisbursement object.

HTTP Request

PUT /people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)

Parameters

Name Required Data Type Description
scheduled_date No date
amount No decimal
gross_amount No decimal
academic_term_id No int

Permissions

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

delete (disbursement)

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X DELETE

require 'httparty'
response = HTTParty.delete(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.delete(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)',
 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/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)"), Method.Delete);
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/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "aid_disbursement",
    "id": 11,
    "deleted": true
}

Deletes an existing AidDisbursement object.

HTTP Request

DELETE /people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)

Parameters

No additional parameters are needed beyond the ID of the object to delete that appears in the URL.

Permissions

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

post

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)/post" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "transaction_description": "Manual 3rd PELL grant disbusement."
}' \ 

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)/post',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)/post',
 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/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)/post"), 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/people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)/post');
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": "aid_disbursement",
    "id": 8,
    "academic_term_id": 8,
    "student_id": 16,
    "aid_id": 9,
    "aid_award_id": 7,
    "type": "disbursement",
    "status": "posted",
    "amount": 430.7,
    "gross_amount": 430.7,
    "max_amount": 0,
    "multiplier": null,
    "scheduled_date": "2023-02-14",
    "posted_date": "2026-07-25",
    "status_date": "2026-07-25",
    "payment_id": 101,
    "refund_id": null,
    "transaction_id": 106,
    "disbursement_number": true,
    "sequence_number": false,
    "enrollment_status": null,
    "enrollment_intensity": false,
    "institutional_limit_applied": false,
    "enrollment_status_effective_date": null,
    "enrollment_verified": false,
    "enrollment_verified_by_id": null,
    "enrollment_verified_at": null,
    "cod_status": null,
    "cod_amount": 0,
    "cod_originated": false,
    "cod_net_amount": 0,
    "cod_released": false,
    "cod_needs_sync": true,
    "cod_program_cip_code": null,
    "cod_payment_period_start_date": null,
    "external_id": null,
    "email_message_id": null,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

HTTP Request

GET /people/(person)/aidawards/(aidaward)/disbursements/(aiddisbursement)/post

Parameters

Name Required Data Type Description
posted_date No date Default is today
transaction_description No text

Action Parameters

Name Data Type Description
notify_student

Permissions

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

create (refund)

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/refunds" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X POST
-d '{
    "scheduled_date": "2022-11-02",
    "amount": 720,
    "type": "refund_to_student",
    "refund_asset_account_id": 1
}' \ 

require 'httparty'
response = HTTParty.post(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/refunds',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
 body: {
  :scheduled_date => '2022-11-02',
  :amount => 720,
  :type => 'refund_to_student'
 }.to_json
)
puts response.body

import requests
response = requests.post(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/refunds',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
 json={
  'scheduled_date': '2022-11-02',
  'amount': 720,
  'type': 'refund_to_student'
 }
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/refunds"), Method.Post);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
request.AddJsonBody(new {
  scheduled_date = "2022-11-02",
  amount = 720,
  type = "refund_to_student"
});
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/people/(person)/aidawards/(aidaward)/refunds');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode([
  'scheduled_date' => '2022-11-02',
  'amount' => 720,
  'type' => 'refund_to_student'
]));
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "aid_disbursement",
    "id": 17,
    "academic_term_id": null,
    "student_id": 16,
    "aid_id": 9,
    "aid_award_id": 8,
    "type": "refund_to_student",
    "status": "scheduled",
    "amount": -720,
    "gross_amount": -720,
    "max_amount": 0,
    "multiplier": null,
    "scheduled_date": "2022-11-02",
    "posted_date": null,
    "status_date": "2022-11-02",
    "payment_id": null,
    "refund_id": null,
    "transaction_id": null,
    "disbursement_number": true,
    "sequence_number": false,
    "enrollment_status": null,
    "enrollment_intensity": false,
    "institutional_limit_applied": false,
    "enrollment_status_effective_date": null,
    "enrollment_verified": false,
    "enrollment_verified_by_id": null,
    "enrollment_verified_at": null,
    "cod_status": null,
    "cod_amount": 0,
    "cod_originated": false,
    "cod_net_amount": 0,
    "cod_released": false,
    "cod_needs_sync": true,
    "cod_program_cip_code": null,
    "cod_payment_period_start_date": null,
    "external_id": null,
    "email_message_id": null,
    "added_at": "2026-07-25T16:24:10+00:00",
    "added_by_id": 22,
    "sandbox": true
}

Creates a new AidDisbursement object.

HTTP Request

POST /people/(person)/aidawards/(aidaward)/refunds

Parameters

Name Required Data Type Description
scheduled_date Yes date
amount Yes decimal
type Yes enum (disbursement, refund_to_student, refund_to_source)
refund_asset_account_id No int

Permissions

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

show (refund)

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)',
 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/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)"), 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/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)');
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": "aid_disbursement",
    "id": 9,
    "academic_term_id": 8,
    "student_id": 16,
    "aid_id": 9,
    "aid_award_id": 7,
    "type": "refund_to_source",
    "status": "scheduled",
    "amount": 430.7,
    "gross_amount": 430.7,
    "max_amount": 0,
    "multiplier": null,
    "scheduled_date": "2023-02-14",
    "posted_date": null,
    "status_date": "2023-02-14",
    "payment_id": null,
    "refund_id": null,
    "transaction_id": null,
    "disbursement_number": true,
    "sequence_number": false,
    "enrollment_status": null,
    "enrollment_intensity": false,
    "institutional_limit_applied": false,
    "enrollment_status_effective_date": null,
    "enrollment_verified": false,
    "enrollment_verified_by_id": null,
    "enrollment_verified_at": null,
    "cod_status": null,
    "cod_amount": 0,
    "cod_originated": false,
    "cod_net_amount": 0,
    "cod_released": false,
    "cod_needs_sync": true,
    "cod_program_cip_code": null,
    "cod_payment_period_start_date": null,
    "external_id": null,
    "email_message_id": null,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

Retrieves a specific AidDisbursement object.

HTTP Request

GET /people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)

Parameters

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

Permissions

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

update (refund)

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X PUT

require 'httparty'
response = HTTParty.put(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.put(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)',
 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/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)"), Method.Put);
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/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "aid_disbursement",
    "id": 9,
    "academic_term_id": 8,
    "student_id": 16,
    "aid_id": 9,
    "aid_award_id": 7,
    "type": "refund_to_source",
    "status": "scheduled",
    "amount": -430.7,
    "gross_amount": 430.7,
    "max_amount": 0,
    "multiplier": null,
    "scheduled_date": "2023-02-14",
    "posted_date": null,
    "status_date": "2023-02-14",
    "payment_id": null,
    "refund_id": null,
    "transaction_id": null,
    "disbursement_number": true,
    "sequence_number": false,
    "enrollment_status": null,
    "enrollment_intensity": false,
    "institutional_limit_applied": false,
    "enrollment_status_effective_date": null,
    "enrollment_verified": false,
    "enrollment_verified_by_id": null,
    "enrollment_verified_at": null,
    "cod_status": null,
    "cod_amount": 0,
    "cod_originated": false,
    "cod_net_amount": 0,
    "cod_released": false,
    "cod_needs_sync": true,
    "cod_program_cip_code": null,
    "cod_payment_period_start_date": null,
    "external_id": null,
    "email_message_id": null,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

Updates an existing AidDisbursement object.

HTTP Request

PUT /people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)

Parameters

Name Required Data Type Description
scheduled_date No date
amount No decimal
type No enum (disbursement, refund_to_student, refund_to_source)
refund_asset_account_id No int

Permissions

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

delete (refund)

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X DELETE

require 'httparty'
response = HTTParty.delete(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.delete(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)',
 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/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)"), Method.Delete);
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/people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "aid_disbursement",
    "id": 12,
    "deleted": true
}

Deletes an existing AidDisbursement object.

HTTP Request

DELETE /people/(person)/aidawards/(aidaward)/refunds/(aiddisbursement)

Parameters

No additional parameters are needed beyond the ID of the object to delete that appears in the URL.

Permissions

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

shell ruby python csharp php