iotoms Docs

Delete a draft settlement run

DELETE
/api/v1/commission/settlements/{id}

Deletes a settlement run that is still in DRAFT, together with its lines. Approved runs can never be deleted. Returns the ID of the deleted run.

How to use it

  1. Get the run ID from List commission settlement runs and check its status is DRAFT.
  2. Delete it. The run and its lines are removed; you can start a new run for the same period.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the request: SUCCESS when it worked; errors return an error status with the reason in message.

message*string

Short human-readable message describing the outcome.

data?|

A short text result; for a deleted draft settlement this is the ID of the run that was deleted.

Example Request
curl -X DELETE 'https://beta.iotoms.com/api/v1/commission/settlements/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": "string"}