Skip to main content
GET
/
organizations
/
{orgId}
/
charges
/
{id}
Retrieve Charge
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/charges/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "version": 123,
  "name": "<string>",
  "code": "<string>",
  "accountId": "<string>",
  "billDate": "2023-12-25",
  "amount": 123,
  "units": 123,
  "unitPrice": 123,
  "currency": "<string>",
  "description": "<string>",
  "entityType": "AD_HOC",
  "entityId": "<string>",
  "billId": "<string>",
  "accountingProductId": "<string>",
  "servicePeriodStartDate": "2023-11-07T05:31:56Z",
  "servicePeriodEndDate": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "contractId": "<string>",
  "lineItemType": "BALANCE_FEE",
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "scheduleId": "<string>"
}

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

UUID of the organization

​
id
string
required

The UUID of the Charge to retrieve.

Response

Return the Charge

Response containing a Charge entity

​
id
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.
​
name
string

Name of the Charge. Added to the Bill line item description for Charge.

​
code
string

The unique short code of the Charge.

​
accountId
string

The ID of the Account the Charge was created for.

​
billDate
string<date>

The date when the Charge will be added to a Bill.

​
amount
number

The Charge amount. If amount has been defined, then units and unitPrice cannot be used.

​
units
number

Number of units of the Charge. Provided together with unitPrice. If units and unitPrice are provided, amount cannot be used.

​
unitPrice
number

Unit Price for the Charge. Provided together with units:

  • Null if the Charge was created with amount only.
  • If units and unitPrice are provided, amount cannot be used.
​
currency
string

Charge currency.

​
description
string

The description added to the Bill line item for the Charge.

​
entityType
enum<string>

The entity type the Charge has been created for.

Available options:
AD_HOC,
BALANCE
​
entityId
string

The ID of the Charge linked entity. For example, the ID of an Account Balance if a Balance Charge.

​
billId
string

The ID of the Bill created for this Charge.

​
accountingProductId
string

The Accounting Product ID assigned to the Charge.

​
servicePeriodStartDate
string<date-time>

The service period start date (in ISO-8601 format) for the Charge .

​
servicePeriodEndDate
string<date-time>

The service period end date (in ISO-8601 format) for the Charge.

NOTE: End date is exclusive.

​
notes
string

Information about the Charge for accounting purposes, such as the reason it was created. This information will not be added to the created Bill line item for the Charge.

​
contractId
string

The ID of a Contract on the Account that the Charge has been added to.

​
lineItemType
enum<string>

The line item type used for billing a Charge.

Available options:
BALANCE_FEE,
AD_HOC
​
dtCreated
string<date-time>

The date and time (in ISO-8601 format) when the Charge was created.

​
dtLastModified
string<date-time>

The date and time (in ISO 8601 format) when the Charge was last modified.

​
createdBy
string

The unique identifier (UUID) of the user who created the Charge.

​
lastModifiedBy
string

The unique identifier (UUID) of the user who last modified the Charge.

​
scheduleId
string

The ID of the Balance Charge Schedule that created the Charge.