GetAllContracts(GET) | GEP TECH DOCUMENTATION

Overview

This GET API can be used to pull contract metadata, milestones, and team members from the Quantum system in one call and post them into the ERP.

URL Format: https://<Instance>/leo-clm-v2-aggregator/api/v2/aggregator/GetAllContracts

Request

{
    "pageSize": "50",
    "pageNumber": "1",
    "range": {
        "fromDate": "2023-03-08T00:00:01.000Z",
        "toDate": "2023-03-24T00:00:05.000Z"
    },
    "outboundStatuses": [
        "1",
        "2",
        "3",
        "4"
    ],
    "documentStatuses": [
        "Live",
        "Executed"
    ],
    "contractTypes": [
        "Master Services Agreement",
        "Sub Agreement"
    ],
    "contractSubTypes": [
        "Services",
        "Combined"
    ],
    "outboundToERP": [
        "Yes"
    ]
}

Response

{
    "CLMDetails": [
        {
            "_id": "ecf6c399-3691-4c0a-b3bb-10753a3ecfe2",
            "isSourcingLineProcessed": false,
            "isParentContractLinkagePresent": false,
            "isPartialSave": false,
            "isDocSaved": false,
            "isMigrated": false,
            "isLatestCopy": true,
            "executedCounter": 1,
            "liveCounter": 1,
            "isAmendent": false,
            "amendentStatus": 0,
            "createdOn": "2025-01-16T05:52:54.062Z",
            "currentLiveDate": "2025-01-16T06:16:45.468Z",
            "cancelledOn": null,
            "latestExecutedOn": "2025-01-16T06:16:44.091Z",
            "expiredCounter": 0,
            "documentType": "101",
            "submittedOn": null,
            "reinstateDate": null,
            "modifiedBy": "LeoSMBAutomationUser1 Admin",
            "revisedContractNumber": "CDR0032151.0",
            "modifiedOn": "2025-01-16T06:16:45.468Z",
            "initialLiveDate": "2025-01-16T06:16:45.468Z",
            "documentName": "Normal Execution Flow_98022198",
            "closedOn": null,
            "reinstateBefore": null,
            "isReinstated": false,
            "isLeoTprmEnabled": false,
            "terminatedOn": null,
            "documentCode": "73be3bb9-4d70-40a0-afd1-3a7f983dfa7a",
            "leoMasterRiskAssessmentId": "0",
            "requestGuid": "",
            "masterRiskAssessmentId": 0,
            "documentNumber": "CDR0032151",
            "longDocumentCode": "000000034112",
            "referenceRootId": "777b9eb8-1df7-4d72-ad23-8960aa0edb2d",
            "leaseScheduleNumber": "",
            "isCatalogIntegrationEnabled": false,
            "lineCount": 0,
            "isLinesExists": false,
            "signedOn": "2025-01-16T06:16:42.267Z",
            "executedOn": "2025-01-16T06:16:44.091Z",
            "approvedOn": "2025-01-16T06:14:30.712Z",
            "leaseContractNumber": "",
            "timeStamp": null,
            "isAttachmentVisible": false,
            "initialSourceType": "",
            "initialSourceId": "",
            "isAuthor": true,
            "isCoAuthor": false,
            "isOwner": false,
            "isBulkDocument": false,
            "isConversionNeeded": true,
            "primarySupplierName": "CLM Automation Supplier",
            "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": "18",
                "stateName": "Executed",
                "culture": "en-US",
                "version": "1",
                "statusKey": ""
            },
            "internalParties": [
                {
                    "signatories": [
                        {
                            "userId": 479089,
                            "firstName": "Author2",
                            "lastName": "LeoSMBAuto",
                            "contactCode": 7002220104000013,
                            "emailId": "smartautomation13@gep.com",
                            "isActive": true,
                            "fullName": "Author2 LeoSMBAuto",
                            "clientContactCode": "CC-2023.000300",
                            "address": {
                                "smartAddressCode": "2548560",
                                "addressCode": "2548560",
                                "addressline1": "",
                                "addressline2": "",
                                "addressline3": "",
                                "city": "",
                                "zipCode": "",
                                "stateCode": "0",
                                "phoneNo1": "",
                                "extensionNo1": "",
                                "phoneNo2": "",
                                "extensionNo2": "",
                                "mobileNo": "",
                                "faxNo": "",
                                "emailAddress": "",
                                "poBoxNumber": "",
                                "isdCode": "",
                                "country": {
                                    "countryId": 221,
                                    "countryCode": "US",
                                    "countryName": "United States",
                                    "defaultLanguageCode": null
                                }
                            }
                        }
                    ],
                    "name": "GEP Pvt Ltd",
                    "id": "ece5c5a5-ec98-4322-8e37-afb489029333",
                    "clientCode": "IP001",
                    "referredAs": {
                        "id": "fead2f8e-bd43-42a4-babe-514d03365a26",
                        "name": "Purchasing Agent"
                    },
                    "attorney": {
                        "userId": 479089,
                        "firstName": "Author2",
                        "lastName": "LeoSMBAuto",
                        "contactCode": 7002220104000013,
                        "emailId": "smartautomation13@gep.com",
                        "isActive": true,
                        "fullName": "Author2 LeoSMBAuto",
                        "clientContactCode": "CC-2023.000300",
                        "address": {
                            "smartAddressCode": "2548560",
                            "addressCode": "2548560",
                            "addressline1": "",
                            "addressline2": "",
                            "addressline3": "",
                            "city": "",
                            "zipCode": "",
                            "stateCode": "0",
                            "phoneNo1": "",
                            "extensionNo1": "",
                            "phoneNo2": "",
                            "extensionNo2": "",
                            "mobileNo": "",
                            "faxNo": "",
                            "emailAddress": "",
                            "poBoxNumber": "",
                            "isdCode": "",
                            "country": {
                                "countryId": 221,
                                "countryCode": "US",
                                "countryName": "United States",
                                "defaultLanguageCode": null
                            }
                        }
                    }
                }
            ],
            "legalTerm": {
                "isAutoRenew": false,
                "aggregatedLinetotal": 0.0,
                "currencyConversionDate": "2025-01-16T05:52:57.317Z",
                "effectiveDate": "2025-01-16T00:00:00Z",
                "effectiveForInDays": 0,
                "effectiveForInMonths": 0,
                "isCoterminous": false,
                "isPerpetual": false,
                "originalExpiryDate": "2025-02-15T00:00:00Z",
                "renewelCounter": 0,
                "renewelFrequency": 0,
                "renewelTerm": 0,
                "utilizedValue": 0.0,
                "baseCurrencyValue": 1000.0,
                "initialLimit": 0.0,
                "initialValue": 0.0,
                "value": 1000.0,
                "limit": 0.0,
                "originalValue": 0.0,
                "expiryTimeline": "Feb-25",
                "expiryDate": "2025-02-15T00:00:00Z",
                "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-16T00:00:00Z",
                "renewelTermType": {
                    "culture": "",
                    "version": "",
                    "id": "",
                    "name": "",
                    "code": "",
                    "localeKey": ""
                },
                "paymentTerm": {
                    "isDefault": false,
                    "paymentTermCode": "NTR25",
                    "lob": "ALL",
                    "orgEntityDetailCode": "ALL|ALL",
                    "paymentTermName": "NET 25 DAYS INV RCPT - NTR25",
                    "description": "NET 25 DAYS INV RCPT - NTR25",
                    "dueDays": 25,
                    "discountPercentage": 5,
                    "discountDays": 5,
                    "markAsDefault": false,
                    "clientCode": "128",
                    "sourceSystem": "",
                    "isActive": true,
                    "culture": "",
                    "version": "",
                    "id": "",
                    "name": "NET 25 DAYS INV RCPT - NTR25",
                    "code": "NTR25",
                    "erpCodeMapping": [],
                    "customKeys": []
                },
                "contractValue": {
                    "fromCurrency": "",
                    "conversionDate": "",
                    "value": 1000.0,
                    "currencyValue": 0.0,
                    "convertedValue": 1000.0,
                    "isInitialContractValue": false,
                    "percent": 0.0
                },
                "currency": {
                    "code": "USD",
                    "name": "US Dollar"
                },
                "initialContractValue": {
                    "fromCurrency": null,
                    "conversionDate": null,
                    "value": 1000.0,
                    "currencyValue": null,
                    "convertedValue": 1000.0,
                    "isInitialContractValue": false,
                    "percent": 0.0
                },
                "initialCurrency": {
                    "code": "USD",
                    "name": "US Dollar"
                },
                "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": "1",
                "stateName": "Review",
                "culture": "en-US",
                "version": "1",
                "name": "In Effect",
                "code": "18",
                "stageKey": ""
            },
            "review": {
                "sentDate": null,
                "reviewedDate": null,
                "isActive": false,
                "reviewers": [
                    {
                        "firstName": "",
                        "lastName": "",
                        "emailId": "",
                        "contactCode": 0
                    }
                ]
            },
            "utilizationDetailsList": [
                {
                    "sourceDocumentnumber": "",
                    "contractNumber": "",
                    "utilizedValue": 0,
                    "sourceDocumentCurrency": "",
                    "id": ""
                }
            ],
            "orgEntities": [
                {
                    "entityCode": "BU2",
                    "displayName": "Business Unit 2",
                    "entityName": "Business Unit 2",
                    "entityId": "0",
                    "entityDetailCode": "31",
                    "id": "0",
                    "lobCode": "29",
                    "entityType": "Business Unit",
                    "parentEntity": "Line of Business",
                    "parentEntityCode": "LOB",
                    "parentEntityDetailCode": "29",
                    "parentDetails": [
                        {
                            "entityCode": "LOB",
                            "entityName": "Line of Business",
                            "entityDetailCode": 29,
                            "level": 2
                        }
                    ]
                },
                {
                    "entityCode": "MSD",
                    "displayName": "Dynamics",
                    "entityName": "Dynamics",
                    "entityId": "0",
                    "entityDetailCode": "54",
                    "id": "0",
                    "lobCode": "54",
                    "entityType": "SMART",
                    "parentDetails": []
                }
            ],
            "categories": [
                {
                    "id": 51336250000849,
                    "clientCode": "51336250000849",
                    "name": "BUSINESS TRAVEL",
                    "displayName": "BUSINESS TRAVEL",
                    "level": 1,
                    "parentDetails": []
                }
            ],
            "externalParties": [
                {
                    "id": "4b85df8c-29be-49a4-a40b-25e632fd89eb",
                    "doingBusinessAs": "DBA67",
                    "name": "CLM Automation Supplier",
                    "smartPartnerCode": 544822,
                    "clientPartnerCode": "PC-2024.005787",
                    "supplierCodes": [
                        {
                            "name": "Client Supplier Code",
                            "sourceIdentificationNo": "PC-2024.005787",
                            "code": 1,
                            "interfaceComments": "",
                            "interfaceStatus": {
                                "name": "",
                                "code": ""
                            }
                        }
                    ],
                    "partyType": [
                        {
                            "name": "",
                            "code": ""
                        }
                    ],
                    "contact": {
                        "firstName": "CLM Automation",
                        "lastName": "Supplier1",
                        "contactCode": 54482204000002,
                        "emailId": "smartautomation9@gep.com",
                        "fullName": "CLM Automation Supplier1",
                        "clientContactCode": "CC-2024.006127",
                        "address": {
                            "smartAddressCode": "3995",
                            "addressCode": "3995",
                            "addressline1": null,
                            "addressline2": null,
                            "addressline3": null,
                            "city": null,
                            "zipCode": null,
                            "stateCode": null,
                            "phoneNo1": "",
                            "extensionNo1": null,
                            "phoneNo2": null,
                            "extensionNo2": null,
                            "mobileNo": null,
                            "faxNo": null,
                            "emailAddress": null,
                            "poBoxNumber": null,
                            "isdCode": null,
                            "country": {
                                "countryId": 221,
                                "countryCode": "US",
                                "countryName": "United States",
                                "defaultLanguageCode": null
                            }
                        }
                    },
                    "isPrimary": true,
                    "signatories": [
                        {
                            "firstName": "CLM Automation",
                            "lastName": "Supplier1",
                            "contactCode": 54482204000002,
                            "emailId": "smartautomation9@gep.com",
                            "fullName": "CLM Automation Supplier1",
                            "clientContactCode": "CC-2024.006127",
                            "address": {
                                "smartAddressCode": "3995",
                                "addressCode": "3995",
                                "addressline1": null,
                                "addressline2": null,
                                "addressline3": null,
                                "city": null,
                                "zipCode": null,
                                "stateCode": null,
                                "phoneNo1": null,
                                "extensionNo1": null,
                                "phoneNo2": null,
                                "extensionNo2": null,
                                "mobileNo": null,
                                "faxNo": null,
                                "emailAddress": null,
                                "poBoxNumber": null,
                                "isdCode": null,
                                "country": {
                                    "countryId": 221,
                                    "countryCode": "US",
                                    "countryName": "United States",
                                    "defaultLanguageCode": null
                                }
                            }
                        }
                    ],
                    "supplierLocation": [],
                    "referredAs": {
                        "id": "6541b206-08fa-48b1-a9a1-95bce7f4adba",
                        "name": "Contractor"
                    }
                }
            ],
            "interfaceDetails": {
                "errorDetails": "",
                "sourceSystemValue": "",
                "sourceSystemName": "",
                "errorCode": "",
                "documentNumber": "",
                "outBoundStatus": {
                    "culture": "",
                    "version": "",
                    "id": "1",
                    "name": "Pick",
                    "code": "",
                    "localeKey": "-"
                }
            },
            "paymentFrequency": {
                "name": "",
                "id": 0
            },
            "basicDetail": {
                "description": "Testing Automation",
                "signedOn": "2025-01-16T06:16:42.267Z",
                "executedOn": "2025-01-16T06:16:44.091Z",
                "mode": 2,
                "modeName": "Authoring Contract",
                "submittedOn": null,
                "closedOn": null,
                "sourceType": "",
                "sourceDocumentId": "",
                "approvedOn": null,
                "isConfidential": true,
                "isGlobal": false,
                "isTemplate": false,
                "isArchived": false,
                "revisionNo": "0",
                "oldParentDocumentCode": "",
                "comments": "",
                "executionCycleTimeInMins": 24,
                "contractMode": "contractMode_2",
                "isTransactable": true,
                "owner": {
                    "clientContactCode": "CC-2023.000304",
                    "emailId": "smartautomation10@gep.com",
                    "firstName": "LeoSMBAutomationUser1",
                    "fullName": "LeoSMBAutomationUser1 Admin",
                    "isActive": false,
                    "lastName": "Admin",
                    "isGroup": false,
                    "contactCode": 7002220104000017,
                    "userId": 479093,
                    "fullNameAndEmailId": "",
                    "id": "",
                    "buyerPartnerName": "",
                    "address": {
                        "smartAddressCode": "2548564",
                        "addressCode": "2548564",
                        "addressline1": "",
                        "addressline2": "",
                        "addressline3": "",
                        "city": "",
                        "zipCode": "",
                        "stateCode": "0",
                        "phoneNo1": "",
                        "extensionNo1": "",
                        "phoneNo2": "",
                        "extensionNo2": "",
                        "mobileNo": "",
                        "faxNo": "",
                        "emailAddress": "",
                        "poBoxNumber": "",
                        "isdCode": "",
                        "country": {
                            "countryId": 0,
                            "countryCode": "US",
                            "countryName": "United States of America",
                            "defaultLanguageCode": null
                        }
                    }
                },
                "author": {
                    "clientContactCode": "CC-2023.000304",
                    "emailId": "smartautomation10@gep.com",
                    "firstName": "LeoSMBAutomationUser1",
                    "fullName": "LeoSMBAutomationUser1 Admin",
                    "isActive": false,
                    "lastName": "Admin",
                    "isGroup": false,
                    "contactCode": 7002220104000017,
                    "userId": 479093,
                    "fullNameAndEmailId": "",
                    "id": "",
                    "buyerPartnerName": "",
                    "address": {
                        "smartAddressCode": "2548564",
                        "addressCode": "2548564",
                        "addressline1": "",
                        "addressline2": "",
                        "addressline3": "",
                        "city": "",
                        "zipCode": "",
                        "stateCode": "0",
                        "phoneNo1": "",
                        "extensionNo1": "",
                        "phoneNo2": "",
                        "extensionNo2": "",
                        "mobileNo": "",
                        "faxNo": "",
                        "emailAddress": "",
                        "poBoxNumber": "",
                        "isdCode": "",
                        "country": {
                            "countryId": 0,
                            "countryCode": "US",
                            "countryName": "United States of America",
                            "defaultLanguageCode": null
                        }
                    }
                },
                "contractSponsor": {},
                "parentDocument": {
                    "documentCode": "",
                    "documentName": "",
                    "documentNumber": "",
                    "revisedContractNumber": ""
                },
                "approvers": [
                    {
                        "contactCode": 7002220104000017,
                        "isApproved": false
                    },
                    {
                        "contactCode": 7002220104000017,
                        "isApproved": true
                    }
                ],
                "operationReason": [],
                "amendmentType": {
                    "culture": "",
                    "version": "",
                    "id": "",
                    "name": "",
                    "code": "",
                    "localeKey": ""
                },
                "contractSubType": {
                    "contractTypeId": "13483002-5a1b-4ebc-be35-60509d64d2dc",
                    "subContractTypeCode": "M",
                    "isDefault": false,
                    "culture": "",
                    "version": "",
                    "id": "043ac117-d4ae-411c-804a-c517a00ee987",
                    "name": "Mutual",
                    "code": "",
                    "lineType": "0"
                },
                "contractType": {
                    "contractTypeCode": "MSA",
                    "culture": "",
                    "version": "",
                    "id": "13483002-5a1b-4ebc-be35-60509d64d2dc",
                    "name": "Master Services Agreement",
                    "code": "",
                    "docNumberGenerationKey": "",
                    "contractGrouping": [
                        {
                            "code": "1",
                            "name": "Buy Side"
                        },
                        {
                            "code": "2",
                            "name": "Sell Side"
                        }
                    ]
                },
                "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": "1",
                "stateName": "Review",
                "culture": "en-US",
                "version": "1",
                "name": "In Effect",
                "code": "18",
                "stageKey": ""
            },
            "flagcollection": {
                "flowCompleted": false,
                "isAmendmentContract": false
            },
            "ultimateParent": {
                "documentName": "Normal Execution Flow_98022198",
                "documentNumber": "CDR0032151",
                "documentCode": "73be3bb9-4d70-40a0-afd1-3a7f983dfa7a",
                "revisedContractNumber": ""
            },
            "notesAndLinks": [],
            "documentStatus": {
                "stateCode": "19",
                "stateName": "Live",
                "culture": "en-US",
                "version": "1",
                "statusKey": ""
            },
            "regions": [
                {
                    "level": 1,
                    "culture": "",
                    "displayName": "Africa",
                    "name": "Africa",
                    "id": 183,
                    "code": "183",
                    "parentDetails": []
                }
            ],
            "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.000304",
                "emailId": "smartautomation10@gep.com",
                "firstName": "LeoSMBAutomationUser1",
                "fullName": "LeoSMBAutomationUser1 Admin",
                "isActive": false,
                "lastName": "Admin",
                "isGroup": false,
                "contactCode": 7002220104000017,
                "userId": 479093,
                "fullNameAndEmailId": "",
                "id": "479093"
            },
            "modifiedByUser": {
                "buyerPartnerName": "",
                "clientContactCode": "CC-2023.000304",
                "emailId": "smartautomation10@gep.com",
                "firstName": "LeoSMBAutomationUser1",
                "fullName": "LeoSMBAutomationUser1 Admin",
                "isActive": false,
                "lastName": "Admin",
                "isGroup": false,
                "contactCode": 7002220104000017,
                "userId": 479093,
                "fullNameAndEmailId": "",
                "id": "479093"
            },
            "outboundToERP": {
                "name": "",
                "code": ""
            },
            "customAttributes": [],
            "disposalFields": {},
            "teamMembers": [
                {
                    "_id": "b6631d82-9d6b-4ae7-b250-54868ffedbf3",
                    "clientContactCode": "CC-2023.000303",
                    "coAuthor": false,
                    "contactCode": 7002220104000016,
                    "documentCode": "73be3bb9-4d70-40a0-afd1-3a7f983dfa7a",
                    "emailId": "smartautomation17@gep.com",
                    "firstName": "Approver1",
                    "fullName": "Approver1 LeoSMBAuto",
                    "isActive": true,
                    "isAttachmentVisible": true,
                    "isGroup": false,
                    "isSelected": false,
                    "lastName": "LeoSMBAuto",
                    "lineReviewer": false,
                    "parent_id": "ecf6c399-3691-4c0a-b3bb-10753a3ecfe2",
                    "queueId": null,
                    "queueName": null,
                    "reviewer": false,
                    "role": {
                        "name": "Business Activity Owner"
                    },
                    "root_id": "ecf6c399-3691-4c0a-b3bb-10753a3ecfe2",
                    "termReviewer": false,
                    "userId": 479092,
                    "viewer": false,
                    "action": null,
                    "buyerPartnerName": null,
                    "clmDetails_documentCode": null,
                    "groupId": null,
                    "groupName": null,
                    "id": null,
                    "isDeleted": null,
                    "teamId": null,
                    "teamName": null,
                    "group": {},
                    "address": {
                        "smartAddressCode": "2548563",
                        "addressCode": "2548563",
                        "addressline1": "",
                        "addressline2": "",
                        "addressline3": "",
                        "city": "",
                        "zipCode": "",
                        "stateCode": "0",
                        "phoneNo1": "9326116971",
                        "extensionNo1": "",
                        "phoneNo2": "",
                        "extensionNo2": "",
                        "mobileNo": "",
                        "faxNo": "",
                        "emailAddress": "",
                        "poBoxNumber": "",
                        "isdCode": "",
                        "country": {
                            "countryId": 221,
                            "countryCode": "US",
                            "countryName": "United States",
                            "defaultLanguageCode": null
                        }
                    }
                }
            ],
            "url": "https://nexxeqc.gep.com/LeoSMB/v3/#/contract_create/73be3bb9-4d70-40a0-afd1-3a7f983dfa7a"
        }
    ],
    "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'

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

