Create Contract

post

https://{hostname}/api/vendor/v1/contracts/add

Use this API to create a new contract.

Body Params

name

string

required

length between 1 and 255

The name of the contract for creation.

status

string

enum

required

Defaults to NEW

The status of the new contract.

Allowed:

agreementCreatedDate

date

required

The creation date for the new agreement.

contractTypeId

uuid

The contract type identifier for new contract.

contractTypeName

string

length ≤ 255

The contract type name for new contract.

approvedDate

date

The approval date for the new contract.

expirationDate

date

The expiration date for the new contract.

contractOwnerId

uuid

The owner identifier for the new contract.

contractOwnerEmail

string

length ≤ 255

The owner email for the new contract.

vendorContact

string

length ≤ 500

The vendor contact for the new contract.

approvers

string

length ≤ 1000

The approvers list for the new contract.

note

string

length ≤ 4000

The notes for the new contract.

cost

number

≥ 0

The cost for the new contract.

currency

object

The currency in which the cost is indicated. Uses ISO 4217 currency codes.

url

uri

length ≤ 2000

The document URL for the new contract.

orgGroupId

uuid

The organization group for the new contract.

attributeValues

object

The custom attributes for the new contract.

vendorId

uuid

required

The vendor identifier for the new contract.

assets

array of objects

The collection of asset links for contract.

assets

processingActivities

array of objects

The collection of processing activity links.

processingActivities

vendors

array of objects

The collection of vendor links for contract.

vendors

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

URL

Response

Choose an example:

application/json

*/*