Account8

AccountPlan6

Aggregation5

Auth1

BalanceChargeSchedule6

Balances8

BalanceTransactionSchedule6

Bill20

BillConfig2

BillGroupingKey5

BillJob5

Charge5

Commitments6

CompoundAggregation5

Contract6

Counter5

CounterAdjustments5

CounterPricing5

CreditReason5

Credits5

Currency5

CustomField2

DataExplorer20

DataExplorerV26

DebitReason5

Debits5

Events4

ExportAdHoc1

ExportDestination6

ExportJob2

ExportSchedule5

External Mapping8

ExternalMappings2

IntegrationConfigs12

IntegrationCredentials5

IntegrationDestinations22

IntegrationRuns7

IntegrationTransformations7

Invitations3

Line Item1

LookupTable5

LookupTableRevision6

LookupTableRevisionData13

Marketplace Integrations1

Measurements6

Meter5

MeterGroup5

Notifications6

OrganizationConfig2

OrgUsers6

PermissionPolicy13

Plan5

PlanGroup5

PlanGroupLink5

PlanTemplate5

Pricing5

Product5

ResourceGroup9

ScheduledEventConfigurations5

ServiceUser6

ServiceUserCredentials6

StatementDefinition5

StatementJob5

Support3

TransactionType5

User1

StatementDefinition

Create StatementDefinition

Changed on Oct 16, 2026

Create a new StatementDefinition.

This endpoint creates a new StatementDefinition within the specified Organization. The details of the StatementDefinition are provided in the request body.

post/organizations/{orgId}/statementdefinitions

Request

Base URL
https://api.m3ter.com
Auth
OAuth 2
Authorization codehttps://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize, token URL https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token
Client credentialsToken URL /oauth/token
TypeScript
https://skmtc.dev/m3ter-com/apis/m3ter-api/docs/organizations/:orgId/statementdefinitions/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

orgIdstring required

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

Request body

versioninteger

The version number of the entity:

Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.

namestring

Descriptive name for the StatementDefinition providing context and information.

This specifies how often the data should be aggregated.

includePricePerUnitboolean

A Boolean indicating whether to include the price per unit in the Statement.

TRUE - includes the price per unit.
FALSE - excludes the price per unit.

generateSlimStatementsboolean

Response

Returns the created StatementDefinition

idstring required

The unique identifier (UUID) of the StatementDefinition.

versioninteger

The version number. Default value when newly created is one.

namestring

Descriptive name for the StatementDefinition providing context and information.

This specifies how often the data should be aggregated.

includePricePerUnitboolean

A Boolean indicating whether to include the price per unit in the Statement.

TRUE - includes the price per unit.
FALSE - excludes the price per unit.

generateSlimStatementsboolean

dtCreatedstring date-time

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

dtLastModifiedstring date-time

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

createdBystring

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

lastModifiedBystring

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

Changes

Oct 16, 202685c514abc692 Revision changes
- breaking
  the request property type changed from no type to object
- breaking
  the response's property type changed from no type to object for status
Aug 29, 20250f92c877619f Revision changes
- breaking
  added the new required request property ///
- breaking
  added the new required request property ///
- breaking
  removed the enum value HOUR of the request property /
- breaking
  removed the enum value ORIGINAL of the request property /
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  added the new CUSTOM_SQL enum value to the //// response property for the response status
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new CUSTOM_SQL enum value to the request property ////
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  removed the HOUR enum value from the / response property for the response status
- info
  removed the ORIGINAL enum value from the / response property for the response status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status

Operation history (3 revisions)