Skip to main content

Get Bill Bundles

Overview

Description: This endpoint retrieves a list of bundles with detailed information

Endpoint: {base_url}/bundles

RESPONSE PARAMETER

#ParameterTypeDescriptionMandatory
1bundleDtosArray of ObjectsList of bundle detailsYes
2bundleDtos.amountIntegerAmount associated with the bundleYes
3bundleDtos.bundleidIntegerUnique identifier for the bundleYes
4bundleDtos.descriptionStringDescription of the bundleNo
5bundleDtos.nameStringName of the bundleYes
6countIntegerNumber of bundles returnedYes
7errorStringError message if applicableNo
8execTimeStringExecution time of the requestNo
9hasnextBooleanIndicates if there is a next pageYes
10haspreviousBooleanIndicates if there is a previous pageYes
11islastBooleanIndicates if this is the last pageYes
12limitIntegerMaximum number of items per requestYes
13messageStringAdditional message about the responseNo
14offsetIntegerOffset value for paginationYes
15statusIntegerStatus code of the responseYes
16totalIntegerTotal number of bundles availableYes

SAMPLE RESPONSE

GET {base_url}/bundles
{
"bundleDtos": [
{
"amount": 0,
"bundleid": 0,
"description": "string",
"name": "string"
}
],
"count": 0,
"error": "string",
"execTime": "string",
"hasnext": true,
"hasprevious": true,
"islast": true,
"limit": 0,
"message": "string",
"offset": 0,
"status": 0,
"total": 0
}