Tariff

List all tariffs.

get

List all tariffs.

Responses

get

HTTPcURLJavaScriptPython

GET //tariff HTTP/1.1
Host: api.ecosuite.io
Accept: */*

{
  "tariffs": [
    null
  ]
}

Create a new tariff.

post

Create a new tariff.

Body

providerstring · enumRequiredPossible values:

Responses

post

HTTPcURLJavaScriptPython

POST //tariff HTTP/1.1
Host: api.ecosuite.io
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "provider": "openei"
}

{
  "tariff": {
    "assetType": "text",
    "author": "text",
    "created": "2025-04-30",
    "id": "text",
    "lastUpdated": "2025-04-30",
    "lastUpdatedBy": "text",
    "path": "text",
    "provider": "openei"
  }
}

Update a tariff.

put

Update a tariff.

Body

assetTypestringRead-onlyOptionalDefault: tariff

authorstringRead-onlyOptional

createdstring · dateRead-onlyOptional

idstringRead-onlyOptional

lastUpdatedstring · dateRead-onlyOptional

lastUpdatedBystringRead-onlyOptional

pathstringRead-onlyOptionalDefault: /

providerstring · enumRequiredPossible values:

Responses

put

HTTPcURLJavaScriptPython

PUT //tariff HTTP/1.1
Host: api.ecosuite.io
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "provider": "openei"
}

{
  "tariff": {
    "assetType": "text",
    "author": "text",
    "created": "2025-04-30",
    "id": "text",
    "lastUpdated": "2025-04-30",
    "lastUpdatedBy": "text",
    "path": "text",
    "provider": "openei"
  }
}

Get a tariff.

get

Get a tariff.

Path parameters

tariffIdstringRequired

The ID of the tariff.

Responses

get

HTTPcURLJavaScriptPython

GET //tariff/{tariffId} HTTP/1.1
Host: api.ecosuite.io
Accept: */*

{
  "tariff": {
    "assetType": "text",
    "author": "text",
    "created": "2025-04-30",
    "id": "text",
    "lastUpdated": "2025-04-30",
    "lastUpdatedBy": "text",
    "path": "text",
    "provider": "openei"
  }
}

Delete a tariff.

delete

Delete a tariff.

Path parameters

tariffIdstringRequired

The ID of the tariff.

Responses

delete

HTTPcURLJavaScriptPython

DELETE //tariff/{tariffId} HTTP/1.1
Host: api.ecosuite.io
Accept: */*

{
  "deleted": "text"
}