contractCreate Mutation

Creates a new contract.

Input Argument

contractCreate accepts a single input argument, an input type, which contains the values it uses.

The fields inside input are:

category (ContractCategory)

Used to select the appropriate category for the contract.

clientMutationId (String)

A unique identifier for the client performing the mutation.

configurationItemIds ([ID!])

Identifiers of the configuration items of the contract.

customFields ([CustomFieldInput!])

Values for custom field to be used by the UI Extension that is linked to the record.

customerId (ID!)

Identifier of the organization that pays for the contract.

customerRepresentativeId (ID)

Identifier of the person who represents the customer of the contract.

expiryDate (ISO8601Date)

The date through which the contract will be active. The contract expires at the end of this day if it is not renewed before then. When the contract has expired, its status will automatically be set to expired.

As long as notice still needs to be given to terminate the contract, the expiryDate field is to remain empty.

name (String!)

The name of the contract. If a unique ID is given to each contract, then this ID can be added at the start of the name.

Example:

  • 2EGXQ2W – Dell 3-Year ProSupport and Next Business Day Onsite Repair for CMP00035
noticeDate (ISO8601Date)

The last day on which the supplier organization can still be contacted to terminate the contract to ensure that it expires on the intended expiry date. The noticeDate field is left empty, and the expiryDate field is filled out, when the contract is to expire on a specific date and no notice needs to be given to terminate it.

As long as notice still needs to be given to terminate the contract, the expiryDate field is to remain empty.

remarks (String)

Any additional information about the contract that might prove useful.

source (String)

An identifier for the client application submitting the resource or the name of an external system

sourceID (String)

The unique identifier of the resource in an external system

startDate (ISO8601Date!)

The first day during which the contract is active.

status (AgreementStatus)

The current status of the contract.

supplierContactId (ID)

Identifier of the person who represents the supplier of the contract.

supplierId (ID!)

Identifier of the organization that has provided the contract to the customer.

timeZone (TimeZone)

The time zone that applies to the start date, notice date and expiry date of the contract.

uiExtensionId (ID)

UI extension that is to be applied to the record.

Return Fields

clientMutationId (String)

A unique identifier for the client performing the mutation.

contract (Contract)

Record after mutation.

errors ([ValidationError!])

Errors encountered during the mutation.