Skip to main content

ContractUpdateRequest

Request body for updating a contract

contractCodestringrequired

Code of the contract

assets object[]

Assets linked of the contract. Each element is either the asset's Stonal identifier, or an object also carrying the link's explicit expiration date

  • Array [
    • anyOf
    string
  • ]
    • stakeholdersstring[]nullable

    Stakeholders linked of the contract

    equipmentsstring[]nullabledeprecated

    Equipments linked of the contract (deprecated, use the V2 installations field instead)

    effectiveDatestring | nullnullable

    Effective date of the contract (accepts yyyy-MM-dd or dd/MM/yyyy)

    Example: 2023-01-01
    endDatestring | nullnullable

    End date of the contract (accepts yyyy-MM-dd or dd/MM/yyyy)

    Example: 2023-01-01
    terminationDatestring | nullnullable

    Termination date of the contract (accepts yyyy-MM-dd or dd/MM/yyyy). When sent, also closes every asset link that would expire after it, except a link carrying its own explicit expiration date

    Example: 2023-01-01
    labelstring | nullnullable

    Label of the contract

    typestring | nullnullable

    Type of the contract

    Example: LEASE or OTHER
    ContractUpdateRequest
    {
      "contractCode": "string",
      "assets": "Unknown Type: array,null",
      "stakeholders": "Unknown Type: array,null",
      "effectiveDate": "2023-01-01",
      "endDate": "2023-01-01",
      "terminationDate": "2023-01-01",
      "label": "string",
      "type": "LEASE or OTHER"
    }