CLMDetails
Property	Required?	Data type	Description	Validations / Exceptions
_id		String
IsSourcingLineProcessed		Boolean
isParentContractLinkagePresent		Boolean
isPartialSave		Boolean
isDocSaved		Boolean
isMigrated		Boolean
isLatestCopy		Boolean
executedCounter		Integer
liveCounter		Integer
isAmendent		Boolean
amendentStatus		Integer
createdOn		Date/Time
currentLiveDate		Date/Time
cancelledOn		Date/Time
latestExecutedOn		Date/Time
expiredCounter		Integer
documentType		String
submittedOn		Date/Time
reinstateDate		Date/Time
modifiedBy		String
revisedContractNumber		String
modifiedOn		Date/Time
initialLiveDate		Date/Time
documentName		String
closedOn		Date/Time
reinstateBefore		Date/Time
isReinstated		Boolean
isLeoTprmEnabled		Boolean
terminatedOn		Date/Time
documentCode		String
leoMasterRiskAssessmentId		String
requestGuid		String
masterRiskAssessmentId		Long Number
documentNumber		String
longDocumentCode		String
referenceRootId		String
leaseScheduleNumber		String
isCatalogIntegrationEnabled		Boolean
lineCount		Integer
isLinesExists		Boolean
signedOn		Date/Time
executedOn		Date/Time
approvedOn		Date/Time
leaseContractNumber		String
timeStamp		Date/Time
isAttachmentVisible		Boolean
initialSourceType		String
initialSourceId		String
isAuthor		Boolean
isCoAuthor		Boolean
isOwner		Boolean
isBulkDocument		Boolean
isConversionNeeded		Boolean
primarySupplierName		String
isApprover		Boolean
isTeamMember		Boolean
holdReason		String
isReviewer		Boolean
holdDate		Date/Time
isSupplierPOC		Boolean
signatoryType		String
rebateCounter		Integer
isModificationInProgress		Boolean
isModificationCopy		Boolean
modificationRevisionNumber		String
modificationRevisedContractNumber		String
signatureModeKey		String
isNewFileAdded		Boolean
isNewVersionCreated		Boolean
copyLinesOngoing		Boolean
isDeleted		Boolean
documentStatusHistory		Object
internalParties		Array	List of internal parties
legalTerm		Object
stage		Object
review		Object
utilizationDetailsList		Array
orgEntities		Array	List of organization entities
categories		Array	List of categories
externalParties		Array	List of external Parties
interfaceDetails		Object
paymentFrequency		Object
basicDetail		Object
parentDocumentLinkInfo		Array
documentLinks		Array
stageHistory		Object
flagcollection		Object
ultimateParent		Object
notesAndLinks		Array
documentStatus		Object
regions		Array
contractConsumptionHeader		Object
contractScore		Object
defineAccess		Object
workgroups		Array
createdByUser		Object
modifiedByUser		Object
outboundToERP		Object
customAttributes		Object	Domain specific custom attributes
disposalFields		Object
teamMembers		Array	List of Team members

