Skip to main content
POST
Create Inventory Contract

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

dryRun
boolean
default:false

Body

application/json

Contract create/update. All fields optional (partial update); create validates name, vendor_id and start_date in the service.

node_types and carry_over_node_ids are create-only conveniences: they are not columns, they seed the term set and the initial node membership.

name
string | null
reference
string | null
type
enum<string> | null
Available options:
ONE_OFF,
RECURRING,
RENEWABLE
status
enum<string> | null
Available options:
DRAFT,
ACTIVE,
ENDED,
CANCELLED
startDate
string<date-time> | null
endDate
string<date-time> | null
billingPeriod
enum<string> | null
Available options:
ONE_TIME,
DAILY,
WEEKLY,
BIWEEKLY,
MONTHLY,
BIMONTHLY,
QUARTERLY,
SEMI_ANNUAL,
ANNUAL,
BIENNIAL
paymentTiming
enum<string> | null
Available options:
ADVANCE,
ARREARS
autoRenew
boolean | null
noticePeriodDays
integer | null
currency
string | null
description
string | null
notes
string | null
extra
Extra · object | null
vendorId
string | null
continuesFromId
string | null
nodeTypes
ContractNodeTypeTerm · object[] | null
Maximum array length: 1000
carryOverNodeIds
string[] | null
Maximum array length: 1000

Response

Successful Response

data
MutationResult · object | null

Response data

status
string | null

Response status