Get Promise To Pay(s)

Get one or more Promise To Pay records

GET https://integrate.d6plus.co.za/api/v1/finplus/debtmanagement/debtornotes/promisetopays/{school_login_id}

Use this endpoint to fetch one or more promise-to-pay records for the specified school.

It is possible to retrieve a single promise to pay record by providing the optional promise_to_pay_id query parameter.

To find promise-to-pay records belonging to a specific person, us the debtor_code or accountable_person_id query parameters.

Additionally, it's possible to filter on the status of the promise to pay record by using the promise_completed query parameter. The possible values are "Yes", "No" and "Partial".

It is also possible to return only a specific year's promise to pay records. Use the year_promised query parameter to do so.

To include the debtor note the promise to pay belongs to, directly in the response, providing the additional include_debtor_note query parameter.

Path Parameters

Name	Type	Description
school_login_id*	Integer	The login ID of the school to retrieve data from

Headers

Name	Type	Description
HTTP-X-USERNAME*	String	As provided by d6
HTTP-X-PASSWORD*	String	As provided by d6

Query Parameters

Name	Type	Description
promise_to_pay_id	Integer	The ID of a promise to pay record
accountable_person_id	Integer	To only return a specific accountable person's promise to pays
debtor_code	Integer	To only return a specific debtor code's promise to pays
promise_completed	String	To filter on the status of the promise to pay
year_promised	Integer	To filter on a specific year
include_debtor_note	Boolean	Whether to include debtor note data in the response

Response Examples

200 The request was successful.

[
    {
        "promise_to_pay_id": "8",
        "accountable_person_id": "40",
        "accountable_person": "Mr James, John",
        "debtor_code": "1001",
        "debtor_reference": "James",
        "date_promised": "2024-03-31",
        "amount_promised": "1000.00",
        "amount_paid": "1000.00",
        "promise_completed": "Yes"
    },
    {
        "promise_to_pay_id": "10",
        "accountable_person_id": "40",
        "accountable_person": "Mr James, John",
        "debtor_code": "1001",
        "debtor_reference": "James",
        "date_promised": "2024-04-30",
        "amount_promised": "1000.00",
        "amount_paid": "750.00",
        "promise_completed": "Partial"
    },
    {
        "promise_to_pay_id": "12",
        "accountable_person_id": "40",
        "accountable_person": "Mr James, John",
        "debtor_code": "1001",
        "debtor_reference": "James",
        "date_promised": "2020-05-31",
        "amount_promised": "1000.00",
        "amount_paid": "",
        "promise_completed": "No"
    }
]

200 Including Debtor Notes

204 No Content

404: Not Found The resource was not found.

401: Unauthorized The server understood the request, but is refusing it or access is not allowed.

403: Forbidden The server understood the request, but the requested action is not allowed.

Code Samples

PHP

<?php

const BASE_URL = 'https://integrate.d6plus.co.za/api/v1/finplus/debtmanagement/promisetopays/notes';
const SCHOOL_LOGIN_ID = '1000';
const PARAMS = [
    'promise_to_pay_id' => 12,
    'accountable_person_id' => 40,
    'debtor_code' => 1001,
    'promise_completed' => 'Partial',
    'year_promised' => 2024,
    'include_debtor_note' => 1
    ];
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 . '?' . $query,
    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