teamMembers
Property	Required?	Data type	Description	Validations / Exceptions
_id		String
clientContactCode		String
coAuthor		Boolean
contactCode		Integer
documentCode		String
emailId		String
firstName		String
fullName		String
isActive		Boolean
isAttachmentVisible		Boolean
isGroup		Boolean
isSelected		Boolean
lastName		String
lineReviewer		Boolean
parent_id		String
queueId		String
queueName		String
reviewer		Boolean
role		Object
root_id		String
termReviewer		Boolean
userId		Integer
viewer		Boolean
action		String
buyerPartnerName		String
clmDetails_documentCode		String
groupId		Integer
groupName		String
id		String
isDeleted		Boolean
teamId		String
teamName		String
group		Object
address		Object

role
Property	Required?	Data type	Description	Validations / Exceptions
culture		String
version		String
id		String
name		String
code		String

group
Property	Required?	Data type	Description	Validations / Exceptions
id		String
name		String
code		String

disposalFields
Property	Required?	Data type	Description	Validations / Exceptions
onHold		Boolean
inactiveDate		Date/Time
retentionInYears		String
disposalDate		Date/Time
comments		String
disposalCountry		Object

createdByUser, modifiedByUser
Property	Required?	Data type	Description	Validations / Exceptions
userId		Integer
firstName		String
lastName		String
buyerPartnerName		String
contactCode		Integer
emailId		String
isActive		Boolean
fullName		String
clientContactCode		String
id		String
fullNameAndEmailId		String
isGroup		Boolean

