v10

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

Contract

Update Contract

Update the Contract with the given UUID.

This endpoint updates the details of the Contract with the specified ID. Used to modify details of an existing Contract such as the start or end dates.

Note: If you have created Custom Fields for a Contract, when you use this endpoint to update the Contract use the customFields parameter to preserve those Custom Fields. If you omit them from the update request, they will be lost.

put/organizations/{orgId}/contracts/{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 Contract to update.

Request body

versioninteger

The version number of the entity:

Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.

customFieldsobject

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level, customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

accountIdstring required

The unique identifier (UUID) of the Account associated with this Contract.

namestring required

The name of the Contract.

codestring

The short code of the Contract.

descriptionstring

The description of the Contract, which provides context and information.

purchaseOrderNumberstring

The Purchase Order Number associated with the Contract.

applyContractPeriodLimitsboolean

billGroupingKeyIdstring

startDatestring date required

The start date for the Contract (in ISO-8601 format). This date is inclusive, meaning the Contract is active from this date onward.

endDatestring date required

The exclusive end date of the Contract (in ISO-8601 format). This means the Contract is active until midnight on the day before this date.

Response

Returns the updated Contract

idstring required

The UUID of the entity.

versioninteger

The version number:

Create: On initial Create to insert a new entity, the version is set at 1 in the response.
Update: On successful Update, the version is incremented by 1 in the response.

customFieldsobject

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level,customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

accountIdstring

The unique identifier (UUID) of the Account associated with this Contract.

namestring

The name of the Contract.

codestring

The short code of the Contract.

descriptionstring

The description of the Contract, which provides context and information.

purchaseOrderNumberstring

The Purchase Order Number associated with the Contract.

applyContractPeriodLimitsboolean

billGroupingKeyIdstring

startDatestring date

The start date for the Contract (in ISO-8601 format). This date is inclusive, meaning the Contract is active from this date onward.

endDatestring date

The exclusive end date of the Contract (in ISO-8601 format). This means the Contract is active until midnight on the day before this date.

dtCreatedstring date-time

The date and time (in ISO-8601 format) when the Contract was created.

dtLastModifiedstring date-time

The date and time (in ISO-8601 format) when the Contract was last modified.

createdBystring

The unique identifier (UUID) of the user who created this Contract.

lastModifiedBystring

The unique identifier (UUID) of the user who last modified this Contract.