M3m3ter-com
StatementDefinition

Retrieve StatementDefinition

Changed on

Retrieve a StatementDefinition with the given UUID.

Retrieves the details of a specific StatementDefinition for the specified Organization, using its unique identifier (UUID). This endpoint is useful when you want to retrieve the complete details of a single StatementDefinition.

get/organizations/{orgId}/statementdefinitions/{id}

Request

Path parameters

orgIdstring required

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

idstring required

The unique identifier (UUID) of the StatementDefinition to retrieve.

Response

Returns the 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.

Changes

  • 85c514abc692Revision changes
    • breaking

      the response's property type changed from no type to object for status

  • 0f92c877619fRevision changes
    • 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 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