AidDisbursementBatch

The AidDisbursementBatch object

The AidDisbursementBatch object looks like this in JSON:

{
    "object": "aid_disbursement_batch",
    "id": 1,
    "aid_type_ids": "[7]",
    "campus_id": null,
    "number": 1,
    "type": "disbursement",
    "status": "open",
    "stage_id": 7,
    "import_id": null,
    "transaction_id": null,
    "notify_students": false,
    "added_at": "2023-05-23T21:10:45+00:00",
    "added_by_id": 2923,
    "updated_at": "2023-05-23T21:37:38+00:00",
    "updated_by_id": 2923,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
aid_type_ids	No	text
campus_id	No	int
number	No	int
type	No	enum (disbursement, refund_to_student, refund_to_source)
status	Yes	enum (open, closed, canceled)
stage_id	No	int
import_id	No	int
transaction_id	No	int
notify_students	No	bool
added_at	No	datetime
added_by_id	No	int
updated_at	No	datetime
updated_by_id	No	int
sandbox	No	bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/aiddisbursementbatches" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": {"0":{"logic":"ALL","fields":[{"name":"award","value":1,"positive":1}]}}
}' \

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/aiddisbursementbatches',
 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/aiddisbursementbatches"), 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/aiddisbursementbatches');
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": 200,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "aid_disbursement_batch",
            "id": 1,
            "aid_type_ids": "[7]",
            "campus_id": null,
            "number": 1,
            "type": "disbursement",
            "status": "open",
            "stage_id": 7,
            "import_id": null,
            "transaction_id": null,
            "notify_students": false,
            "added_at": "2023-05-23T21:10:45+00:00",
            "added_by_id": 2923,
            "updated_at": "2023-05-23T21:37:38+00:00",
            "updated_by_id": 2923,
            "report_data": {
                "stage_name": "Posted to Student Accounts",
                "num_disbursements": "0",
                "amount": "0.00",
                "financial_aid_ids": null,
                "student_ids": null,
                "campus_name": null
            }
        }
    ],
    "sandbox": true
}

Retrieves all AidDisbursementBatch objects that match given filter conditions.

HTTP Request

GET /aiddisbursementbatches

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.

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
batch_number	integer
type	enum
campus	object id
status	enum
stage	object id
added	datetime
updated	datetime
disbursements	integer
amount	decimal
award	object id
student	object_id

Permissions

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

Financial Admin
Financial Auditor
Student Billing
Financial Aid

create

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/aiddisbursementbatches" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X POST
-d '{
    "type": "disbursement",
    "aid_disbursement_ids": "[13,14]"
}' \

require 'httparty'
response = HTTParty.post(
 'https://yourschool.populiweb.com/api2/aiddisbursementbatches',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
 body: {
  :type => 'disbursement',
  :aid_disbursement_ids => [13,14]
 }.to_json
)
puts response.body

import requests
response = requests.post(
 'https://yourschool.populiweb.com/api2/aiddisbursementbatches',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
 json={
  'type': 'disbursement',
  'aid_disbursement_ids': [13,14]
 }
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/aiddisbursementbatches"), Method.Post);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
request.AddJsonBody(new {
  type = "disbursement",
  aid_disbursement_ids = [13,14]
});
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/aiddisbursementbatches');
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([
  'type' => 'disbursement',
  'aid_disbursement_ids' => [13,14]
]));
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "aid_disbursement_batch",
    "id": 2,
    "aid_type_ids": "[9]",
    "campus_id": null,
    "number": 2,
    "type": "disbursement",
    "status": "open",
    "stage_id": 1,
    "import_id": null,
    "transaction_id": null,
    "notify_students": false,
    "added_at": "2026-07-25T16:24:06+00:00",
    "added_by_id": 22,
    "updated_at": null,
    "updated_by_id": null,
    "sandbox": true
}

Creates a new AidDisbursementBatch object.

HTTP Request

POST /aiddisbursementbatches

Parameters

Name	Required	Data Type	Description
type	Yes	enum (disbursement, refund_to_student, refund_to_source)
aid_disbursement_ids	Yes	array of AidDisbursement ids

Permissions

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

Financial Aid

show

Example code to call this method:

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

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/aiddisbursementbatches/(aiddisbursementbatch)',
 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/aiddisbursementbatches/(aiddisbursementbatch)"), 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/aiddisbursementbatches/(aiddisbursementbatch)');
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_batch",
    "id": 1,
    "aid_type_ids": "[7]",
    "campus_id": null,
    "number": 1,
    "type": "disbursement",
    "status": "open",
    "stage_id": 7,
    "import_id": null,
    "transaction_id": null,
    "notify_students": false,
    "added_at": "2023-05-23T21:10:45+00:00",
    "added_by_id": 2923,
    "updated_at": "2023-05-23T21:37:38+00:00",
    "updated_by_id": 2923,
    "sandbox": true
}

Retrieves a specific AidDisbursementBatch object.

HTTP Request

GET /aiddisbursementbatches/(aiddisbursementbatch)

Parameters

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

Expandable Properties

disbursements

Permissions

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

Financial Admin
Financial Auditor
Student Billing
Financial Aid