Aged payables

Aged payables is a financial report that categorizes a company’s outstanding bills or invoices owed to suppliers based on how long they have been outstanding.

Get All Aged payables

To get all aged payables, make a GET request to the /api/v3/reports/aged-payables/list?date&range= endpoint. Sample request using axios:

content_copyjs
const response = await axios.get(
  "/api/v3/reports/aged-payables/list?date&range=",
);

Where <date> is the selected date and <range> is the range of the aged payables list

Sample Response object:

content_copyjson
{
  "list": [
    {
      "id": 1,
      "owner_id": 1,
      "business_id": 1,
      "supplier_name": "Amtek",
      "supplier_address": "",
      "supplier_phone": "0536474574",
      "supplier_location": "",
      "supplier_email": "[email protected]",
      "created_at": "2020-03-05 16:51:21",
      "updated_at": "2024-06-27 14:23:08",
      "bank_code": "RCP_r2fxrgofxh2ibdi",
      "account_number": null,
      "account_name": null,
      "bank_id": "MTN",
      "account_id": 92,
      "archived": 0,
      "supplier_id": 1,
      "total_aged_payables": 59402.5,
      "1_To_30_days": 0,
      "31_To_60_days": 0,
      "61_To_90_days": 0,
      "over_91_days": 59402.5
    },
    {
      "id": 222,
      "owner_id": 1,
      "business_id": 1,
      "supplier_name": "Best Buy",
      "supplier_address": null,
      "supplier_phone": null,
      "supplier_location": null,
      "supplier_email": null,
      "created_at": "2020-04-24 12:14:43",
      "updated_at": "2020-04-24 12:14:43",
      "bank_code": "RCP_k9yuly3z1o0i5me",
      "account_number": null,
      "account_name": "",
      "bank_id": "030100",
      "account_id": 3666,
      "archived": 0,
      "supplier_id": 222,
      "total_aged_payables": 44800,
      "1_To_30_days": 0,
      "31_To_60_days": 0,
      "61_To_90_days": 0,
      "over_91_days": 44800
    },
    {
      "id": 269,
      "owner_id": 1,
      "business_id": 1,
      "supplier_name": "Blue Pens",
      "supplier_address": null,
      "supplier_phone": null,
      "supplier_location": null,
      "supplier_email": null,
      "created_at": "2020-06-09 13:37:53",
      "updated_at": "2020-06-09 13:37:53",
      "bank_code": null,
      "account_number": null,
      "account_name": null,
      "bank_id": null,
      "account_id": 9627,
      "archived": 0,
      "supplier_id": 269,
      "total_aged_payables": 1100,
      "1_To_30_days": 0,
      "31_To_60_days": 0,
      "61_To_90_days": 0,
      "over_91_days": 1100
    }
  ],
  "summaries": {
    "total_1_To_30_days": 138190.12,
    "total_31_To_60_days": 111600,
    "total_61_To_90_days": 86050,
    "total_over_91_days": 826752893.66,
    "total_over_all": 827093983.78
  },
  "headers": {
    "1_To_30_days": {
      "title": "1 - 30 Days",
      "valueKey": "1_To_30_days",
      "totalKey": "total_1_To_30_days"
    },
    "31_To_60_days": {
      "title": "31 - 60 Days",
      "valueKey": "31_To_60_days",
      "totalKey": "total_31_To_60_days"
    },
    "61_To_90_days": {
      "title": "61 - 90 Days",
      "valueKey": "61_To_90_days",
      "totalKey": "total_61_To_90_days"
    },
    "over_91_days": {
      "title": "Over 91 Days",
      "valueKey": "over_91_days",
      "totalKey": "total_over_91_days"
    }
  }
}

Sending an Aged Receivable

To send an aged receivable, you will need to draft message, and enter suppier’s email address to send an aged receivable. Make a POST request to /supplier/transactions/send/id?from=<startdate>&to=<enddate> endpoint to send an aged receivable. Sample request using axios:

content_copyjs
const response = await axios.post(
  "/api/v3/reports/aged-payables/send/id?from=<startdate>&to=<enddate>",
  {
    send_tome: "2024-11-07", // The send time of the aged payable
    other_emails: ["[email protected]", "[email protected]"], // The other email addresses to send the aged payable to
    message:
      "This is the message to be sent with the aged payable notification.", // The message of the aged payable 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 aged payable to the supplier:

content_copyjson
{
   "Transactions sent"
}