List Sales

A list of all sales may be obtained using this endpoint. For emphasis on specific results, you can add filters based on date, status, customer, and other variables.

Endpoint

GET https://api.xtrakit.com/api/v1/sales

Headers

Authorization: Bearer API_KEY

Query Parameters

Parameters	Type	Description
invoice_code string	Optional	Specify invoice code to retreive
customer_id number	Optional	Filter sales by customer ID
invoice_type string	Optional	Filter sales based on the invoice type (pos, invoice, storefront)
payment_date date	Optional	Filter sales by payment date
payment_status string	Optional	Filter sales by payment status (paid, partial, draft)
created_at datetime	Optional	Start date for filtering sales records (format: YYYY-MM-DD H:m:s)
due_date date	Optional	End date for filtering sales records (format: YYYY-MM-DD)

Sample Requests

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.xtrakit.com/api/v1/sales',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer API_KEY', // Replace 'API_KEY' with your actual API key
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

?>

NodeJS

Python

Sample Response

Success

{
    "status": 200,
    "message": "Sales found: 20",
    "data": {
        "sales": {
            "id": 32,
            "invoice_code": 324232,
            "invoice_number": "INV-000001",
            "customer_id": "42",
            "sub_total_amount": "100.00",
            "total_amount": "200.00",
            "amount_paid": "200.00",
            "discount": "0.00",
            "invoice_type": "pos",
            "invoice_colour": "#FFFFFF",
            "invoice_note": null,
            "invoice_terms": "Thanks for doing business",
            "payment_internal_note": null,
            "payment_date": "2024-08-04",
            "payment_type": "2024-08-04",
            "payment_status": "paid",
            "issued_by": "Jones Nathal",
            "due_date": "2024-08-30",
            "reminder_date": "2024-08-25",
            "reminder_message": null,
            "created_at": "2024-08-04 08:23:45",
            "updated_at": "2024-08-04 02:00:43"
        },
        ...
    }
}

Error