Sign in
Contract

Retrieve Contract

Retrieves the Contract with the given UUID. Used to obtain the details of a Contract.

get/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 retrieve.

Response

Returns the 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.

Changes

Changed in 3 of the 10 revisions of this API.214

  • ac93d1a9e6d913See the full diff
    • ●

      removed the optional property allOf[subschema #3]/billGroupingKey from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property allOf[subschema #3]/applyContractPeriodLimits to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #3]/billGroupingKeyId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #3]/usageFilters to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0f92c877619f1See the full diff
    • ○

      added the optional property allOf[subschema #3]/billGroupingKey to the response with the 200 status

      response-optional-property-added

  • 9f9e5f3dbde72See the full diff
    • ▲

      the response property allOf[AbstractResponseWithCustomFields]/allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    • ▲

      the response property allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog