GET /api/v3/bill/{billId}/bodyline Deprecated

Retrieves one bill's bodylines

GetBillBodylinesV3 Permissions: BillsAndBatches (View)

Paginated endpoint — This API returns paginated results. Use the pageNumber and pageSize query parameters to control which page of results is returned. The response includes pagination metadata in the response headers. See the Pagination guide for details.

Request Headers

Header	Value	Required	Description
ECI-ApiKey	string	Yes	Your API key. See Authentication.
Content-Type	application/json	Yes	All requests must specify JSON content type.

Path Parameters

Name	Description	Type	Required
billId	The bill identifier	integer (int32)	Required

Query Parameters

Name	Description	Type	Required
pageSize	The number of elements to return in a page	integer (int32)	Optional
pageNumber	The current page number	integer (int32)	Optional

Response Headers

This endpoint returns pagination metadata in the response headers.

Header	Type	Description
PageNumber	integer	The current page number (1-based).
PageSize	integer	The maximum number of items per page.
TotalNumberOfRecords	integer	The total number of records matching the query across all pages.
TotalPages	integer	The total number of pages. Increment pageNumber until it equals this value to retrieve all results.

See the Pagination guide for iteration examples and best practices.

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

BodylineResponse

Property

Description

Type

account

AccountChild

AccountChild properties

Property

Description

Type

accountCode

string

accountId

integer (int32)

accountInfo

string

active

boolean

hasCalculatedMeter

boolean

hasSplitChildMeter

boolean

hasSplitParentMeter

boolean

hasSubAccount

boolean

isSubAccount

boolean

vendor

VendorChild

VendorChild properties

Property	Description	Type
vendorCode	The vendor code	string
vendorId	The vendor identifier	integer (int32)
vendorInfo	The vendor info	string

billId

The bill identifier

integer (int32)

bodylineId

The bodyline identifier

integer (int32)

caption

The caption

string

commodity

CommodityChild

CommodityChild properties

Property

Description

Type

commodityCode

The commodity code Required (defined)

string

commodityIcon

Icon

Icon properties

Property	Description	Type
code	The icon code Must be between 0 and 64 characters Required when Color is set	string
color	The icon color Must be between 0 and 32 characters Required when Code is set	string

commodityId

The commodity identifier Required (defined)

integer (int32)

commodityInfo

The commodity info Required (defined)

string

cost

The cost attributed to the bodyline

number (double)

costUnit

UnitChild

UnitChild properties

Property	Description	Type
unitCode	The unit code	string
unitId	The unit identifier	integer (int32)
unitInfo	The unit info	string

displayOrder

The display order

integer (int32)

generalLedger

GeneralLedgerChild

GeneralLedgerChild properties

Property	Description	Type
generalLedgerCode		string
generalLedgerId		integer (int32)
generalLedgerInfo		string

helpTag

The help tag

string

meter

MeterChild

MeterChild properties

Property

Description

Type

active

Indicates whether the Meter is Active

boolean

commodity

CommodityChild

CommodityChild properties

Property

Description

Type

commodityCode

The commodity code Required (defined)

string

commodityIcon

Icon

Icon properties

Property	Description	Type
code	The icon code Must be between 0 and 64 characters Required when Color is set	string
color	The icon color Must be between 0 and 32 characters Required when Code is set	string

commodityId

The commodity identifier Required (defined)

integer (int32)

commodityInfo

The commodity info Required (defined)

string

isCalculatedMeter

Indicates whether the meter is a calculated meter

boolean

isEsaCalculatedMeter

Indicates whether the meter is an ESA calculated meter

boolean

isSplitChildMeter

Indicates whether the meter is a child of a split

boolean

isSplitParentMeter

Indicates whether the meter is a parent of a split

boolean

meterCode

The meter code

string

meterId

The meter identifier

integer (int32)

meterInfo

The meter info

string

meterType

MeterTypeChild

MeterTypeChild properties

Property	Description	Type
meterTypeCode		string
meterTypeId		integer (int32)
meterTypeInfo		string

serialNumber

The meter’s current serial number

string

observationType

ObservationTypeChild

ObservationTypeChild properties

Property	Description	Type
credit	Indicates the type of credit for the observation type. Possible values include: 1 (Credit), 2 (Debit), 3 (Ignore)	integer (int32)
nounCode	The observation type’s noun code	string
nounId	The identifier for the observation type’s noun	integer (int32)
observationTypeCode	The observation type code	string
observationTypeId	The observation type identifier	integer (int32)
observationTypeInfo	The observation type info	string

unit

UnitChild

UnitChild properties

Property	Description	Type
unitCode	The unit code	string
unitId	The unit identifier	integer (int32)
unitInfo	The unit info	string

value

The bodyline’s value

number (double)

Example Response application/json

[
  {    "account": {      "accountCode": "string",      "accountId": 1,      "accountInfo": "string",      "active": false,      "hasCalculatedMeter": false,      "hasSplitChildMeter": false,      "hasSplitParentMeter": false,      "hasSubAccount": false,      "isSubAccount": false,      "vendor": {}
    },    "billId": 1,    "bodylineId": 1,    "caption": "string",    "commodity": {      "commodityCode": "string",      "commodityIcon": {},      "commodityId": 1,      "commodityInfo": "string"
    },    "cost": 1.0,    "costUnit": {      "unitCode": "string",      "unitId": 1,      "unitInfo": "string"
    },    "displayOrder": 1,    "generalLedger": {      "generalLedgerCode": "string",      "generalLedgerId": 1,      "generalLedgerInfo": "string"
    },    "helpTag": "string",    "meter": {      "active": false,      "commodity": {},      "isCalculatedMeter": false,      "isEsaCalculatedMeter": false,      "isSplitChildMeter": false,      "isSplitParentMeter": false,      "meterCode": "string",      "meterId": 1,      "meterInfo": "string",      "meterType": {},      "serialNumber": "string"
    },    "observationType": {      "credit": 1,      "nounCode": "string",      "nounId": 1,      "observationTypeCode": "string",      "observationTypeId": 1,      "observationTypeInfo": "string"
    },    "unit": {      "unitCode": "string",      "unitId": 1,      "unitInfo": "string"
    },    "value": 1.0
  }
]