workgroups
Property	Required?	Data type	Description	Validations / Exceptions
code		String
name		String
isDefault		Boolean
entityId		String
childCount		String
level		String
isActive		Boolean
ancestors		String
parentCode		String
displayName		String

contractScore
Property	Required?	Data type	Description	Validations / Exceptions
clauseRiskScore		Decimal
performanceScore		Decimal

contractConsumptionHeader
Property	Required?	Data type	Description	Validations / Exceptions
contractAllocationValue		Decimal
contractConsumptionValue		Decimal
contractInvoicedValue		Decimal
contractInvoicedQuantity		Decimal
contractConsumptionQuantity		Decimal
id		String
availableAmount		Decimal
contractAllocationValueInBaseCurrency		Decimal
contractConsumptionValueInBaseCurrency		Decimal
contractInvoicedValueInBaseCurrency		Decimal
migratedInvoicedValue		Decimal
contractCreditMemoValue		Decimal
contractCreditMemoQuantity		Decimal
contractCreditMemoValueInBaseCurrency		Decimal

regions
Property	Required?	Data type	Description	Validations / Exceptions
code		String
name		String
id		Integer
displayName		String
level		Integer
parentDetails		Array
culture		String

regions.parentDetails
Property	Required?	Data type	Description	Validations / Exceptions
code		String
name		String
level		Integer
id		Integer

