CLclevergy
Contracts|Gas

Create a new gas contract

Creates a new gas contract with the provided details

:::tip Recommended guide If you are unsure which parameters to include when creating a gas contract, refer to the complete documentation. :::

post/users/{userId}/gas-contracts

Request

  • Base URL
    https://connect.clever.gy
  • Auth
    API key in header clevergy-api-key

Path parameters

userIdstring required

ID of user

Request body

startDatestring date required

Start date of the gas contract

endDatestring date

End date of the gas contract

status'ACTIVE' | 'INACTIVE' required

Status of the gas contract

addressstring required

Address associated with the gas contract

postalCodestring

Postal code associated with the gas contract

cupsstring required

Universal Point of Supply Code (CUPS)

tariffAccess'RL01' | 'RL02' | 'RL03' | 'RL04' | 'RL05' | 'RL06' | 'RL07' | 'RL08' | 'RL09' | 'RL10' | 'RL11' required

Tariff access code

tariffNamestring required

Name of the tariff applied to the contract

ibanstring

IBAN for billing purposes

distributorNamestring

Name of the gas distributor company

holderNamestring

Name of the contract holder

commercialNamestring

Name of the commercial gas company

fixedPricenumber

Fixed price component of the gas contract (€/day)

energyPricenumber

Energy price component of the gas contract (€/kWh)

pressurenumber

Supply pressure in bar

contractNumberstring

Contract number

Example request

{
  "startDate": "2023-02-01",
  "endDate": "2024-02-01",
  "status": "ACTIVE",
  "address": "123 Main St, Springfield",
  "postalCode": "12345",
  "cups": "ES1234567890123456AB",
  "tariffAccess": "RL01",
  "tariffName": "Standard Gas Tariff",
  "iban": "ES7620770024003102575766",
  "distributorName": "Gas Distributor S.A.",
  "holderName": "John Doe",
  "commercialName": "Gas Commercial S.L.",
  "fixedPrice": 20.5,
  "energyPrice": 0.065,
  "pressure": 0.5,
  "contractNumber": "GC-12345"
}

Response

Gas contract created successfully

idstring required

Unique identifier of the gas contract

startDatestring date required

Start date of the gas contract

endDatestring date

End date of the gas contract

status'ACTIVE' | 'INACTIVE' required

Status of the gas contract

addressstring required

Address associated with the gas contract

postalCodestring

Postal code associated with the gas contract

connectionIdstring

UUID of the gas connection

connectionContractIdstring

ID of the connection contract

cupsstring required

Universal Point of Supply Code (CUPS)

tariffAccess'RL01' | 'RL02' | 'RL03' | 'RL04' | 'RL05' | 'RL06' | 'RL07' | 'RL08' | 'RL09' | 'RL10' | 'RL11' required

Tariff access code

tariffNamestring required

Name of the tariff applied to the contract

ibanstring

IBAN for billing purposes

distributorNamestring

Name of the gas distributor company

holderNamestring

Name of the contract holder

commercialNamestring

Name of the commercial gas company

fixedPricenumber

Fixed price component of the gas contract (€/day)

energyPricenumber

Energy price component of the gas contract (€/kWh)

pressurenumber

Supply pressure in bar

fileUrlstring required

URL to access the gas contract file. Also used to upload a new contract file as response in POST and PUT methods.

contractNumberstring

Contract number

Example response

{
  "id": "contract-123",
  "startDate": "2023-02-01",
  "endDate": "2024-02-01",
  "status": "ACTIVE",
  "address": "123 Main St, Springfield",
  "postalCode": "12345",
  "connectionId": "conn-456",
  "connectionContractId": "contract-789",
  "cups": "ES1234567890123456AB",
  "tariffAccess": "RL01",
  "tariffName": "Standard Gas Tariff",
  "iban": "ES7620770024003102575766",
  "distributorName": "Gas Distributor S.A.",
  "holderName": "John Doe",
  "commercialName": "Gas Commercial S.L.",
  "fixedPrice": 20.5,
  "energyPrice": 0.065,
  "pressure": 0.5,
  "fileUrl": "https://example.com/contracts/gas/contract-123.pdf",
  "contractNumber": "GC-12345"
}

Changes

No recorded changes to this operation across all 1 revision of this API.