PaymentDeadline

The PaymentDeadline object

The PaymentDeadline object looks like this in JSON:

{
    "object": "payment_deadline",
    "id": 1,
    "owner_type": "invoice",
    "owner_id": 7,
    "actor_type": "person",
    "actor_id": 8,
    "due_date": "2022-08-11",
    "balance_due": false,
    "amount": 0,
    "tuition_amount": 0,
    "fee_amount": 0,
    "room_plan_amount": 0,
    "meal_plan_amount": 0,
    "bookstore_amount": 0,
    "amount_percent": 0,
    "tuition_amount_percent": 0,
    "fee_amount_percent": 0,
    "room_plan_amount_percent": 0,
    "meal_plan_amount_percent": 0,
    "bookstore_amount_percent": 0,
    "generated_amount_due": 580,
    "generated_due_to_date": 0,
    "amount_due": 430,
    "due_status": "due_now",
    "check_late_fee_on": null,
    "late_fee_added": null,
    "late_fee_charge_id": null,
    "manual_edit": false,
    "force_automatic_charge": false,
    "updated_at": "2022-07-12T18:28:09+00:00",
    "updated_by_id": 6,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
owner_type	Yes	enum (invoice, payment_plan_student)
owner_id	No	int
actor_type	Yes	enum (person, contact_org)
actor_id	No	int
due_date	Yes	date
balance_due	Yes	bool
amount	Yes	decimal
tuition_amount	Yes	decimal
fee_amount	Yes	decimal
room_plan_amount	Yes	decimal
meal_plan_amount	Yes	decimal
bookstore_amount	Yes	decimal
amount_percent	Yes	decimal
tuition_amount_percent	Yes	decimal
fee_amount_percent	Yes	decimal
room_plan_amount_percent	Yes	decimal
meal_plan_amount_percent	Yes	decimal
bookstore_amount_percent	Yes	decimal
generated_amount_due	Yes	decimal
generated_due_to_date	Yes	decimal
amount_due	Yes	decimal
due_status	Yes	enum (due_later, due_now, paid_on_time, overdue, paid_late)
check_late_fee_on	No	datetime
late_fee_added	No	date
late_fee_charge_id	No	int
manual_edit	Yes	bool
force_automatic_charge	Yes	bool
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/paymentdeadlines" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": {"0":{"logic":"ALL","fields":[{"name":"due_date","value":{"type":"RANGE","start":"2021-01-01","end":"2022-03-17"},"positive":1}]}}
}' \

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/paymentdeadlines',
 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/paymentdeadlines"), 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/paymentdeadlines');
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": 0,
    "results": 0,
    "results_per_page": 200,
    "pages": 0,
    "page": 0,
    "offset": 0,
    "has_more": false,
    "data": [],
    "sandbox": true
}

Retrieves all PaymentDeadline objects that match given filter conditions.

HTTP Request

GET /paymentdeadlines

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

payments

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
due_date	date
student	object_id
academic_term	object_id
academic_term_type	academic_term_type
type	choice
payment_plan	paymentplan
status	paymentdeadlinestatus
originally_due	decimal
currently_due	decimal
tag	tag
custom_field	custom

Permissions

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

Financial Auditor
Financial Admin
Student Billing
Financial Aid

show