Sign in

v10

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

Delete StatementDefinition

Delete a StatementDefinition with the given UUID.

This endpoint deletes a specific StatementDefinition within a specified Organization, using the StatementDefinition UUID.

delete/organizations/{orgId}/statementdefinitions/{id}

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

Response

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