Delete Promise To Pay

DELETE v2/finplus/debtmanagement/debtornotes/promisetopays/{id}

Use this endpoint to delete a promise-to-pay record for the specified school.

The promise-to-pay ID must be included in the URL and can be found using the Get Promise To Pay(s) or Get Note(s) call.

Only promises with no payment against them may be deleted. If the promise has been partially or fully paid (promise_completed is not "No", or amount_paid is greater than zero), the request will fail with a 403 Forbidden.

Path Parameters

Name	Type	Description
{id}*	Integer	The promise-to-pay ID of the record to delete

Request Headers

Name	Type	Description
HTTP-X-USERNAME*	String	As provided by d6
HTTP-X-PASSWORD*	String	As provided by d6
HTTP-X-SCHOOLID*	Integer	The unique identifier of the school for which the data is being queried.

Response Examples

Success (200 OK)

Status: 200 OK

{
    "success": true,
    "message": "Promise To Pay deleted successfully"
}

ID Missing Error (400 Bad Request)

Description: When no promise-to-pay ID was provided

Status: 400 Bad Request

{
    "success": false,
    "message": "The Promise To Pay ID is required"
}

ID Not Found Error (404 Not Found)

Description: When the promise-to-pay ID does not exist

Status: 404 Not Found

{
    "success": false,
    "message": "The Promise To Pay record does not exist"
}

Already Paid Error (403 Forbidden)

Description: When the promise-to-pay has already been partially or fully paid. Only promises with no payment against them may be deleted.

Status: 403 Forbidden

{
    "success": false,
    "message": "Permission denied to delete Promise To Pay (ID: 12345). The promise has either been partially or fully adhered to."
}

Code Samples

PHP

<?php

<?php

// API Credentials
$api_username = 'your_username';
$api_password = 'your_password';
$school_id = 'the_school_id';

// The Promise To Pay record ID to be deleted (required)
$id = '12345'; // Replace with the actual ID

// API Endpoint
define('BASE_URL', 'https://integrate.d6plus.co.za/api/v2/finplus/debtmanagement/debtornotes/promisetopays');

$url = BASE_URL . '/' . $id;

// Initialize cURL
$curl = curl_init();

// Set cURL options
curl_setopt_array($curl, [
    CURLOPT_URL            => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT        => 30,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST  => 'DELETE',
    CURLOPT_HTTPHEADER     => [
        "HTTP-X-USERNAME: $api_username",
        "HTTP-X-PASSWORD: $api_password",
        "HTTP-X-SCHOOLID: $school_id"
    ],
]);

// Execute request
$response = curl_exec($curl);

// Check for errors
$error = curl_error($curl);
if ($error) {
    curl_close($curl);
    throw new Exception("cURL Error: $error");
}

// Close cURL and output response
curl_close($curl);
echo $response;

cURL

curl --request DELETE 'https://integrate.d6plus.co.za/api/v2/finplus/debtmanagement/debtornotes/promisetopays/12345' \
     --header 'HTTP-X-USERNAME: your_username' \
     --header 'HTTP-X-PASSWORD: your_password' \
     --header 'HTTP-X-SCHOOLID: the_school_id'