Overview
In this API, you get contracts between the date ranges passed on in the request.
Request
{
"pageSize": "50",
"pageNumber": "1",
"range": {
"fromDate": "2023-03-08T00:00:01.000Z",
"toDate": "2023-03-24T00:00:05.000Z"
}
}
Response
{
"CLMDetails": [
{
"_id": "5603a47a-f0fc-4494-a5df-5c29e0b7a19e",
"isSourcingLineProcessed": false,
"isParentContractLinkagePresent": false,
"isPartialSave": false,
"isDocSaved": false,
"isMigrated": false,
"isLatestCopy": true,
"executedCounter": 0,
"liveCounter": 0,
"isAmendent": false,
"amendentStatus": 0,
"createdOn": "2025-01-20T16:58:03.39Z",
"currentLiveDate": null,
"cancelledOn": null,
"latestExecutedOn": null,
"expiredCounter": 0,
"documentType": "101",
"submittedOn": null,
"reinstateDate": null,
"modifiedBy": "John Smith",
"revisedContractNumber": "CDR0032248.0",
"modifiedOn": "2025-01-20T16:58:03.39Z",
"initialLiveDate": null,
"documentName": "CDR0032248",
"closedOn": null,
"reinstateBefore": null,
"isReinstated": false,
"isLeoTprmEnabled": false,
"terminatedOn": null,
"documentCode": "73fbfc4f-ab89-47d5-afc8-bd42c7519266",
"leoMasterRiskAssessmentId": "0",
"requestGuid": "",
"masterRiskAssessmentId": 0,
"documentNumber": "CDR0032248",
"longDocumentCode": "000000034250",
"referenceRootId": "80d3dbbe-a266-4468-be54-3e5f459e59a7",
"leaseScheduleNumber": "",
"isCatalogIntegrationEnabled": false,
"lineCount": 0,
"isLinesExists": false,
"signedOn": null,
"executedOn": null,
"approvedOn": null,
"leaseContractNumber": "",
"timeStamp": null,
"isAttachmentVisible": false,
"initialSourceType": "",
"initialSourceId": "",
"isAuthor": false,
"isCoAuthor": false,
"isOwner": false,
"isBulkDocument": false,
"isConversionNeeded": false,
"primarySupplierName": "",
"isApprover": false,
"isTeamMember": false,
"holdReason": "",
"isReviewer": false,
"holdDate": null,
"isSupplierPOC": false,
"signatoryType": "",
"rebateCounter": 0,
"isModificationInProgress": false,
"isModificationCopy": false,
"modificationRevisionNumber": "",
"modificationRevisedContractNumber": "",
"signatureModeKey": "",
"isNewFileAdded": false,
"isNewVersionCreated": false,
"copyLinesOngoing": false,
"isDeleted": false,
"documentStatusHistory": {
"stateCode": "",
"stateName": "",
"culture": "",
"version": "",
"statusKey": ""
},
"internalParties": [],
"legalTerm": {
"isAutoRenew": false,
"aggregatedLinetotal": 0.0,
"currencyConversionDate": "2025-01-20T16:58:08.933Z",
"effectiveDate": "2025-01-20T16:58:08.933Z",
"effectiveForInDays": 0,
"effectiveForInMonths": 0,
"isCoterminous": false,
"isPerpetual": false,
"originalExpiryDate": "2025-02-19T16:58:08.933Z",
"renewelCounter": 0,
"renewelFrequency": 0,
"renewelTerm": 0,
"utilizedValue": 0.0,
"baseCurrencyValue": 0.0,
"initialLimit": 0.0,
"initialValue": 0.0,
"value": 0.0,
"limit": 0.0,
"originalValue": 0.0,
"expiryTimeline": "",
"expiryDate": "2025-02-19T16:58:08.933Z",
"lineTotalAmount": 0.0,
"noticePeriod": 0,
"effectivePeriod": 0,
"previousContractValue": 0.0,
"originalContractValue": 0.0,
"previousContractValueInBaseCurrency": 0.0,
"contractValueDifference": 0.0,
"contractValueDifferenceInPercentage": 0.0,
"contractValueDifferenceAbsolute": 0.0,
"autoTerminationDate": null,
"originalEffectiveDate": "2025-01-20T16:58:08.933Z",
"renewelTermType": {
"culture": "",
"version": "",
"id": "",
"name": "",
"code": "",
"localeKey": ""
},
"paymentTerm": {
"isDefault": false,
"paymentTermCode": "NT30",
"lob": "ALL",
"orgEntityDetailCode": "ALL|ALL",
"paymentTermName": "NET 30 DAYS INV - NT30",
"description": "NET 30 DAYS INV - NT30",
"dueDays": 30,
"discountPercentage": 5,
"discountDays": 5,
"markAsDefault": true,
"clientCode": "115",
"sourceSystem": "",
"isActive": true,
"culture": "",
"version": "",
"id": "",
"name": "NET 30 DAYS INV - NT30",
"code": "NT30",
"erpCodeMapping": [
{
"code": "",
"lobCode": "",
"erpCode": ""
}
],
"customKeys": [
{
"key": "",
"value": ""
}
]
},
"contractValue": {
"fromCurrency": "",
"conversionDate": "",
"value": 0.0,
"currencyValue": 0.0,
"convertedValue": 0.0,
"isInitialContractValue": false,
"percent": 0.0
},
"currency": {
"code": "",
"name": ""
},
"initialContractValue": {
"fromCurrency": "",
"conversionDate": "",
"value": 0.0,
"currencyValue": 0.0,
"convertedValue": 0.0,
"isInitialContractValue": false,
"percent": 0.0
},
"initialCurrency": {
"code": "",
"name": ""
},
"aggregatedLineTotalAmount": {
"fromCurrency": "",
"conversionDate": "",
"value": 0.0,
"currencyValue": 0.0,
"convertedValue": 0.0,
"isInitialContractValue": false,
"percent": 0.0
},
"noticePeriodTerm": {
"noticePeriod": 0,
"noticePeriodDate": null
},
"remainInEffect": {
"name": "To Date",
"code": "setDate"
},
"effectiveDuration": {
"code": "day",
"name": "Day(s)"
},
"contractLimit": {
"fromCurrency": "",
"conversionDate": "",
"value": 0.0,
"currencyValue": 0.0,
"convertedValue": 0.0,
"isInitialContractValue": false,
"percent": 0.0
},
"contractBaseCurrency": {
"code": "USD",
"name": "US Dollar"
}
},
"stage": {
"stateCode": "",
"stateName": "",
"culture": "",
"version": "",
"name": "Draft",
"code": "1",
"stageKey": ""
},
"review": {
"sentDate": null,
"reviewedDate": null,
"isActive": false,
"reviewers": [
{
"firstName": "",
"lastName": "",
"emailId": "",
"contactCode": 0
}
]
},
"utilizationDetailsList": [
{
"sourceDocumentnumber": "",
"contractNumber": "",
"utilizationDate": null,
"conversionDate": null,
"utilizedValue": 0,
"sourceDocumentCurrency": "",
"id": ""
}
],
"orgEntities": [
{
"entityDetailCode": "66",
"entityName": "Business Unit 3",
"entityType": "Business Unit",
"entityCode": "BU3",
"entityDetailDescription": "Business Unit 3",
"parentEntityDetailCode": "29",
"parentEntity": "SMART",
"parentEntityCode": "LOB",
"lobEntityDetailCode": "29",
"level": 3,
"lobName": "BuyerSqlConn",
"lobCode": "LOB",
"parentDetails": [
{
"entityName": "Line of Business",
"entityDetailCode": 29,
"level": 2,
"entityCode": "LOB"
}
]
}
],
"categories": [
{
"name": "AM00 - A-MOBILITY",
"description": "A-MOBILITY",
"gepId": "51336250003307",
"id": 51336250003307,
"level": 4,
"clientCode": "TA88",
"parentDetails": [
{
"name": "AM0 - A-MOBILITY",
"id": 51336250002286,
"level": 3
},
{
"name": "AM - A-MOBILITY",
"id": 51336250001832,
"level": 2
},
{
"name": "A - STEEL AND TRANSFORMATION",
"id": 51336250001719,
"level": 1
}
]
}
],
"externalParties": [
{
"isPrimary": true,
"id": "8c3d0953-69c6-44a1-a705-da5444e4b87e",
"doingBusinessAs": "",
"name": "Praxair",
"clientPartnerCode": "PC-2025.005969",
"supplierCodes": [],
"partyType": [
{
"name": "",
"code": ""
}
],
"contact": {},
"signatories": [],
"supplierLocation": []
}
],
"interfaceDetails": {
"errorDetails": "",
"sourceSystemValue": "",
"sourceSystemName": "",
"errorCode": "",
"documentNumber": "",
"outBoundStatus": {
"culture": "",
"version": "",
"id": "",
"name": "",
"code": "",
"localeKey": ""
}
},
"paymentFrequency": {
"name": "",
"id": 0
},
"basicDetail": {
"description": "",
"signedOn": null,
"executedOn": null,
"mode": 2,
"modeName": "Authoring Contract",
"submittedOn": null,
"closedOn": null,
"sourceType": "",
"sourceDocumentId": "",
"approvedOn": null,
"isConfidential": false,
"isGlobal": false,
"isTemplate": false,
"isArchived": false,
"revisionNo": "0",
"oldParentDocumentCode": "",
"comments": "",
"executionCycleTimeInMins": 0,
"contractMode": "",
"isTransactable": true,
"owner": {
"clientContactCode": "CC-2023.001001",
"emailId": "John.Smith@gep.com",
"firstName": "John",
"fullName": "John Smith",
"isActive": false,
"lastName": "Smith",
"isGroup": false,
"contactCode": 7002220104000001,
"userId": 479048,
"fullNameAndEmailId": "",
"id": "",
"buyerPartnerName": "",
"address": {
"smartAddressCode": "2548323",
"addressCode": "2548323",
"addressline1": "Airoli Station",
"addressline2": "Thane - Belapur Road",
"addressline3": "Mind Space",
"city": "Navi Mumbai",
"zipCode": "400708",
"stateCode": "0",
"phoneNo1": null,
"extensionNo1": "123",
"phoneNo2": null,
"extensionNo2": "123",
"mobileNo": "",
"faxNo": "91 (22) 6137 2121",
"emailAddress": "",
"poBoxNumber": "",
"isdCode": "",
"country": {
"countryId": 0,
"countryCode": "IN",
"countryName": "India",
"defaultLanguageCode": "en-US"
}
}
},
"author": {
"clientContactCode": "CC-2023.001001",
"emailId": "John.Smith@gep.com",
"firstName": "John",
"fullName": "John Smith",
"isActive": false,
"lastName": "Smith",
"isGroup": false,
"contactCode": 7002220104000001,
"userId": 479048,
"fullNameAndEmailId": "",
"id": "",
"buyerPartnerName": "",
"address": {
"smartAddressCode": "2548323",
"addressCode": "2548323",
"addressline1": "Airoli Station",
"addressline2": "Thane - Belapur Road",
"addressline3": "Mind Space",
"city": "Navi Mumbai",
"zipCode": "400708",
"stateCode": "0",
"phoneNo1": null,
"extensionNo1": "123",
"phoneNo2": null,
"extensionNo2": "123",
"mobileNo": "",
"faxNo": "91 (22) 6137 2121",
"emailAddress": "",
"poBoxNumber": "",
"isdCode": "",
"country": {
"countryId": 0,
"countryCode": "IN",
"countryName": "India",
"defaultLanguageCode": "en-US"
}
}
},
"contractSponsor": {},
"parentDocument": {
"documentCode": "",
"documentName": "",
"documentNumber": "",
"revisedContractNumber": ""
},
"approvers": [],
"operationReason": [],
"amendmentType": {
"culture": "",
"version": "",
"id": "",
"name": "",
"code": "",
"localeKey": ""
},
"contractSubType": {
"contractTypeId": "",
"subContractTypeCode": "",
"isDefault": false,
"culture": "",
"version": "",
"id": "",
"name": "",
"code": "",
"lineType": ""
},
"contractType": {
"contractTypeCode": "TLA",
"culture": "",
"version": "",
"id": "986121b3-aea7-40c7-ad21-35d851f74410",
"name": "Tooling Loan Agreement",
"code": "",
"docNumberGenerationKey": "",
"contractGrouping": [
{
"code": "",
"name": ""
}
]
},
"interfaceStatus": {
"culture": "",
"version": "",
"id": "",
"name": "",
"code": "",
"localeKey": ""
},
"operationReasonObject": {
"code": "",
"name": "",
"codeType": ""
},
"terminationReason": {
"id": 0,
"reason": "",
"comments": "",
"type": 0,
"createdDate": null,
"code": 0
}
},
"parentDocumentLinkInfo": [
{
"documentCode": "",
"documentId": "",
"documentLinkType": "",
"id": "",
"documentType": "",
"documentNumber": ""
}
],
"documentLinks": [],
"stageHistory": {
"stateCode": "",
"stateName": "",
"culture": "",
"version": "",
"name": "",
"code": "",
"stageKey": ""
},
"flagcollection": {
"flowCompleted": false,
"isAmendmentContract": false
},
"ultimateParent": {
"documentName": "CDR0032248",
"documentNumber": "CDR0032248",
"documentCode": "73fbfc4f-ab89-47d5-afc8-bd42c7519266",
"revisedContractNumber": ""
},
"notesAndLinks": [],
"documentStatus": {
"stateCode": "1",
"stateName": "Draft",
"culture": "",
"version": "",
"statusKey": ""
},
"regions": [
{
"level": 1,
"culture": "",
"displayName": "ANDORRA",
"name": "ANDORRA",
"id": 370,
"code": "370",
"parentDetails": [
{
"name": "Americas",
"code": "191",
"level": 1
},
{
"name": "North America",
"code": "11",
"level": 2
}
]
}
],
"contractConsumptionHeader": {
"contractAllocationValue": 0.0,
"contractConsumptionValue": 0.0,
"contractInvoicedValue": 0.0,
"contractInvoicedQuantity": 0.0,
"contractConsumptionQuantity": 0.0,
"id": "",
"availableAmount": 0.0,
"contractAllocationValueInBaseCurrency": 0.0,
"contractConsumptionValueInBaseCurrency": 0.0,
"contractInvoicedValueInBaseCurrency": 0.0,
"migratedInvoicedValue": 0.0,
"contractCreditMemoValue": 0.0,
"contractCreditMemoQuantity": 0.0,
"contractCreditMemoValueInBaseCurrency": 0.0
},
"contractScore": {
"clauseRiskScore": 0.0,
"performanceScore": 0.0
},
"defineAccess": {
"tierId": "",
"tierName": "Tier Name1"
},
"workgroups": [],
"createdByUser": {
"buyerPartnerName": "",
"clientContactCode": "CC-2023.001001",
"emailId": "John.Smith@gep.com",
"firstName": "John",
"fullName": "John Smith",
"isActive": false,
"lastName": "Smith",
"isGroup": false,
"contactCode": 7002220104000001,
"userId": 479048,
"fullNameAndEmailId": "",
"id": "479048"
},
"modifiedByUser": {
"buyerPartnerName": "",
"clientContactCode": "CC-2023.001001",
"emailId": "John.Smith@gep.com",
"firstName": "John",
"fullName": "John Smith",
"isActive": false,
"lastName": "Smith",
"isGroup": false,
"contactCode": 7002220104000001,
"userId": 479048,
"fullNameAndEmailId": "",
"id": "479048"
},
"outboundToERP": {
"name": "",
"code": ""
},
"customAttributes": {},
"disposalFields": {},
"url": "https://nexxeqc.gep.com/LeoSMB/v3/#/contract_create/73fbfc4f-ab89-47d5-afc8-bd42c7519266"
}
],
"errorMessage": ""
}
Data Elements
Payload/Request | ||||
Property | Required? | Data type | Description | Validations / Exceptions |
pageSize
| Yes | String | Number of documents per page | Page Size should not exceed the value defined in the config CLM_GetAllContracts_Threshold
|
pageNumber
| Yes
| String | Page Number | Page number starts with '1'
|
outboundStatuses | No | Array | List of outbound statuses on which the final output will be filtered | Supported values (Pick - 1, Sent - 2, Success - 3, Process failed - 4)
|
documentStatuses | No | Array | List of document statuses on which the final output will be filtered |
|
contractTypes | No | Array | List of contract types on which the final output will be filtered |
|
contractSubTypes | No | Array | List of contract subtypes on which the final output will be filtered |
|
outboundToERP | No | Array | List of outboundToERP values on which the final output will be filtered | The config - CLM_EnableOutboundToERP must be enabled for this filter to work |
range | Yes | Object | This object contains the from date and to date properties |
|
range | ||||
Property | Required? | Data type | Description | Validations / Exceptions |
fromDate | Yes | String | The start date from which the contracts are to be filtered |
|
toDate | Yes | String | The end date to which the contracts are to be filtered |
|
Response | ||||
Property | Required? | Data type | Description | Validations / Exceptions |
CLMDetails |
| Array | A List of contract documents |
|
errorMessage |
| String | It’s a string which shows any errors / validation messages |
|