Venminder (Digital Comply) Contracts API
The Contracts API from Venminder (Digital Comply) — 9 operation(s) for contracts.
The Contracts API from Venminder (Digital Comply) — 9 operation(s) for contracts.
openapi: 3.0.1
info:
title: Venminder OpenApi BusinessUnit Contracts API
version: v1
security:
- Bearer: []
tags:
- name: Contracts
paths:
/api/v1/Contracts/GetDetails:
get:
tags:
- Contracts
summary: Provides detailed information concerning a specific contract.
description: Provides detailed information concerning a specific contract associated with a vendor. This will included both standard and custom metadata fields as well as a list of any modification to the contract.
parameters:
- name: contractKey
in: query
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.ContractDetails'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.ContractDetails'
/api/v1/Contracts/GetHierarchy:
get:
tags:
- Contracts
summary: Provides detailed contract hierarchy information for a vendor.
description: Provides detailed contract hierarchy including parent contracts, child contracts and modifications for a vendor.
parameters:
- name: vendorKey
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.Contracts.ContractHierarchyInformation'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.ContractHierarchyInformation'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
/api/v1/Contracts/GetContracts:
get:
tags:
- Contracts
summary: Provides list of contracts for client or a specific vendor/product that is either in Ongoing or Offboarding.
description: Provides list of contracts for client or specific vendor/product that is in Ongoing or Offboarding, taking into consideration extra filters applied as well. This will include metadata and simple data for the contract and associated product(s).
parameters:
- name: vendorKey
in: query
schema:
type: string
- name: productKey
in: query
schema:
type: string
- name: statusID
in: query
schema:
type: integer
format: int32
- name: includeArchived
in: query
schema:
type: boolean
- name: notificationDeadlineDateStart
in: query
schema:
type: string
format: date-time
- name: notificationDeadlineDateEnd
in: query
schema:
type: string
format: date-time
- name: expirationDateStart
in: query
schema:
type: string
format: date-time
- name: expirationDateEnd
in: query
schema:
type: string
format: date-time
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.ContractInformation'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.ContractInformation'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
/api/v1/Contracts/GetDrafts:
get:
tags:
- Contracts
summary: Provides contract drafts information for a vendor.
description: Provides list of contract drafts including notes for a vendor.
parameters:
- name: vendorKey
in: query
schema:
type: string
- name: relationshipKey
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.Contracts.ContractDraftInformation'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.ContractDraftInformation'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
/api/v1/Contracts/GetDraftDetails:
get:
tags:
- Contracts
summary: Provides contract draft details for a contract draft.
description: Provides detailed information for contract draft including approvers, draft documents and timelines.
parameters:
- name: draftKey
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.ContractDraftDetails'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.ContractDraftDetails'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
/api/v1/Contracts/AddNoteToContractDraft:
post:
tags:
- Contracts
summary: Adds a new note to an existing or new draft contract, given that FIVR and Onboarding Request pass validation and authorization checks.
description: Adds a new note to an existing or new draft contract, given that FIVR and Onboarding Request pass validation and authorization checks.
parameters:
- name: cultureCode
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest'
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest'
text/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest'
application/*+json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest'
text/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest'
application/*+xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.CreateDraftNoteResponseForAPI'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.CreateDraftNoteResponseForAPI'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
/api/v1/Contracts/EditContract:
post:
tags:
- Contracts
summary: Modifies basic contract details provided in the request parameter.
description: Modifies basic contract details provided in the request parameter.
parameters:
- name: cultureCode
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest'
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest'
text/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest'
application/*+json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest'
text/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest'
application/*+xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest'
responses:
'200':
description: OK
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
/api/v1/Contracts/CreateContract:
post:
tags:
- Contracts
summary: Creates a basic self-processed contract with details provided in the request parameter.
description: Creates a basic self-processed contract with details provided in the request parameter.
parameters:
- name: cultureCode
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest'
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest'
text/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest'
application/*+json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest'
text/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest'
application/*+xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest'
responses:
'200':
description: OK
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
/api/v1/Contracts/EditContractCustomData:
post:
tags:
- Contracts
summary: Updates existing custom data for the contract with the supplied contract's custom data key.
description: Updates existing custom data for the contract with the supplied contract's custom data key.
parameters:
- name: cultureCode
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest'
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest'
text/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest'
application/*+json:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest'
text/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest'
application/*+xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest'
responses:
'200':
description: OK
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
application/xml:
schema:
$ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
components:
schemas:
OpenApi.v1.Contracts.DraftNote:
title: OpenApi.v1.Contracts.DraftNote
type: object
properties:
note:
type: string
nullable: true
authorName:
type: string
nullable: true
createdDate:
type: string
format: date-time
additionalProperties: false
xml:
name: Contracts.DraftNote
OpenApi.v1.Contracts.ContractDraftInformation:
title: OpenApi.v1.Contracts.ContractDraftInformation
type: object
properties:
key:
type: string
nullable: true
contractName:
type: string
nullable: true
notes:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.Contracts.DraftNote'
nullable: true
additionalProperties: false
xml:
name: Contracts.ContractDraftInformation
OpenApi.v1.Contracts.CreateClientContractRequest:
title: OpenApi.v1.Contracts.CreateClientContractRequest
type: object
properties:
contractName:
type: string
nullable: true
contractDate:
type: string
format: date-time
nullable: true
term:
type: integer
format: int32
nullable: true
expirationDate:
type: string
format: date-time
nullable: true
daysRequired:
type: integer
format: int32
nullable: true
hasAutoRenewalClause:
type: boolean
nullable: true
autoRenewalTerm:
type: integer
format: int32
nullable: true
vendorKey:
type: string
nullable: true
productKeys:
type: array
items:
type: string
nullable: true
isPerpetual:
type: boolean
nullable: true
emailSchedule:
type: integer
format: int32
nullable: true
additionalProperties: false
xml:
name: Contracts.CreateClientContractRequest
OpenApi.v1.Document:
title: OpenApi.v1.Document
type: object
properties:
key:
type: string
nullable: true
fileName:
type: string
nullable: true
additionalProperties: false
xml:
name: Document
OpenApi.v1.Contracts.AddNoteToContractDraftRequest:
title: OpenApi.v1.Contracts.AddNoteToContractDraftRequest
type: object
properties:
draftKey:
type: string
nullable: true
productKey:
type: string
nullable: true
requestRelationshipKey:
type: string
nullable: true
note:
type: string
nullable: true
additionalProperties: false
xml:
name: Contracts.AddNoteToContractDraftRequest
OpenApi.v1.Contracts.ContractHierarchyInformation:
title: OpenApi.v1.Contracts.ContractHierarchyInformation
type: object
properties:
key:
type: string
nullable: true
contractName:
type: string
nullable: true
status:
type: string
nullable: true
expirationDate:
type: string
format: date-time
nullable: true
firstReminderDate:
type: string
format: date-time
cancellationEffectiveDate:
type: string
format: date-time
nullable: true
isAddendumOrModification:
type: boolean
isPerpetual:
type: boolean
isExpiredContract:
type: boolean
active:
type: boolean
firstReminderOffset:
type: integer
format: int32
autoRenewalNoticeDays:
type: integer
format: int32
contractDocumentTypes:
type: array
items:
type: string
nullable: true
products:
type: array
items:
type: string
nullable: true
childContracts:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.Contracts.ContractHierarchyInformation'
nullable: true
modifications:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.Contracts.ContractHierarchyInformation'
nullable: true
additionalProperties: false
xml:
name: Contracts.ContractHierarchyInformation
OpenApi.v1.ModificationData:
title: OpenApi.v1.ModificationData
type: object
properties:
name:
type: string
nullable: true
fromValue:
type: string
nullable: true
toValue:
type: string
nullable: true
isUserData:
type: boolean
sortOrder:
type: integer
format: int32
nullable: true
additionalProperties: false
xml:
name: ModificationData
OpenApi.v1.ContractSla:
title: OpenApi.v1.ContractSla
type: object
properties:
title:
type: string
nullable: true
description:
type: string
nullable: true
additionalProperties: false
xml:
name: ContractSla
OpenApi.v1.ContractInformation:
title: OpenApi.v1.ContractInformation
type: object
properties:
key:
type: string
nullable: true
contractName:
type: string
nullable: true
status:
type: string
nullable: true
isPerpetual:
type: boolean
effectiveDate:
type: string
format: date-time
nullable: true
expirationDate:
type: string
format: date-time
nullable: true
autoRenewalNoticeDays:
type: integer
format: int32
nullable: true
requiredNotificationDeadline:
type: string
format: date-time
nullable: true
readOnly: true
archivedDate:
type: string
format: date-time
nullable: true
vendorName:
type: string
nullable: true
vendorKey:
type: string
nullable: true
products:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.ContractProduct'
nullable: true
additionalProperties: false
xml:
name: ContractInformation
OpenApi.v1.Contracts.CreateDraftNoteResponseForAPI:
title: OpenApi.v1.Contracts.CreateDraftNoteResponseForAPI
type: object
properties:
draftKey:
type: string
nullable: true
productKey:
type: string
nullable: true
requestRelationshipKey:
type: string
nullable: true
note:
type: string
nullable: true
additionalProperties: false
xml:
name: Contracts.CreateDraftNoteResponseForAPI
OpenApi.v1.ErrorResource:
title: OpenApi.v1.ErrorResource
type: object
properties:
resourceKey:
type: string
nullable: true
resourceValue:
type: string
nullable: true
field:
type: string
nullable: true
additionalProperties: false
xml:
name: ErrorResource
OpenApi.v1.ContractModification:
title: OpenApi.v1.ContractModification
type: object
properties:
key:
type: string
nullable: true
uploadedByKey:
type: string
nullable: true
uploadedDate:
type: string
format: date-time
createdDate:
type: string
format: date-time
effectiveDate:
type: string
format: date-time
nullable: true
description:
type: string
nullable: true
documents:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.Document'
nullable: true
modifications:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.ModificationData'
nullable: true
additionalProperties: false
xml:
name: ContractModification
OpenApi.v1.Contracts.EditClientContractUserDataRequest:
title: OpenApi.v1.Contracts.EditClientContractUserDataRequest
type: object
properties:
key:
type: string
nullable: true
value:
type: string
nullable: true
additionalProperties: false
xml:
name: Contracts.EditClientContractUserDataRequest
OpenApi.v1.Contracts.Timeline:
title: OpenApi.v1.Contracts.Timeline
type: object
properties:
key:
type: string
nullable: true
fileName:
type: string
nullable: true
type:
type: string
nullable: true
action:
type: string
nullable: true
versionMajor:
type: integer
format: int32
versionMinor:
type: integer
format: int32
createdBy:
type: string
nullable: true
createdDate:
type: string
format: date-time
assignedTo:
type: string
nullable: true
approverCustomRole:
type: string
nullable: true
onBehalfOfUploadedBy:
type: string
nullable: true
dueDate:
type: string
format: date-time
nullable: true
completedDate:
type: string
format: date-time
nullable: true
comment:
type: string
nullable: true
active:
type: boolean
additionalProperties: false
xml:
name: Contracts.Timeline
OpenApi.v1.Contracts.DraftApprovers:
title: OpenApi.v1.Contracts.DraftApprovers
type: object
properties:
approverContacts:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.Contracts.ApproverContact'
nullable: true
approverRoles:
type: array
items:
type: string
nullable: true
additionalProperties: false
xml:
name: Contracts.DraftApprovers
OpenApi.v1.Contracts.EditClientContractRequest:
title: OpenApi.v1.Contracts.EditClientContractRequest
type: object
properties:
contractName:
type: string
nullable: true
contractDate:
type: string
format: date-time
nullable: true
term:
type: integer
format: int32
nullable: true
expirationDate:
type: string
format: date-time
nullable: true
daysRequired:
type: integer
format: int32
nullable: true
hasAutoRenewalClause:
type: boolean
nullable: true
autoRenewalTerm:
type: integer
format: int32
nullable: true
key:
type: string
nullable: true
hasNda:
type: boolean
nullable: true
hasEarlyTerminationProvision:
type: boolean
nullable: true
earlyTerminationProvisionDescription:
type: string
nullable: true
isEqualOpportunityEmployer:
type: boolean
nullable: true
vendorSignator:
type: string
nullable: true
institutionSignator:
type: string
nullable: true
additionalProperties: false
xml:
name: Contracts.EditClientContractRequest
OpenApi.v1.Contracts.ApproverContact:
title: OpenApi.v1.Contracts.ApproverContact
type: object
properties:
key:
type: string
nullable: true
firstName:
type: string
nullable: true
lastName:
type: string
nullable: true
emailAddress:
type: string
nullable: true
additionalProperties: false
xml:
name: Contracts.ApproverContact
OpenApi.v1.ContractDetails:
title: OpenApi.v1.ContractDetails
type: object
properties:
key:
type: string
nullable: true
uploadedByKey:
type: string
nullable: true
uploadedDate:
type: string
format: date-time
effectiveDate:
type: string
format: date-time
nullable: true
term:
type: integer
format: int32
nullable: true
expirationDate:
type: string
format: date-time
nullable: true
autoRenewalNoticeDays:
type: integer
format: int32
nullable: true
firstReminderDate:
type: string
format: date-time
nullable: true
firstReminderOffset:
type: integer
format: int32
renewalMonths:
type: integer
format: int32
nullable: true
hasAutoRenewalClause:
type: boolean
nullable: true
hasSla:
type: boolean
nullable: true
hasNda:
type: boolean
nullable: true
slas:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.ContractSla'
nullable: true
hasEqualOpportunityEmployment:
type: boolean
nullable: true
vendorSignator:
type: string
nullable: true
institutionSignator:
type: string
nullable: true
dataItems:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.ContractData'
nullable: true
hasEarlyTerminationProvision:
type: boolean
nullable: true
hasEarlyTerminationProvisionDescription:
type: string
nullable: true
vendorKey:
type: string
nullable: true
productKeys:
type: array
items:
type: string
nullable: true
pricings:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.ContractPricing'
nullable: true
status:
type: string
nullable: true
active:
type: boolean
cancellationEffectiveDate:
type: string
format: date-time
nullable: true
documents:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.Document'
nullable: true
hasPricing:
type: boolean
nullable: true
isPerpetual:
type: boolean
contractName:
type: string
nullable: true
requiredNotificationDeadline:
type: string
format: date-time
nullable: true
readOnly: true
modifications:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.ContractModification'
nullable: true
additionalProperties: false
xml:
name: ContractDetails
OpenApi.v1.ErrorResponse:
title: OpenApi.v1.ErrorResponse
type: object
properties:
statusCode:
type: integer
format: int32
errors:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.ErrorResource'
nullable: true
additionalProperties: false
xml:
name: ErrorResponse
OpenApi.v1.Contracts.ContractDraftDetails:
title: OpenApi.v1.Contracts.ContractDraftDetails
type: object
properties:
key:
type: string
nullable: true
contractName:
type: string
nullable: true
notes:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.Contracts.DraftNote'
nullable: true
draftApprovers:
$ref: '#/components/schemas/OpenApi.v1.Contracts.DraftApprovers'
draftDocuments:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.Contracts.DraftDocument'
nullable: true
additionalProperties: false
xml:
name: Contracts.ContractDraftDetails
OpenApi.v1.Contracts.DraftDocument:
title: OpenApi.v1.Contracts.DraftDocument
type: object
properties:
key:
type: string
nullable: true
name:
type: string
nullable: true
timelines:
type: array
items:
$ref: '#/components/schemas/OpenApi.v1.Contracts.Timeline'
nullable: true
additionalProperties: false
xml:
name: Contracts.DraftDocument
OpenApi.v1.ContractPricing:
title: OpenApi.v1.ContractPricing
type: object
properties:
key:
type: string
nullable: true
price:
type: number
format: double
item:
type: string
nullable: true
period:
type: string
nullable: true
productKey:
type: string
nullable: true
tieredPricingFrom:
type: integer
format: int32
nullable: true
tieredPricingTo:
type: integer
format: int32
nullable: true
tieredPricing:
type: string
nullable: true
term:
type: string
nullable: true
comments:
type: string
nullable: true
sortOrder:
type: integer
format: int32
additionalProperties: false
xml:
name: ContractPricing
OpenApi.v1.ContractData:
title: OpenApi.v1.ContractData
type: object
properties:
key:
type: string
nullable: true
name:
type: string
nullable: true
value:
type: string
nullable: true
sortOrder:
type: integer
format: int32
nullable: true
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/venminder-digital-comply/refs/heads/main/openapi/venminder-digital-comply-contracts-api-openapi.yml