Delete Balance

Delete Balance

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

{
  "id": "<string>",
  "version": 123,
  "customFields": {},
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "accountId": "<string>",
  "amount": 123,
  "currency": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "rolloverAmount": 123,
  "rolloverEndDate": "2023-11-07T05:31:56Z",
  "balanceDrawDownDescription": "<string>",
  "overageSurchargePercent": 123,
  "overageDescription": "<string>",
  "productIds": [
    "<string>"
  ],
  "lineItemTypes": [
    "STANDING_CHARGE"
  ],
  "contractId": "<string>",
  "consumptionsAccountingProductId": "<string>",
  "feesAccountingProductId": "<string>",
  "allowOverdraft": true,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>"
}

DELETE

organizations

{orgId}

balances

{id}

Delete Balance

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

{
  "id": "<string>",
  "version": 123,
  "customFields": {},
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "accountId": "<string>",
  "amount": 123,
  "currency": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "rolloverAmount": 123,
  "rolloverEndDate": "2023-11-07T05:31:56Z",
  "balanceDrawDownDescription": "<string>",
  "overageSurchargePercent": 123,
  "overageDescription": "<string>",
  "productIds": [
    "<string>"
  ],
  "lineItemTypes": [
    "STANDING_CHARGE"
  ],
  "contractId": "<string>",
  "consumptionsAccountingProductId": "<string>",
  "feesAccountingProductId": "<string>",
  "allowOverdraft": true,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<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

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

string

required

The unique identifier (UUID) of the Balance to delete.

Response

Returns the deleted Balance

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.

customFields

object

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level,customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

code

string

A unique short code assigned to the Balance.

name

string

The official name of the Balance.

description

string

A description of the Balance.

accountId

string

The unique identifier (UUID) for the end customer Account the Balance belongs to.

amount

number

The financial value that the Balance holds.

currency

string

The currency code used for the Balance amount. For example: USD, GBP or EUR.

startDate

string<date-time>

The date (in ISO 8601 format) when the Balance becomes active.

endDate

string<date-time>

The date (in ISO 8601 format) after which the Balance will no longer be active.

rolloverAmount

number

The maximum amount that can be carried over past the Balance end date and draw-down against for billing if there is an unused Balance amount remaining when the Balance end date is reached.

rolloverEndDate

string<date-time>

The end date (in ISO 8601 format) for the rollover grace period, which is the period that unused Balance amounts can be carried over beyond the specified Balance endDate and continue to be drawn-down against for billing.

balanceDrawDownDescription

string

A description for the bill line items for charges drawn-down against the Balance.

overageSurchargePercent

number<double>

The percentage surcharge applied to overage charges (usage above the Balance).

overageDescription

string

A description for overage charges.

productIds

string[]

A list of Product IDs whose consumption charges due at billing can be drawn-down against the Balance amount.

lineItemTypes

enum<string>[]

A list of line item charge types that can draw-down against the Balance amount at billing.

Available line item types for Balances

Available options:

STANDING_CHARGE,

USAGE,

MINIMUM_SPEND,

COUNTER_RUNNING_TOTAL_CHARGE,

COUNTER_ADJUSTMENT_DEBIT,

AD_HOC

contractId

string

The unique identifier (UUID) for a Contract on the Account the Balance has been added to.

consumptionsAccountingProductId

string

Product ID that any Balance Consumed line items will be attributed to for accounting purposes.(Optional)

feesAccountingProductId

string

Product ID that any Balance Fees line items will be attributed to for accounting purposes.(Optional)

allowOverdraft

boolean

Allow balance amounts to fall below zero. This feature is enabled on request. Please get in touch with m3ter Support or your m3ter contact if you would like it enabling for your organization(s).

dtCreated

string<date-time>

The date and time (in ISO 8601 format) when the Balance was first created.

dtLastModified

string<date-time>

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

createdBy

string

The unique identifier (UUID) for the user who created the Balance.

lastModifiedBy

string

The unique identifier (UUID) for the user who last modified the Balance.

Update Balance

⌘I

Getting Started

Endpoints

Authorizations

Path Parameters

Response