Get Transaction Type(s)
Retrieve transaction types
GET
https://integrate.d6plus.co.za/api/v1/finplus/debtmanagement/transactiontypes/{school_login_id}
Use this endpoint to retrieve the list of available transaction types. By default all available transaction types are returned.
It is possible to retrieve the information for a single transaction type by providing the optional transaction_type_id
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
transaction_type_id
Integer
The id of the transaction type to retrieve
Response Examples
[
{
"id": "1",
"name": "General Journal"
},
{
"id": "2",
"name": "Receipt"
},
{
"id": "3",
"name": "Payment"
},
{
"id": "4",
"name": "Deposit"
}
]
Code Samples
<?php
const BASE_URL = 'https://integrate.d6plus.co.za/api/v1/finplus/debtmanagement/transactiontypes';
const SCHOOL_LOGIN_ID = '1000';
const PARAMS = [
'transaction_type_id' => 2
];
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;
Last updated