notesAndLinks
Property	Required?	Data type	Description	Validations / Exceptions
type		Integer
description		String
createdOn		Date/Time
modifiedOn		Date/Time
sequenceNo		Integer
id		String
isEditable		Boolean
name		String
code		String
isNotesAndLinksConfidential		Boolean

documentStatusHistory, documentStatus
Property	Required?	Data type	Description	Validations / Exceptions
stateCode		String
stateName		String
culture		String
version		String
statusKey		String

flagcollection
Property	Required?	Data type	Description	Validations / Exceptions
isAmendmentContract		Boolean
flowCompleted		Boolean

internalParties
Property	Required?	Data type	Description	Validations / Exceptions
signatories		Array	List of signatories
name		String
id		String
clientCode		String
referredAs		Object
attorney		Object

signatories, contact, attorney, basicDetail.owner, basicDetail.author, basicDetail.contractSponsor
Property	Required?	Data type	Description	Validations / Exceptions
userId		Integer
firstName		String
lastName		String
clientCode		String
contactCode		Integer
emailId		String
isActive		Boolean
fullName		String
clientContactCode		String
address		Object

address
Property	Required?	Data type	Description	Validations / Exceptions
smartAddressCode		String
addressCode		String
addressline1		String
addressline2		String
addressline3		String
city		String
zipCode		String
stateCode		String
phoneNo1		String
extensionNo1		String
phoneNo2		String
extensionNo2		String
mobileNo		String
faxNo		String
emailAddress		String
poBoxNumber		String
isdCode		String
country		Object

