M3m3ter-com
Contract

Retrieve Contract

Changed on

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

get/organizations/{orgId}/contracts/{id}

Request

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

For Contract billing, a boolean setting for restricting the charges billed to the period defined for the Contract:

  • TRUE - Contract billing for the Account will be restricted to charge amounts that fall within the defined Contract period.
  • FALSE - The period for amounts billed under the Contract will be determined by the Account Plan attached to the Account and linked to the Contract.(Default)
billGroupingKeyIdstring

The ID of the Bill Grouping Key assigned to the Contract.

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

  • 85c514abc692Revision changes
    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

  • ac93d1a9e6d9Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status