Get Schools
Retrieve debtor financial transactions
GET https://integrate.d6plus.co.za/api/v1/finplus/debtmanagement/schools/{school_login_id}
Use this endpoint to fetch schools and their details. The inclusion of the /{school_login_id} is optional and if it is not included, all schools will be returned.
Path Parameters
Name
Type
Description
school_login_id*
Integer
The login ID of the school to retrieve data from (optional)
Headers
Name
Type
Description
HTTP-X-USERNAME*
String
As provided by d6
HTTP-X-PASSWORD*
String
As provided by d6
Response Examples
[
{
"school_id": "1000",
"school_name": "d6+ Primary School",
"school_short_name": "primary",
"ownership_type": "Public",
"country": "South Africa",
"province": "Gauteng",
"town": "Pretoria",
"suburb": "Waterkloof Glen",
"district": "METRO EAST",
"district_code": "D1",
"circuit": "Circuit 2",
"quantile": "4",
"emis_number": "600000001",
"telephone_number": "0123334444",
"lowest_grade": "Grade R",
"highest_grade": "Grade 7",
"admin_email_address": "info@d6.co.za",
"debtors_email_address": "accounts@d6.co.za",
"finance_email_address": "accounts@d6.co.za",
"physical_address": "Spaces Building, Floor 3,/r/n210 Amarand Ave,/r/nWaterkloof Glen,/r/nPretoria,/r/n0010",
"postal_address": "Spaces Building, Floor 3,/r/n210 Amarand Ave,/r/nWaterkloof Glen,/r/nPretoria,/r/n0010",
"has_after_school_center": "Yes",
"has_hostel": "No",
"uses_debit_orders": "No",
"uses_cashless": "Yes"
},
{
"school_id": "1001",
"school_name": "d6+ Secondary School",
"school_short_name": "secondary",
"ownership_type": "Public",
"country": "South Africa",
"province": "Western Cape",
"town": "Stellenbosch",
"suburb": "Techno Park",
"district": "CAPE WINELANDS",
"district_code": "D1",
"circuit": "Circuit 10",
"quantile": "5",
"emis_number": "600000002",
"telephone_number": "0213337654",
"lowest_grade": "Grade 8",
"highest_grade": "Grade 12",
"admin_email_address": "info@d6.co.za",
"debtors_email_address": "accounts@d6.co.za",
"finance_email_address": "accounts@d6.co.za",
"physical_address": "Octo Place, Block B\r\nElektron Road\r\nTechno Park\r\nStellenbosch\r\n7600",
"postal_address": "Octo Place, Block B\r\nElektron Road\r\nTechno Park\r\nStellenbosch\r\n7600",
"has_after_school_center": "No",
"has_hostel": "Yes",
"uses_debit_orders": "Yes",
"uses_cashless": "No"
}
][
{
"accountable_person_id": "40",
"title": "Mr",
"first_name": "John",
"full_names": "John James",
"last_name": "Smith",
"debtor_code": "1001",
"mobile_calling_code": "27",
"mobile_number": "0821237654",
"work_tel_number": "0124567890",
"home_tel_number": "0123214567",
"email_address": "jjsmith@example.com",
"residential_address": "Moneytow Street\r\nNow Village\r\n0123\r\nSouth Africa",
"postal_address": "Moneytow Street\r\nNow Village\r\n0123\r\nSouth Africa",
"home_language": "English",
"nationality": "South Africa",
"id_number": "8104050240082",
"passport_number": "A456732243",
"employer": "Greenholt Group",
"employer_address": "3 School Lane\r\nBig City\r\nSouth Africa",
"account_closing_date": "0000-00-00",
"account_start_date": "2023-01-01",
"learners": [
{
"learner_id": "1",
"first_name": "John",
"last_name": "Smith",
"gender": "M",
"grade": "7"
}
]
},
{
"accountable_person_id": "3",
"title": "Mr",
"first_name": "Nic",
"full_names": "Nicholas Nigel",
"last_name": "Webster",
"debtor_code": "1002",
"mobile_calling_code": "27",
"mobile_number": "0678901234",
"work_tel_number": "",
"home_tel_number": "",
"email_address": "nicnwebster@example.co.za",
"residential_address": "7th Street\r\nSmall Town\r\n0123\r\nSouth Africa",
"postal_address": "7th Street\r\nSmall Town\r\n0123\r\nSouth Africa",
"home_language": "English",
"nationality": "South Africa",
"id_number": "",
"passport_number": "",
"employer": "",
"employer_address": "",
"account_closing_date": "0000-00-00",
"account_start_date": "2023-01-01",
"learners": [
{
"learner_id": "51",
"first_name": "Michelle",
"last_name": "Webster",
"gender": "F",
"grade": "3"
}
]
}
]{
"error": "Unauthorized",
"error_description": "Client access not authorised"
}{
"error": "Integration not activated",
"error_description": "Please activate the Finance+ API for this client before making this request"
}Code Samples
<?php
const BASE_URL = 'https://integrate.d6plus.co.za/api/v1/finplus/debtmanagement/schools';
const SCHOOL_LOGIN_ID = '1000';
const API_USERNAME = getenv('API_USERNAME'); // Assuming you have these environment variables set
const API_PASSWORD = getenv('API_PASSWORD');
$curl = curl_init();
$query = http_build_query(PARAMS);
$options = [
CURLOPT_URL => BASE_URL . '/' . SCHOOL_LOGIN_ID,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
"HTTP-X-USERNAME: " . API_USERNAME,
"HTTP-X-PASSWORD: " . API_PASSWORD
],
];
curl_setopt_array($curl, $options);
$response = curl_exec($curl);
if (curl_errno($curl)) {
throw new Exception('Curl error: ' . curl_error($curl));
}
curl_close($curl);
echo $response;curl --location 'https://integrate.d6plus.co.za/api/v1/finplus/debtmanagement/schooldebtors/1000?all_persons=1' \
--header 'HTTP-X-USERNAME: your_username' \
--header 'HTTP-X-PASSWORD: your_password'Last updated