country
Property	Required?	Data type	Description	Validations / Exceptions
countryId		Integer
countryCode		String
countryName		String
defaultLanguageCode		String

referredAs
Property	Required?	Data type	Description	Validations / Exceptions
id		String
name		String

legalTerm
Property	Required?	Data type	Description	Validations / Exceptions
isAutoRenew		Boolean
aggregatedLinetotal		Decimal
currencyConversionDate		Date/Time
effectiveDate		Date/Time
effectiveForInDays		Integer
effectiveForInMonths		Integer
isCoterminous		Boolean
isPerpetual		Boolean
originalExpiryDate		Date/Time
renewelCounter		Integer
renewelFrequency		Integer
renewelTerm		Integer
utilizedValue		Decimal
baseCurrencyValue		Decimal
initialLimit		Decimal
initialValue		Decimal
value		Decimal
limit		Decimal
originalValue		Decimal
expiryTimeline		String
expiryDate		Date/Time
lineTotalAmount		Decimal
noticePeriod		Integer
effectivePeriod		Integer
previousContractValue		Decimal
originalContractValue		Decimal
previousContractValueInBaseCurrency		Decimal
contractValueDifference		Decimal
contractValueDifferenceInPercentage		Decimal
contractValueDifferenceAbsolute		Decimal
autoTerminationDate		Date/Time
originalEffectiveDate		Date/Time
renewelTermType		Object
paymentTerm		Object
contractValue		Object
currency		Object
initialContractValue		Object
initialCurrency		Object
aggregatedLineTotalAmount		Object
noticePeriodTerm		Object
remainInEffect		Object
effectiveDuration		Object
contractLimit		Object
contractBaseCurrency		Object

