Sign in
Balances

Delete Balance

Delete a specific Balance.

This endpoint allows you to delete a specific Balance with the given UUID.

delete/organizations/{orgId}/balances/{id}

Path parameters

orgIdstring required

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

idstring required

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

Response

Returns the deleted Balance

idstring required

The UUID of the entity.

versioninteger

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.
customFieldsobject

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.

codestring

A unique short code assigned to the Balance.

namestring

The official name of the Balance.

descriptionstring

A description of the Balance.

accountIdstring

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

amountnumber

The financial value that the Balance holds.

currencystring

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

startDatestring date-time

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

endDatestring date-time

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

rolloverAmountnumber

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.

rolloverEndDatestring 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.

balanceDrawDownDescriptionstring

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

overageSurchargePercentnumber double

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

overageDescriptionstring

A description for overage charges.

productIdsstring[]

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

lineItemTypesBalanceLineItemType[]

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

contractIdstring

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

consumptionsAccountingProductIdstring

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

feesAccountingProductIdstring

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

dtCreatedstring date-time

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

dtLastModifiedstring date-time

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

createdBystring

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

lastModifiedBystring

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

Changes

Changed in 3 of the 10 revisions of this API.114

  • 0f92c877619f1See the full diff
    • ●

      added the new AD_HOC enum value to the allOf[subschema #3]/lineItemTypes/items/ response property for the response status 200

      response-property-enum-value-added

  • 9f9e5f3dbde712See the full diff
    • ▲

      the response property allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    • ○

      added AbstractResponseWithCustomFields to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      added the optional property allOf[subschema #2 -> subschema #3]/contractId to the response with the 200 status

      response-optional-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d064a12d0d932See the full diff
    • ○

      added the optional property allOf[subschema #2]/consumptionsAccountingProductId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/feesAccountingProductId to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog