Contract Object

Root Connection

All Contract objects of an account are accessible by a query on the root connection contracts. Such a query will return a ContractConnection!, which contains the Contract objects in its nodes field.

contracts (ContractConnection!)

Root connection for retrieving Contract records.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

filter ContractFilter

Filter to determine which Contract records are returned.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

order [ContractOrder!]

Order of the Contract records returned.

view ContractView

View name.

The default value is current_account.

Fields

The fields in this section list which values can be retrieved when querying Contract records.

account (Account)

The account this record belongs to.

category (ContractCategory)

Used to select the appropriate category for the contract.

createdAt (ISO8601Timestamp)

The date and time at which the record was created.

customFields ([CustomField!])

Values of custom fields.

customer (Organization)

The organization that pays for the agreement.

customerAccount (Account)

The customer account this record belongs to.

customerRepresentative (Person)

The person who represents the customer organization for the agreement.

expiryDate (ISO8601Date)

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

id (ID!)

Unique identifier of the object.

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 service provider organization can still be contacted to terminate the agreement to ensure that it expires on the intended expiry date. The notice date field is left empty, and the expiry date field is filled out, when the agreement is to expire on a specific date and no notice needs to be given to terminate it.

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 agreement is active.

status (AgreementStatus)

The current status of the agreement.

supplier (Organization)

The organization that has provided the contract to the customer.

supplierContact (Person)

The person who represents the supplier of the contract.

timeZone (TimeZone)

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

uiExtension (UiExtension)

UI extension that is linked to the record.

updatedAt (ISO8601Timestamp)

The date and time of the last update of the record. If the record has no updates it contains the createdAt value.

Connections

The connection fields in this section allow (paged) access to objects related to a specific Contract record. The actual objects will be in the nodes field of the connection.

configurationItems (ConfigurationItemConnection)

All configuration items of the contract.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

customFieldsAttachments (AttachmentConnection)

Inline images linked to one of the custom fields.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

remarksAttachments (AttachmentConnection)

Files and inline images linked to the Remarks field.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

Implements

Contract implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a Contract.