Retrieve Line Item

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/bills/{billId}/lineitems/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "version": 123,
  "lineItemType": "STANDING_CHARGE",
  "productId": "<string>",
  "description": "<string>",
  "servicePeriodStartDate": "2023-11-07T05:31:56Z",
  "servicePeriodEndDate": "2023-11-07T05:31:56Z",
  "referencedBillId": "<string>",
  "referencedLineItemId": "<string>",
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "productName": "<string>",
  "productCode": "<string>",
  "accountingProductId": "<string>",
  "accountingProductName": "<string>",
  "accountingProductCode": "<string>",
  "aggregationId": "<string>",
  "compoundAggregationId": "<string>",
  "counterId": "<string>",
  "chargeId": "<string>",
  "segment": {},
  "group": {},
  "meterId": "<string>",
  "planId": "<string>",
  "planGroupId": "<string>",
  "commitmentId": "<string>",
  "balanceId": "<string>",
  "billId": "<string>",
  "quantity": 123,
  "units": 123,
  "unit": "<string>",
  "subtotal": 123,
  "currency": "<string>",
  "conversionRate": 123,
  "convertedSubtotal": 123,
  "creditTypeId": "<string>",
  "pricingId": "<string>",
  "bandUsage": [
    {
      "pricingBandId": "<string>",
      "lowerLimit": 123,
      "fixedPrice": 123,
      "unitSubtotal": 123,
      "unitPrice": 123,
      "bandUnits": 123,
      "bandQuantity": 123,
      "bandSubtotal": 123,
      "creditTypeId": "<string>",
      "convertedBandSubtotal": 123
    }
  ],
  "reasonId": "<string>",
  "contractId": "<string>",
  "jsonUsageGenerated": true,
  "averageUnitPrice": 123,
  "sequenceNumber": 123,
  "additional": {}
}

GET

organizations

{orgId}

bills

{billId}

lineitems

{id}

Retrieve Line Item

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/bills/{billId}/lineitems/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "version": 123,
  "lineItemType": "STANDING_CHARGE",
  "productId": "<string>",
  "description": "<string>",
  "servicePeriodStartDate": "2023-11-07T05:31:56Z",
  "servicePeriodEndDate": "2023-11-07T05:31:56Z",
  "referencedBillId": "<string>",
  "referencedLineItemId": "<string>",
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "productName": "<string>",
  "productCode": "<string>",
  "accountingProductId": "<string>",
  "accountingProductName": "<string>",
  "accountingProductCode": "<string>",
  "aggregationId": "<string>",
  "compoundAggregationId": "<string>",
  "counterId": "<string>",
  "chargeId": "<string>",
  "segment": {},
  "group": {},
  "meterId": "<string>",
  "planId": "<string>",
  "planGroupId": "<string>",
  "commitmentId": "<string>",
  "balanceId": "<string>",
  "billId": "<string>",
  "quantity": 123,
  "units": 123,
  "unit": "<string>",
  "subtotal": 123,
  "currency": "<string>",
  "conversionRate": 123,
  "convertedSubtotal": 123,
  "creditTypeId": "<string>",
  "pricingId": "<string>",
  "bandUsage": [
    {
      "pricingBandId": "<string>",
      "lowerLimit": 123,
      "fixedPrice": 123,
      "unitSubtotal": 123,
      "unitPrice": 123,
      "bandUnits": 123,
      "bandQuantity": 123,
      "bandSubtotal": 123,
      "creditTypeId": "<string>",
      "convertedBandSubtotal": 123
    }
  ],
  "reasonId": "<string>",
  "contractId": "<string>",
  "jsonUsageGenerated": true,
  "averageUnitPrice": 123,
  "sequenceNumber": 123,
  "additional": {}
}

Authorizations

Authorization

string

header

required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

orgId

string

required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

billId

string

required

The unique identifier (UUID) of the Bill containing the line item.

string

required

The unique identifier (UUID) of the line item you want to retrieve.

Query Parameters

additional

string[]

Comma separated list of additional fields.

Response

Returns the requested line item from a Bill

string

required

The UUID of the entity.

version

integer<int64>

The version number:

