Skip to main content
GET
Get a contract

Authorizations

Authorization
string
header
required

OAuth 2.0. Obtain an access token via the Client Credentials or Authorization Code flow, then send it as Authorization: Bearer <token>.

Path Parameters

id
string
required

The contract's SaaS Manager ID, or the external ID you assigned when importing it.

Response

OK

A contract

id
string | null

The contract's SaaS Manager ID. Supply to update an existing contract.

externalId
string | null

Your own external ID for the contract. Supply to match an existing contract on update.

ref
string | null

A reference for the contract, e.g. a PO number

type
enum<string>

The contract type

Available options:
OrderForm,
MSA,
GenericContract,
PurchaseOrder,
Subscription
vendorName
string | null

The vendor name

startDate
string<date-time> | null

(ISO format) The contract's start date

agreementDate
string<date-time> | null

(ISO format) The agreement date. Defaults to now on creation.

renewalDate
string<date-time> | null

(ISO format) The renewal date

isRolling
boolean | null

Whether the contract is a rolling contract

terminationNoticeDays
integer<int32> | null

The number of days' notice required to terminate the contract

isAutomaticRenewal
boolean | null

Whether the contract renews automatically

notes
string | null

Notes about the contract

paymentMethod
enum<string> | null

The payment method

Available options:
CreditCard,
Invoice
businessOwnerEmail
string | null

The email address of the contract's business owner

lineItems
object[] | null

The contract's line items

documents
object[] | null

Documents linked to the contract

createdBy
object | null

The user that created the contract record

createdDtm
string<date-time> | null
read-only

The timestamp for when the contract record was created

lastModifiedBy
object | null

The user that last modified the contract record

lastModifiedDtm
string<date-time> | null
read-only

The timestamp for when the contract record was last modified