Delete Promise To Pay

Delete a Promise To Pay record

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

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

The promise_to_pay_id is required and can be found using the Get Promise To Pay(s) or Get Note(s) call.

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 the promise-to-pay to delete

Response Examples

200 The request was successful.

{
    "status": "Deleted"
}

404: Not Found The resource was not found.

{
    "error": "Not found",
    "error_description": "The Promise To Pay does not exist"
}

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

{
    "error": "Unauthorized",
    "error_description": "Client access not authorised"
}

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

{
    "error": "Integration not activated",
    "error_description": "Please activate the Admin+ API for this client before making this request"
}

Code Samples

PHP

<?php

const BASE_URL = 'https://integrate.d6plus.co.za/api/v1/finplus/debtmanagement/debtornotes/promisetopays';
const SCHOOL_LOGIN_ID = '1000';
const PARAMS = [
    'promise_to_pay_id' => 7
    ];
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 => 'DELETE',
    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

curl --location --request DELETE 'https://integrate.d6plus.co.za/api/v1/finplus/debtmanagement/debtornotes/promisetopays/1000?promise_to_pay_id=7' \
--header 'HTTP-X-USERNAME: your_username' \
--header 'HTTP-X-PASSWORD: your_password'