renewelTermType, basicDetail.amendmentType, basicDetail.interfaceStatus, disposalCountry
Property	Required?	Data type	Description	Validations / Exceptions
code		String
name		String
culture		String
version		String
localeKey		String
id		String

paymentTerm
Property	Required?	Data type	Description	Validations / Exceptions
isDefault		Boolean
paymentTermCode		String
lob		String
orgEntityDetailCode		String
paymentTermName		String
description		String
dueDays		Integer
discountPercentage		Integer
discountDays		Integer
markAsDefault		Boolean
clientCode		String
sourceSystem		String
isActive		Boolean
culture		String
version		String
id		String
name		String
code		String
erpCodeMapping		Array
customKeys		Array

erpCodeMapping
Property	Required?	Data type	Description	Validations / Exceptions
code		String
lobCode		String
erpCode		String

customKeys
Property	Required?	Data type	Description	Validations / Exceptions
key		String
value		String

contractValue, initialContractValue, contractLimit
Property	Required?	Data type	Description	Validations / Exceptions
fromCurrency		String
conversionDate		Date/Time
value		Decimal
currencyValue		Decimal
convertedValue		Decimal
isInitialContractValue		Boolean
percent		Decimal

currency, initialCurrency, remainInEffect, effectiveDuration, contractBaseCurrency, interfaceStatus, partyType, contractGrouping, outboundToERP
Property	Required?	Data type	Description	Validations / Exceptions
code		String
name		String

noticePeriodTerm
Property	Required?	Data type	Description	Validations / Exceptions
noticePeriod		Integer
noticePeriodDate		String

stage, stageHistory
Property	Required?	Data type	Description	Validations / Exceptions
stateCode		String
stateName		String
culture		String
version		String
stageKey		String
name		String
code		String

