Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
StatementDefinition

Create StatementDefinition

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

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.

aggregationFrequency'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'WHOLE_PERIOD' required

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.

aggregationFrequency'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'WHOLE_PERIOD'

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.