Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Contracts

Create Contract

Use this API to create a new contract.

post/api/vendor/v1/contracts/add

Request body

namestring required

The name of the contract for creation.

status'NEW' | 'IN_PROGRESS' | 'ACTIVE' | 'INACTIVE' | 'EXPIRED' | 'TERMINATED' | 'ARCHIVED' required

The status of the new contract.

agreementCreatedDatestring date required

The creation date for the new agreement.

contractTypeIdstring uuid

The contract type identifier for new contract.

contractTypeNamestring

The contract type name for new contract.

approvedDatestring date

The approval date for the new contract.

expirationDatestring date

The expiration date for the new contract.

contractOwnerIdstring uuid

The owner identifier for the new contract.

contractOwnerEmailstring email

The owner email for the new contract.

vendorContactstring

The vendor contact for the new contract.

approversstring

The approvers list for the new contract.

notestring

The notes for the new contract.

costnumber

The cost for the new contract.

urlstring uri

The document URL for the new contract.

orgGroupIdstring uuid

The organization group for the new contract.

attributeValuesobject

The custom attributes for the new contract.

vendorIdstring uuid required

The vendor identifier for the new contract.

Example request

{
  "name": "Microsoft Azure License",
  "vendorId": "5ec48d61-1562-43ad-87a3-6fc7073494af",
  "orgGroupId": "a41972ae-2050-4126-b314-1a58d08ea116",
  "status": "NEW"
}

Response

Created

string uuid required

The unique identifier (contractId) of the created contract.

Example response

"123e4567-e89b-12d3-a456-426614174000"