review
Property	Required?	Data type	Description	Validations / Exceptions
sentDate		Date/Time
reviewedDate		Date/Time
isActive		Boolean
reviewers		Array	List of reviewers

reviewers
Property	Required?	Data type	Description	Validations / Exceptions
firstName		String
lastName		String
emailId		String
contactCode		Integer

utilizationDetailsList
Property	Required?	Data type	Description	Validations / Exceptions
sourceDocumentnumber		String
contractNumber		String
utilizedValue		Integer
sourceDocumentCurrency		String
id		String

orgEntities
Property	Required?	Data type	Description	Validations / Exceptions
entityCode		String
displayName		String
entityName		String
entityId		String
entityDetailCode		String
id		String
lobCode		String
entityType		String
parentEntity		String
parentEntityCode		String
parentDetails		Array

orgEntities.parentDetails
Property	Required?	Data type	Description	Validations / Exceptions
entityCode		String
entityName		String
level		Integer
entityDetailCode		Integer

categories
Property	Required?	Data type	Description	Validations / Exceptions
clientCode		String
name		String
id		Decimal
displayName		String
level		Decimal
parentDetails		Array

categories.parentDetails
Property	Required?	Data type	Description	Validations / Exceptions
id		Integer
name		String
level		Integer

externalParties
Property	Required?	Data type	Description	Validations / Exceptions
signatories		Array	List of signatories
name		String
id		String
clientPartnerCode		String
referredAs		Object
contact		Object
doingBusinessAs		String
smartPartnerCode		Integer
supplierCodes		Array
partyType		Array
supplierLocation		Array
isPrimary		Boolean

supplierCodes
Property	Required?	Data type	Description	Validations / Exceptions
name		String
sourceIdentificationNo		String
code		Integer
interfaceComments		String
interfaceStatus		Object

supplierLocation
Property	Required?	Data type	Description	Validations / Exceptions
clientLocationCode		String
leoLocationId		String
locationCode		String
locationName		String
locationId		Integer
orderingLocationAddress		String
partyName		String
address		Object

interfaceDetails
Property	Required?	Data type	Description	Validations / Exceptions
errorDetails		String
sourceSystemValue		String
sourceSystemName		String
errorCode		String
outBoundStatus		Object
documentNumber		String

outBoundStatus
Property	Required?	Data type	Description	Validations / Exceptions
culture		String
version		String
id		String
name		String
localeKey		String
code		String

paymentFrequency
Property	Required?	Data type	Description	Validations / Exceptions
id		Integer
name		String

basicDetail
Property	Required?	Data type	Description	Validations / Exceptions
description		String
signedOn		Date/Time
executedOn		Date/Time
mode		Integer
modeName		String
submittedOn		Date/Time
closedOn		Date/Time
sourceType		String
sourceDocumentId		String
approvedOn		Date/Time
isConfidential		Boolean
isGlobal		Boolean
isTemplate		Boolean
isArchived		Boolean
revisionNo		String
oldParentDocumentCode		String
comments		String
executionCycleTimeInMins		Integer
contractMode		String
isTransactable		Boolean
owner		Object
author		Object
contractSponsor		Object
parentDocument		Object
approvers		Array
operationReason		Array
amendmentType		Object
contractSubType		Object
contractType		Object
interfaceStatus		Object
operationReasonObject		Object
terminationReason		Object

parentDocument, ultimateParent
Property	Required?	Data type	Description	Validations / Exceptions
documentCode		String
documentName		String
documentNumber		String
revisedContractNumber		String

approvers
Property	Required?	Data type	Description	Validations / Exceptions
contactCode		Integer
isApproved		Boolean

operationReason, terminationReason
Property	Required?	Data type	Description	Validations / Exceptions
reason		String
comments		String
id		Integer
type		Integer
createdDate		Date/Time
code		Integer

contractSubType
Property	Required?	Data type	Description	Validations / Exceptions
code		String
name		String
culture		String
version		String
lineType		String
id		String
contractTypeId		String
subContractTypeCode		String
isDefault		Boolean

contractType
Property	Required?	Data type	Description	Validations / Exceptions
code		String
name		String
culture		String
version		String
contractTypeCode		String
id		String
docNumberGenerationKey		String
contractGrouping		Array

operationReasonObject
Property	Required?	Data type	Description	Validations / Exceptions
code		String
name		String
codeType		String

parentDocumentLinkInfo
Property	Required?	Data type	Description	Validations / Exceptions
documentCode		String
documentId		String
documentLinkType		String
id		String
documentType		String
documentNumber		String

documentLinks
Property	Required?	Data type	Description	Validations / Exceptions
id		String
dateCreated		String
linkedDocumentCode		String
linkedDocumentName		String
linkedDocumentNumber		String
documentUrl		String
relationType		Integer
relationTypeId		Integer
appId		Integer
statusCode		String
statusName		String
bpc		Integer