Create a Contract

post

https://{account}.sysaidit.com/connect/v1/license-manager/contracts

Create a new contract in your SysAid account.

Body Params

name

string

required

length between 1 and 255

The display name of the contract.

applicationId

string | null

required

The unique identifier of the linked application. Use the Applications API to retrieve application details.

status

string

required

The current status of the contract. Allowed values are "active" (currently in effect), "closed" (expired or terminated), and "pipeline" (planned but not yet active).

type

string | null

The type of software deployment for this contract. Allowed values are "saas" (cloud-based software), "on-prem" (on-premises software), "hybrid" (combination of cloud and on-premises), and "other".

category

string | null

The application's business category. Allowed values: operations, sales-and-marketing, developer-tools, design, project-management, customer-success, human-resources, it-and-security, finance, productivity, analytics-and-bi, other.

startDate

date | null

The start date of the contract.

endDate

date | null

The end date of the contract.

paymentTerm

string | null

The billing frequency for this contract. Allowed values are "annual", "monthly", "multiyear", "quarterly", "one-time", and "free".

contractValue

number | null

≥ 0

The total monetary value of the contract in the specified currency.

currency

string

ISO 4217 currency code for cost fields. Allowed values: USD, EUR, GBP, CAD, CHF, SEK, NOK, DKK, MXN, PLN, BRL, ILS, AUD, NZD, ZAR, GHS, TTD.

licensesCount

integer | null

≥ 0

The number of licenses included in this contract.

autoRenewal

boolean

Defaults to false

Indicates whether the contract renews automatically when it reaches its end date. The default is "false".

cancellationNotice

integer | null

≥ 0

The number of days before the end date by which cancellation must be submitted to avoid auto-renewal.

notes

string | null

Free-text notes or comments about the contract.

Responses

201Contract is successfully created.

400The request was invalid or cannot be served

401Authentication information is missing or invalid

409The request could not be completed due to a conflict with the current state of the resource. This typically occurs when attempting to create a duplicate resource, update a resource that has been modified by another process, or when business rules prevent the operation.

500An unexpected error occurred on the server