Get All Bills

Overview

Description: This endpoint retrieves a list of bill transactions with details and pagination support

Endpoint: {base_url}/allbills

REQUEST PARAMETER

Request Parameters

Request Parameters

#	Parameter	Type	Description	Required?
1	endDate	String	The end date for the query, in ISO 8601 format.	Yes
2	page	Integer	The page number for pagination	Yes
3	size	Integer	The number of records per page	Yes
4	startDate	String	The start date for the query, in ISO 8601 format	Yes

Response Parameters

Response Parameters

#	Parameter	Type	Description	Mandatory
1	bills	Array of Objects	List of bill transactions	Yes
2	bills.amount	Integer	Amount associated with the bill	Yes
3	bills.billdesc	String	Description of the bill	No
4	bills.billerserviceid	String	Unique identifier for the biller service	Yes
5	bills.billsessionid	String	Unique session ID for the bill transaction	Yes
6	bills.clientid	Integer	Client identifier related to the bill	Yes
7	bills.createdat	String	Timestamp when the bill was created (ISO 8601)	Yes
8	bills.createdby	String	User who created the bill	No
9	bills.id	Integer	Unique identifier for the bill	Yes
10	bills.merchantreference	String	Reference ID from the merchant	No
11	bills.modifiedat	String	Timestamp when the bill was last modified (ISO 8601)	No
12	bills.modifiedby	String	User who last modified the bill	No
13	bills.notificationreference	String	Reference for notification purposes	No
14	bills.status	String	Status of the bill transaction (e.g., APPROVED)	Yes
15	bills.username	String	Username associated with the bill transaction	No
16	bills.validationamount	Integer	Amount validated for the transaction	No
17	bills.validationreference	String	Reference ID for validation	No
18	bills.valuereceived	Boolean	Indicates if value has been received	Yes
19	count	Integer	Number of bills returned	Yes
20	error	String	Error message if applicable	No
21	execTime	String	Execution time of the request	No
22	hasnext	Boolean	Indicates if there is a next page	Yes
23	hasprevious	Boolean	Indicates if there is a previous page	Yes
24	islast	Boolean	Indicates if this is the last page	Yes
25	limit	Integer	Maximum number of items per request	Yes
26	message	String	Additional message about the response	No
27	offset	Integer	Offset value for pagination	Yes
28	status	Integer	Status code of the response	Yes
29	total	Integer	Total number of bills available	Yes

Sample Request

Request Parameters

POST {base_url}/allbills

curl `${base_url}/allbills`
-H "Content-type: application/json"
-X POST
-d '{
  "endDate": "2025-02-11T10:39:10.598Z",
  "page": 0,
  "size": 0,
  "startDate": "2025-02-11T10:39:10.598Z"
}
'

Sample Response

Response Parameters

POST {base_url}/allbills

{
  "bills": [
    {
      "amount": 0,
      "billdesc": "string",
      "billerserviceid": "string",
      "billsessionid": "string",
      "clientid": 0,
      "createdat": "2025-02-11T10:39:10.596Z",
      "createdby": "string",
      "id": 0,
      "merchantreference": "string",
      "modifiedat": "2025-02-11T10:39:10.596Z",
      "modifiedby": "string",
      "notificationreference": "string",
      "status": "APPROVED",
      "username": "string",
      "validationamount": 0,
      "validationreference": "string",
      "valuereceived": true
    }
  ],
  "count": 0,
  "error": "string",
  "execTime": "string",
  "hasnext": true,
  "hasprevious": true,
  "islast": true,
  "limit": 0,
  "message": "string",
  "offset": 0,
  "status": 0,
  "total": 0
}