Contract

id (long)
Unique identifier to identify a contract

Example

234759602834500

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

vendor (vendor)
Indicates the vendor of the contract

Example

{
  "vendor": {
    "id": "100000000000033225"
  }
}

active_from (date)
Represents a date as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

owner (user)
Contains the details of contract owner

Example

{
  "owner": {
    "name": "test-contract_owner",
    "id": "234567890123456"
  }
}

is_definite (boolean)
Indicates the contract whether it is a Definite Contract or Indefinite Contract.

comments (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

support (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

active_till (date)
Represents a date as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

exchange_rate (double)
Specifies the exchange rate for cost of the contract based on currency

Example

23.08

is_notification_required (boolean)
Boolean value which can have two possible values. The values are true and false.

is_req_creation_required (boolean)
Boolean value which can have two possible values. The values are true and false.

request_creation_days (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

is_draft (boolean)
 Boolean value indicates whether this contract is draft or not

is_auto_renew (boolean)
 Boolean value indicates whether this contract is auto renew enabled or not

type (contract_type)
Contains the details of contract type

Example

{
  "type": {
    "color": "#ff6666",
    "name": "Lease",
    "id": "100000000000002823"
  }
}

assets (contract_asset_association)
Contains the detail of associated assets

Example

{
  "contract_asset_association": {
    "asset": {
      "name": "access point_1"
    }
  }
}

software_licenses (contract_swlicense_association)
Indicates the array of software-license associated with a contract

Example

{
  "contract_swlicense_association": {
    "software_license": {
      "id": "100000000000036043"
    }
  }
}

parent_contract (contract)
Detail of contract to which this contract is associated as child

Example

{
  "parent_contract": {
    "id": "100000000000049155"
  }
}

child_contracts (contract_relationship)
Contains the list of child contracts associated to a contract

Example

{
  "contract_relationship": {
    "child_contract": {
      "name": "Child 1"
    }
  }
}

attachments (attachment)
Files that are attached to a contract.

Example

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

udf_fields (udf_fields)
Holds user defined field values associated with the contract

Example

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

sites (site)
Indicates the list of sites to which the contract is associated.

Example

{
  "sites": [
    {
      "id": "100000000000035025"
    }
  ]
}

auto_renew (contract_auto_renew)
Indicates the auto renewal of the existing contract

Example

{
  "auto_renew": [
    {
      "auto_renew_extension": {
        "period": "months",
        "prolongation": 2
      },
      "auto_renew_notify": [
        {
          "id": "2000000036237"
        }
      ]
    }
  ]
}

configuration_items (configuration_item)
Indicates Configuration items involved in a contract

Example

{
  "configuration_items": [
    {
      "id": "100000000000039173"
    }
  ]
}

services (service)
Indicates the list of services available.

Example

{
  "services": [
    {
      "id": "100000000000039141"
    }
  ]
}

people (user)
Indicates the list of users

Example

{
  "people": [
    {
      "id": "100000000000036225"
    }
  ]
}

contract_usage (contract_usage_stats)
Contract usage indicates the usage of the current contract.

Example

{
  "contract_usage": [
    {
      "invoked_by": {
        "id": "100000000000036225"
      },
      "cost": "33333",
      "invoked_on": {
        "display_value": "Mar 31, 2023 06:17 PM",
        "value": "1680266839803"
      },
      "id": "100000000000037547",
      "asset": {
        "site": {
          "id": "100000000000006130"
        },
        "name": "server",
        "id": "100000000000037235"
      }
    }
  ]
}

template (contract_template)
Unique identifier to identify the contract template which is used to create a new contract.

Example

{
  "template": {
    "id": "100000000000030618"
  }
}

customer (customer)

Example

{
  "customer": {
    "name": "Customer ABC",
    "id": "2000000040924",
    "is_msp": false
  }
}

expiry_notification (JSONObject)
Contains the details of expiry notification

Example

{
  "expiry_notification": {
    "email_ids_to_notify": [
      "test@zmail.com"
    ],
    "notify_days": [
      {
        "notify_before": "1"
      }
    ],
    "notify_technicians": [
      {
        "id": "100000000000033153"
      }
    ]
  }
}

email_ids_to_notify (string)
A text in a plain format. No rich text or new line characters allowed.

Example

abc.gmail.com

notify_technicians (technician)
Contains a list of technician names to be notified when the contract expires

Example

{
  "notify_technicians": {
    "email_id": "ramyaa@zylker.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

notify_days (contract_notify_day)
Indicates the number of days left before which the contract notification is to be sent

Example

{
  "notify_days": [
    {
      "notify_before": "2"
    },
    {
      "notify_before": "5"
    }
  ]
}

display_id (sequence_number)
A unique sequence number to identify the contract

Example

{
  "display_id": {
    "display_value": "CON-1",
    "value": "1"
  }
}

created_by (user)
Indicates the user who created the contract

Example

{
  "created_by": {
    "email_id": "ramyaa@zylker.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

created_date (date)
Represents a date as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

currency (currency)
Specifies the currency of the vendor which is used in the contract

Example

{
  "currency": {
    "symbol": "€",
    "code": "EUR",
    "exchange_rate": "22",
    "name": "Euro",
    "id": "100000000000004126"
  }
}

status (contract_status)
Indicates the status of a contract

Example

{
  "status": {
    "name": "Active",
    "id": "100000000000002811"
  }
}

deleted_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

contract_renewed_from (contract)
Indicates the predecessor contract from which this contract was renewed 

Example

{
  "contract_renewed_from": {
    "cost": "0",
    "display_id": {
      "display_value": "CON-5",
      "value": "5"
    },
    "vendor": {
      "id": "100000000000033225"
    },
    "name": "Contract",
    "active_till": {
      "display_value": "Feb 28, 2019",
      "value": "1551378599999"
    },
    "id": "100000000000033267",
    "active_from": {
      "display_value": "Feb 1, 2019",
      "value": "1548959400000"
    },
    "status": {
      "id": "100000000000002814"
    }
  }
}

contract_renewal_origin (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

is_notification_disabled (boolean)
Boolean value which can have two possible values. The values are true and false.

is_renewed (boolean)
Boolean value which can have two possible values. The values are true and false.

summary (contract_summary)
Contains the summary of the contract

expiry_request (request)
Contains details of the request created when the contract expired

Example

{
  "request": {
    "id": "100000000456783"
  }
}

notes_present (boolean)
 Boolean value indicates whether this contract has notes or not

cost (cost)
Specifies the cost of the contract

Example

{
  "cost": {
    "display_value": "227.27",
    "currency_symbol": "$",
    "value": 227.27272727272728,
    "secondary_currency": {
      "display_value": 5000,
      "currency_symbol": "€",
      "value": 5000
    }
  }
}

id (long)
Unique identifier to identify a contract

Example

234759602834500

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

vendor (vendor)
Indicates the vendor of the contract

Example

{
  "vendor": {
    "id": "100000000000033225"
  }
}

active_from (date)
Represents a date as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

owner (user)
Contains the details of contract owner

Example

{
  "owner": {
    "name": "test-contract_owner",
    "id": "234567890123456"
  }
}

is_definite (boolean)
Indicates the contract whether it is a Definite Contract or Indefinite Contract.

comments (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

support (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

active_till (date)
Represents a date as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

exchange_rate (double)
Specifies the exchange rate for cost of the contract based on currency

Example

23.08

is_notification_required (boolean)
Boolean value which can have two possible values. The values are true and false.

is_req_creation_required (boolean)
Boolean value which can have two possible values. The values are true and false.

request_creation_days (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

is_draft (boolean)
 Boolean value indicates whether this contract is draft or not

is_auto_renew (boolean)
 Boolean value indicates whether this contract is auto renew enabled or not

type (contract_type)
Contains the details of contract type

Example

{
  "type": {
    "color": "#ff6666",
    "name": "Lease",
    "id": "100000000000002823"
  }
}

assets (contract_asset_association)
Contains the detail of associated assets

Example

{
  "contract_asset_association": {
    "asset": {
      "name": "access point_1"
    }
  }
}

software_licenses (contract_swlicense_association)
Indicates the array of software-license associated with a contract

Example

{
  "contract_swlicense_association": {
    "software_license": {
      "id": "100000000000036043"
    }
  }
}

parent_contract (contract)
Detail of contract to which this contract is associated as child

Example

{
  "parent_contract": {
    "id": "100000000000049155"
  }
}

child_contracts (contract_relationship)
Contains the list of child contracts associated to a contract

Example

{
  "contract_relationship": {
    "child_contract": {
      "name": "Child 1"
    }
  }
}

attachments (attachment)
Files that are attached to a contract.

Example

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

udf_fields (udf_fields)
Holds user defined field values associated with the contract

Example

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

sites (site)
Indicates the list of sites to which the contract is associated.

Example

{
  "sites": [
    {
      "id": "100000000000035025"
    }
  ]
}

auto_renew (contract_auto_renew)
Indicates the auto renewal of the existing contract

Example

{
  "auto_renew": [
    {
      "auto_renew_extension": {
        "period": "months",
        "prolongation": 2
      },
      "auto_renew_notify": [
        {
          "id": "2000000036237"
        }
      ]
    }
  ]
}

configuration_items (configuration_item)
Indicates Configuration items involved in a contract

Example

{
  "configuration_items": [
    {
      "id": "100000000000039173"
    }
  ]
}

services (service)
Indicates the list of services available.

Example

{
  "services": [
    {
      "id": "100000000000039141"
    }
  ]
}

people (user)
Indicates the list of users

Example

{
  "people": [
    {
      "id": "100000000000036225"
    }
  ]
}

contract_usage (contract_usage_stats)
Contract usage indicates the usage of the current contract.

Example

{
  "contract_usage": [
    {
      "invoked_by": {
        "id": "100000000000036225"
      },
      "cost": "33333",
      "invoked_on": {
        "display_value": "Mar 31, 2023 06:17 PM",
        "value": "1680266839803"
      },
      "id": "100000000000037547",
      "asset": {
        "site": {
          "id": "100000000000006130"
        },
        "name": "server",
        "id": "100000000000037235"
      }
    }
  ]
}

template (contract_template)
Unique identifier to identify the contract template which is used to create a new contract.

Example

{
  "template": {
    "id": "100000000000030618"
  }
}

customer (customer)

Example

{
  "customer": {
    "name": "Customer ABC",
    "id": "2000000040924",
    "is_msp": false
  }
}

expiry_notification (JSONObject)
Contains the details of expiry notification

Example

{
  "expiry_notification": {
    "email_ids_to_notify": [
      "test@zmail.com"
    ],
    "notify_days": [
      {
        "notify_before": "1"
      }
    ],
    "notify_technicians": [
      {
        "id": "100000000000033153"
      }
    ]
  }
}

email_ids_to_notify (string)
A text in a plain format. No rich text or new line characters allowed.

Example

abc.gmail.com

notify_technicians (technician)
Contains a list of technician names to be notified when the contract expires

Example

{
  "notify_technicians": {
    "email_id": "ramyaa@zylker.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

notify_days (contract_notify_day)
Indicates the number of days left before which the contract notification is to be sent

Example

{
  "notify_days": [
    {
      "notify_before": "2"
    },
    {
      "notify_before": "5"
    }
  ]
}

display_id (sequence_number)
A unique sequence number to identify the contract

Example

{
  "display_id": {
    "display_value": "CON-1",
    "value": "1"
  }
}

created_by (user)
Indicates the user who created the contract

Example

{
  "created_by": {
    "email_id": "ramyaa@zylker.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

created_date (date)
Represents a date as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

currency (currency)
Specifies the currency of the vendor which is used in the contract

Example

{
  "currency": {
    "symbol": "€",
    "code": "EUR",
    "exchange_rate": "22",
    "name": "Euro",
    "id": "100000000000004126"
  }
}

status (contract_status)
Indicates the status of a contract

Example

{
  "status": {
    "name": "Active",
    "id": "100000000000002811"
  }
}

deleted_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

contract_renewed_from (contract)
Indicates the predecessor contract from which this contract was renewed 

Example

{
  "contract_renewed_from": {
    "cost": "0",
    "display_id": {
      "display_value": "CON-5",
      "value": "5"
    },
    "vendor": {
      "id": "100000000000033225"
    },
    "name": "Contract",
    "active_till": {
      "display_value": "Feb 28, 2019",
      "value": "1551378599999"
    },
    "id": "100000000000033267",
    "active_from": {
      "display_value": "Feb 1, 2019",
      "value": "1548959400000"
    },
    "status": {
      "id": "100000000000002814"
    }
  }
}

contract_renewal_origin (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

is_notification_disabled (boolean)
Boolean value which can have two possible values. The values are true and false.

is_renewed (boolean)
Boolean value which can have two possible values. The values are true and false.

summary (contract_summary)
Contains the summary of the contract

expiry_request (request)
Contains details of the request created when the contract expired

Example

{
  "request": {
    "id": "100000000456783"
  }
}

notes_present (boolean)
 Boolean value indicates whether this contract has notes or not

cost (cost)
Specifies the cost of the contract

Example

{
  "cost": {
    "display_value": "227.27",
    "currency_symbol": "$",
    "value": 227.27272727272728,
    "secondary_currency": {
      "display_value": 5000,
      "currency_symbol": "€",
      "value": 5000
    }
  }
}

id (long)
Unique identifier to identify a contract

Example

234759602834500

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

vendor (vendor)
Indicates the vendor of the contract

Example

{
  "vendor": {
    "id": "100000000000033225"
  }
}

active_from (date)
Represents a date as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

owner (user)
Contains the details of contract owner

Example

{
  "owner": {
    "name": "test-contract_owner",
    "id": "234567890123456"
  }
}

is_definite (boolean)
Indicates the contract whether it is a Definite Contract or Indefinite Contract.

comments (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

support (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

active_till (date)
Represents a date as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

exchange_rate (double)
Specifies the exchange rate for cost of the contract based on currency

Example

23.08

is_notification_required (boolean)
Boolean value which can have two possible values. The values are true and false.

is_req_creation_required (boolean)
Boolean value which can have two possible values. The values are true and false.

request_creation_days (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

is_draft (boolean)
 Boolean value indicates whether this contract is draft or not

is_auto_renew (boolean)
 Boolean value indicates whether this contract is auto renew enabled or not

type (contract_type)
Contains the details of contract type

Example

{
  "type": {
    "color": "#ff6666",
    "name": "Lease",
    "id": "100000000000002823"
  }
}

assets (contract_asset_association)
Contains the detail of associated assets

Example

{
  "contract_asset_association": {
    "asset": {
      "name": "access point_1"
    }
  }
}

software_licenses (contract_swlicense_association)
Indicates the array of software-license associated with a contract

Example

{
  "contract_swlicense_association": {
    "software_license": {
      "id": "100000000000036043"
    }
  }
}

parent_contract (contract)
Detail of contract to which this contract is associated as child

Example

{
  "parent_contract": {
    "id": "100000000000049155"
  }
}

child_contracts (contract_relationship)
Contains the list of child contracts associated to a contract

Example

{
  "contract_relationship": {
    "child_contract": {
      "name": "Child 1"
    }
  }
}

attachments (attachment)
Files that are attached to a contract.

Example

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

udf_fields (udf_fields)
Holds user defined field values associated with the contract

Example

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

sites (site)
Indicates the list of sites to which the contract is associated.

Example

{
  "sites": [
    {
      "id": "100000000000035025"
    }
  ]
}

auto_renew (contract_auto_renew)
Indicates the auto renewal of the existing contract

Example

{
  "auto_renew": [
    {
      "auto_renew_extension": {
        "period": "months",
        "prolongation": 2
      },
      "auto_renew_notify": [
        {
          "id": "2000000036237"
        }
      ]
    }
  ]
}

configuration_items (configuration_item)
Indicates Configuration items involved in a contract

Example

{
  "configuration_items": [
    {
      "id": "100000000000039173"
    }
  ]
}

services (service)
Indicates the list of services available.

Example

{
  "services": [
    {
      "id": "100000000000039141"
    }
  ]
}

people (user)
Indicates the list of users

Example

{
  "people": [
    {
      "id": "100000000000036225"
    }
  ]
}

contract_usage (contract_usage_stats)
Contract usage indicates the usage of the current contract.

Example

{
  "contract_usage": [
    {
      "invoked_by": {
        "id": "100000000000036225"
      },
      "cost": "33333",
      "invoked_on": {
        "display_value": "Mar 31, 2023 06:17 PM",
        "value": "1680266839803"
      },
      "id": "100000000000037547",
      "asset": {
        "site": {
          "id": "100000000000006130"
        },
        "name": "server",
        "id": "100000000000037235"
      }
    }
  ]
}

template (contract_template)
Unique identifier to identify the contract template which is used to create a new contract.

Example

{
  "template": {
    "id": "100000000000030618"
  }
}

customer (customer)

Example

{
  "customer": {
    "name": "Customer ABC",
    "id": "2000000040924",
    "is_msp": false
  }
}

expiry_notification (JSONObject)
Contains the details of expiry notification

Example

{
  "expiry_notification": {
    "email_ids_to_notify": [
      "test@zmail.com"
    ],
    "notify_days": [
      {
        "notify_before": "1"
      }
    ],
    "notify_technicians": [
      {
        "id": "100000000000033153"
      }
    ]
  }
}

email_ids_to_notify (string)
A text in a plain format. No rich text or new line characters allowed.

Example

abc.gmail.com

notify_technicians (technician)
Contains a list of technician names to be notified when the contract expires

Example

{
  "notify_technicians": {
    "email_id": "ramyaa@zylker.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

notify_days (contract_notify_day)
Indicates the number of days left before which the contract notification is to be sent

Example

{
  "notify_days": [
    {
      "notify_before": "2"
    },
    {
      "notify_before": "5"
    }
  ]
}

display_id (sequence_number)
A unique sequence number to identify the contract

Example

{
  "display_id": {
    "display_value": "CON-1",
    "value": "1"
  }
}

created_by (user)
Indicates the user who created the contract

Example

{
  "created_by": {
    "email_id": "ramyaa@zylker.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

created_date (date)
Represents a date as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

currency (currency)
Specifies the currency of the vendor which is used in the contract

Example

{
  "currency": {
    "symbol": "€",
    "code": "EUR",
    "exchange_rate": "22",
    "name": "Euro",
    "id": "100000000000004126"
  }
}

status (contract_status)
Indicates the status of a contract

Example

{
  "status": {
    "name": "Active",
    "id": "100000000000002811"
  }
}

deleted_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

contract_renewed_from (contract)
Indicates the predecessor contract from which this contract was renewed 

Example

{
  "contract_renewed_from": {
    "cost": "0",
    "display_id": {
      "display_value": "CON-5",
      "value": "5"
    },
    "vendor": {
      "id": "100000000000033225"
    },
    "name": "Contract",
    "active_till": {
      "display_value": "Feb 28, 2019",
      "value": "1551378599999"
    },
    "id": "100000000000033267",
    "active_from": {
      "display_value": "Feb 1, 2019",
      "value": "1548959400000"
    },
    "status": {
      "id": "100000000000002814"
    }
  }
}

contract_renewal_origin (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

is_notification_disabled (boolean)
Boolean value which can have two possible values. The values are true and false.

is_renewed (boolean)
Boolean value which can have two possible values. The values are true and false.

summary (contract_summary)
Contains the summary of the contract

expiry_request (request)
Contains details of the request created when the contract expired

Example

{
  "request": {
    "id": "100000000456783"
  }
}

notes_present (boolean)
 Boolean value indicates whether this contract has notes or not

cost (cost)
Specifies the cost of the contract

Example

{
  "cost": {
    "display_value": "227.27",
    "currency_symbol": "$",
    "value": 227.27272727272728,
    "secondary_currency": {
      "display_value": 5000,
      "currency_symbol": "€",
      "value": 5000
    }
  }
}

id (long)
Unique identifier to identify a contract

Example

234759602834500

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

vendor (vendor)
Indicates the vendor of the contract

Example

{
  "vendor": {
    "id": "100000000000033225"
  }
}

active_from (date)
Represents a date as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

owner (user)
Contains the details of contract owner

Example

{
  "owner": {
    "name": "test-contract_owner",
    "id": "234567890123456"
  }
}

is_definite (boolean)
Indicates the contract whether it is a Definite Contract or Indefinite Contract.

comments (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

support (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

active_till (date)
Represents a date as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

exchange_rate (double)
Specifies the exchange rate for cost of the contract based on currency

Example

23.08

is_notification_required (boolean)
Boolean value which can have two possible values. The values are true and false.

is_req_creation_required (boolean)
Boolean value which can have two possible values. The values are true and false.

request_creation_days (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

is_draft (boolean)
 Boolean value indicates whether this contract is draft or not

is_auto_renew (boolean)
 Boolean value indicates whether this contract is auto renew enabled or not

type (contract_type)
Contains the details of contract type

Example

{
  "type": {
    "color": "#ff6666",
    "name": "Lease",
    "id": "100000000000002823"
  }
}

assets (contract_asset_association)
Contains the detail of associated assets

Example

{
  "contract_asset_association": {
    "asset": {
      "name": "access point_1"
    }
  }
}

software_licenses (contract_swlicense_association)
Indicates the array of software-license associated with a contract

Example

{
  "contract_swlicense_association": {
    "software_license": {
      "id": "100000000000036043"
    }
  }
}

parent_contract (contract)
Detail of contract to which this contract is associated as child

Example

{
  "parent_contract": {
    "id": "100000000000049155"
  }
}

child_contracts (contract_relationship)
Contains the list of child contracts associated to a contract

Example

{
  "contract_relationship": {
    "child_contract": {
      "name": "Child 1"
    }
  }
}

attachments (attachment)
Files that are attached to a contract.

Example

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

udf_fields (udf_fields)
Holds user defined field values associated with the contract

Example

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

sites (site)
Indicates the list of sites to which the contract is associated.

Example

{
  "sites": [
    {
      "id": "100000000000035025"
    }
  ]
}

auto_renew (contract_auto_renew)
Indicates the auto renewal of the existing contract

Example

{
  "auto_renew": [
    {
      "auto_renew_extension": {
        "period": "months",
        "prolongation": 2
      },
      "auto_renew_notify": [
        {
          "id": "2000000036237"
        }
      ]
    }
  ]
}

configuration_items (configuration_item)
Indicates Configuration items involved in a contract

Example

{
  "configuration_items": [
    {
      "id": "100000000000039173"
    }
  ]
}

services (service)
Indicates the list of services available.

Example

{
  "services": [
    {
      "id": "100000000000039141"
    }
  ]
}

people (user)
Indicates the list of users

Example

{
  "people": [
    {
      "id": "100000000000036225"
    }
  ]
}

contract_usage (contract_usage_stats)
Contract usage indicates the usage of the current contract.

Example

{
  "contract_usage": [
    {
      "invoked_by": {
        "id": "100000000000036225"
      },
      "cost": "33333",
      "invoked_on": {
        "display_value": "Mar 31, 2023 06:17 PM",
        "value": "1680266839803"
      },
      "id": "100000000000037547",
      "asset": {
        "site": {
          "id": "100000000000006130"
        },
        "name": "server",
        "id": "100000000000037235"
      }
    }
  ]
}

template (contract_template)
Unique identifier to identify the contract template which is used to create a new contract.

Example

{
  "template": {
    "id": "100000000000030618"
  }
}

customer (customer)

Example

{
  "customer": {
    "name": "Customer ABC",
    "id": "2000000040924",
    "is_msp": false
  }
}

expiry_notification (JSONObject)
Contains the details of expiry notification

Example

{
  "expiry_notification": {
    "email_ids_to_notify": [
      "test@zmail.com"
    ],
    "notify_days": [
      {
        "notify_before": "1"
      }
    ],
    "notify_technicians": [
      {
        "id": "100000000000033153"
      }
    ]
  }
}

email_ids_to_notify (string)
A text in a plain format. No rich text or new line characters allowed.

Example

abc.gmail.com

notify_technicians (technician)
Contains a list of technician names to be notified when the contract expires

Example

{
  "notify_technicians": {
    "email_id": "ramyaa@zylker.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

notify_days (contract_notify_day)
Indicates the number of days left before which the contract notification is to be sent

Example

{
  "notify_days": [
    {
      "notify_before": "2"
    },
    {
      "notify_before": "5"
    }
  ]
}

display_id (sequence_number)
A unique sequence number to identify the contract

Example

{
  "display_id": {
    "display_value": "CON-1",
    "value": "1"
  }
}

created_by (user)
Indicates the user who created the contract

Example

{
  "created_by": {
    "email_id": "ramyaa@zylker.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

created_date (date)
Represents a date as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

currency (currency)
Specifies the currency of the vendor which is used in the contract

Example

{
  "currency": {
    "symbol": "€",
    "code": "EUR",
    "exchange_rate": "22",
    "name": "Euro",
    "id": "100000000000004126"
  }
}

status (contract_status)
Indicates the status of a contract

Example

{
  "status": {
    "name": "Active",
    "id": "100000000000002811"
  }
}

deleted_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

contract_renewed_from (contract)
Indicates the predecessor contract from which this contract was renewed 

Example

{
  "contract_renewed_from": {
    "cost": "0",
    "display_id": {
      "display_value": "CON-5",
      "value": "5"
    },
    "vendor": {
      "id": "100000000000033225"
    },
    "name": "Contract",
    "active_till": {
      "display_value": "Feb 28, 2019",
      "value": "1551378599999"
    },
    "id": "100000000000033267",
    "active_from": {
      "display_value": "Feb 1, 2019",
      "value": "1548959400000"
    },
    "status": {
      "id": "100000000000002814"
    }
  }
}

contract_renewal_origin (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

is_notification_disabled (boolean)
Boolean value which can have two possible values. The values are true and false.

is_renewed (boolean)
Boolean value which can have two possible values. The values are true and false.

summary (contract_summary)
Contains the summary of the contract

expiry_request (request)
Contains details of the request created when the contract expired

Example

{
  "request": {
    "id": "100000000456783"
  }
}

notes_present (boolean)
 Boolean value indicates whether this contract has notes or not

cost (cost)
Specifies the cost of the contract

Example

{
  "cost": {
    "display_value": "227.27",
    "currency_symbol": "$",
    "value": 227.27272727272728,
    "secondary_currency": {
      "display_value": 5000,
      "currency_symbol": "€",
      "value": 5000
    }
  }
}