Create: On initial Create to insert a new entity, the version is set at 1 in the response.
Update: On successful Update, the version is incremented by 1 in the response.

lineItemType

enum<string>

Available options:

STANDING_CHARGE,

USAGE,

COUNTER_RUNNING_TOTAL_CHARGE,

COUNTER_ADJUSTMENT_DEBIT,

COUNTER_ADJUSTMENT_CREDIT,

USAGE_CREDIT,

MINIMUM_SPEND,

MINIMUM_SPEND_REFUND,

CREDIT_DEDUCTION,

MANUAL_ADJUSTMENT,

CREDIT_MEMO,

DEBIT_MEMO,

COMMITMENT_CONSUMED,

COMMITMENT_FEE,

OVERAGE_SURCHARGE,

OVERAGE_USAGE,

BALANCE_CONSUMED,

BALANCE_FEE,

AD_HOC

productId

string

description

string

servicePeriodStartDate

string<date-time>

servicePeriodEndDate

string<date-time>

referencedBillId

string

referencedLineItemId

string

dtCreated

string<date-time>

The DateTime when the line item was created.

dtLastModified

string<date-time>

The DateTime when the line item was last modified.

createdBy

string

The ID of the user who created this line item.

lastModifiedBy

string

The ID of the user who last modified this line item.

productName

string

The name of the Product associated with this line item.

productCode

string

The code of the Product associated with this line item.

accountingProductId

string

The unique identifier (UUID) for the associated Accounting Product.

accountingProductName

string

The name of the Accounting Product associated with this line item.

accountingProductCode

string

The code of the Accounting Product associated with this line item.

aggregationId

string

A unique identifier (UUID) for the Aggregation that contributes to this Bill line item.

compoundAggregationId

string

A unique identifier (UUID) for the Compound Aggregation, if applicable.

counterId

string

The unique identifier (UUID) for the Counter associated with this line item.

chargeId

string

The unique identifier (UUID) for the Charge associated with this line item.

segment

object

Specifies the segment name or identifier when segmented Aggregation is used. This is relevant for more complex billing structures.

Show child attributes

group

object

Show child attributes

meterId

string

The unique identifier (UUID) of the Meter responsible for tracking usage.

planId

string

A unique identifier (UUID) for the billing Plan associated with this line item.

planGroupId

string

The unique identifier (UUID) of the Plan Group associated with this line item.

commitmentId

string

The unique identifier (UUID) of the Commitment associated with this line item.

balanceId

string

The unique identifier (UUID) for the Balance associated with this line item.

billId

string

The unique identifier (UUID) for the Bill that includes this line item.

quantity

number

The amount of the product or service used in this line item.

units

number

The number of units rated in the line item, each of which is of the type specified in the unit field. For example: 400 api_calls.

In this example, the unit type of api_calls is read from the unit field.

unit

string

Specifies the unit type. For example: MB, GB, api_calls, and so on.

subtotal

number

The subtotal amount when not currency converted (in the cases where currency conversion is required).

currency

string

The currency in which the line item is billed, represented as a currency code. For example, USD, GBP, or EUR.

conversionRate

number

The currency conversion rate (if used) for the line item.

convertedSubtotal

number

The subtotal amount for this line item after currency conversion, if applicable.

creditTypeId

string

The unique identifier (UUID) for the type of credit applied to this line item.

pricingId

string

The unique identifier (UUID) of the Pricing used for this line item,

bandUsage

object[]

Array containing the pricing band information, which shows the details for each pricing band or tier.

Show child attributes

reasonId

string

A unique identifier (UUID) for the reason or justification for this line item, if applicable.

contractId

string

The unique identifier (UUID) for the Contract associated with this line item.

jsonUsageGenerated

boolean

deprecated

Boolean flag indicating whether the Bill line item has associated statement usage in JSON format. When a Bill statement is generated, usage line items have their usage stored in JSON format.

averageUnitPrice

number

Represents the average unit price calculated across all pricing bands or tiers for this line item.

sequenceNumber

integer<int32>

The line item sequence number.

additional

object

Retrieve Bills for an Account ID

Lock Bill

⌘I

Getting Started

Endpoints

Retrieve Line Item

Authorizations

Path Parameters

Query Parameters

Response