Expense by Suppliers

Expense by Suppliers is a financial report that outlines the total expenses a business has incurred with individual suppliers over a specified period.

Get All Expense by Suppliers

To get all Expense by Suppliers, make a GET request to the /api/v3/reports/suppliers/:from/:to endpoint. Sample request using axios:

js
const response = await axios.get("/api/v3/reports/suppliers/:from/:to");

Where <from> is the start date and <to> is the end date of the expense by suppliers list

Sample Response object:

json
{
    {
        "id": 1573,
        "owner_id": 1,
        "business_id": 1,
        "supplier_name": "Albert Fynn",
        "supplier_address": "",
        "supplier_phone": "",
        "supplier_location": "",
        "supplier_email": "",
        "created_at": "2021-07-28 23:55:22",
        "updated_at": "2024-11-05 16:56:33",
        "bank_code": null,
        "account_number": null,
        "account_name": null,
        "bank_id": null,
        "account_id": 116258,
        "archived": 1,
        "amount_due": 130,
        "bill_count": 1,
        "balance": 0,
        "amount_paid": 130,
        "online_amount_paid": null,
        "dateFrom": "2024-11-01",
        "dateTo": "2024-11-11",
        "average_payment_terms": 1,
        "total_paid": 130,
        "owing": 0,
        "bills": 1
    },
    {
        "id": 9166,
        "owner_id": 1,
        "business_id": 1,
        "supplier_name": "AAAAAA",
        "supplier_address": "",
        "supplier_phone": "",
        "supplier_location": "",
        "supplier_email": "",
        "created_at": "2023-03-23 14:25:08",
        "updated_at": "2023-03-23 14:25:08",
        "bank_code": "",
        "account_number": null,
        "account_name": null,
        "bank_id": "",
        "account_id": 570543,
        "archived": 0,
        "amount_due": 12,
        "bill_count": 1,
        "balance": 25269.18,
        "amount_paid": null,
        "online_amount_paid": null,
        "dateFrom": "2024-11-01",
        "dateTo": "2024-11-11",
        "average_payment_terms": 0,
        "total_paid": 0,
        "owing": 12,
        "bills": 1
    }
}

Get a Single Expense by a Supplier

Sample axios request to get a single expense by a supplier

js
const response = axios.get("/api/v3/reports/suppliers/:id?from/:to");

<id> is the id of the expense by the supplier
from is the starting date of the expense
to is the ending date of the expense

Filtering of Expense by Suppliers

To filter a expense by suppliers, make a POST request to the /api/v3/reports/suppliers/id?:from/:to endpoint. Sample request using axios:

js
const response = await axios.post(
  "/api/v3/reports/suppliers/id?:from/:to",
  {
    id: 12345, // The id of the expense by a supplier
    from: "2024-11-01", // Represents the start date of the expense by a supplier
    to: "2024-11-30", // Represents the end date of the expense by a supplier
  },
  {
    headers: {
      accept: "application/json",
      authorization: "Bearer <API-KEY>",
      "content-type": "application/json",
    },
  }
);

The Response object returned is the same as the one for getting all expenses by suppliers

Sending an Expense to Supplier

To send an expense to supplier, you will need to draft message, and enter supplier’s email address to send an expense to the supplier. Make a POST request to /api/v3/reports/suppliers/id?:from/:to/send endpoint to send an expense to supplier. Sample request using axios:

js
const response = await axios.post(
  "/api/v3/reports/suppliers/id?:from/:to/send",
  {
    send_tome: "2024-11-07", // The send time of the expense
    other_emails: ["example@example.com", "another@example.com"], // The other email addresses to send the expense to
    message: "This is the message to be sent with the expense notification.", // The message of the expense to be sent to the email address
  },
  {
    headers: {
      accept: "application/json",
      authorization: "Bearer <API-KEY>",
      "content-type": "application/json",
    },
  }
);

Here is an example response received after successfully sending an expense to the supplier:

json
{
   "Transactions sent"
}