Check

The Check object

The Check object looks like this in JSON:

{
    "object": "check",
    "id": 1,
    "owner_type": "person",
    "owner_id": 12,
    "amount": 400.5,
    "transaction_id": 12,
    "batch_number": 1,
    "number": 1001,
    "added_at": "2022-01-02T12:30:34+00:00",
    "added_by_id": 1,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
owner_type	Yes	enum (person, donor)
owner_id	Yes	int
amount	Yes	decimal
transaction_id	Yes	int
batch_number	No	int
number	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/checks" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": {"0":{"logic":"ALL","fields":[{"name":"posted_date","value":{"type":"RANGE","start":"2021-01-01","end":"2022-03-17"},"positive":1}]}}
}' \

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/checks',
 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/checks"), 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/checks');
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": "check",
            "id": 1,
            "owner_type": "person",
            "owner_id": 12,
            "amount": 400.5,
            "transaction_id": 12,
            "batch_number": 1,
            "number": 1001,
            "added_at": "2015-03-10T19:33:11+00:00",
            "added_by_id": 1,
            "report_data": {
                "payee_name": "Alice Admin",
                "person_name": "Alice Admin",
                "person_firstname": "Alice",
                "person_lastname": "Admin",
                "posted_date": "2015-03-10",
                "transaction_number": 1237,
                "refund_source": null,
                "account_number": "12345-7",
                "account_name": "Cooler Account",
                "added_by_name": "Elizabeth Fox",
                "student_dummy_id": "20220xx002",
                "row_id": 1
            }
        }
    ],
    "sandbox": true
}

Retrieves all Check objects that match given filter conditions.

HTTP Request

GET /checks

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

person
transaction

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
payee	text
posted_date	date
account	text
transaction_number	integer
check_number	integer
batch_number	integer
amount	decimal
student	text
tag	tag
custom_field	custom

Permissions

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

Financial Auditor
Financial Aid
Student Billing
Financial Admin

show

Example code to call this method:

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

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/checks/(check)',
 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/checks/(check)"), 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/checks/(check)');
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": "check",
    "id": 1,
    "owner_type": "person",
    "owner_id": 12,
    "amount": 400.5,
    "transaction_id": 12,
    "batch_number": 1,
    "number": 1001,
    "added_at": "2022-01-02T12:30:34+00:00",
    "added_by_id": 1,
    "sandbox": true
}

Retrieves a specific Check object.

HTTP Request

GET /checks/(check)

Parameters

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

Expandable Properties

person
transaction

Permissions

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

Financial Auditor
Financial Aid
Student Billing
Financial Admin