Overview
This API supports a variety of optional filters when pulling data from contracts outbound files.
DELTA
- You will only get the contracts whose status has changed.
- Once you get a contract via 'Delta,' it will be removed from the Delta queue for the next call.
- using ‘acknowledgement' API you can either mark the contract as ‘success’ or 'error’.
- The ones you acknowledge as errors are again put back in the delta queue and come up in the delta.
Request
{
"pageSize": "1",
"pageNumber": "1",
"outboundStatuses": [
"1",
"2",
"3",
"4"
],
"documentStatuses": [
"Live", "Executed"
],
"contractTypes": [
"Master Services Agreement", "Sub Agreement"
],
"contractSubTypes": [
"Services", "Combined"
],
"outboundToERP": ["Yes"]
}
Response
{
"CLMDetails": [
{
"_id": "a88548de-3957-4578-aee3-1425a066c83f",
"isSourcingLineProcessed": false,
"isParentContractLinkagePresent": false,
"isPartialSave": true,
"isDocSaved": false,
"isMigrated": false,
"isLatestCopy": true,
"executedCounter": 0,
"liveCounter": 0,
"isAmendent": false,
"amendentStatus": 0,
"createdOn": "2025-01-02T11:15:41.982Z",
"currentLiveDate": null,
"cancelledOn": null,
"latestExecutedOn": null,
"expiredCounter": 0,
"documentType": "101",
"submittedOn": null,
"reinstateDate": null,
"modifiedBy": "John Smith",
"revisedContractNumber": "CDR0029376.1",
"modifiedOn": "2025-01-02T11:15:41.982Z",
"initialLiveDate": null,
"documentName": "PRQ-003689",
"closedOn": null,
"reinstateBefore": null,
"isReinstated": false,
"isLeoTprmEnabled": false,
"terminatedOn": null,
"documentCode": "712d0250-eb5e-4e91-a8bf-6b4e0516c8f5",
"leoMasterRiskAssessmentId": "0",
"requestGuid": "",
"masterRiskAssessmentId": 0,
"documentNumber": "CDR0029376",
"longDocumentCode": "000000033877",
"referenceRootId": "f30e39a1-323a-4723-89c9-b101f74c4764",
"leaseScheduleNumber": "",
"isCatalogIntegrationEnabled": false,
"lineCount": 0,
"isLinesExists": false,
"signedOn": null,
"executedOn": null,
"approvedOn": null,
"leaseContractNumber": "",
"timeStamp": null,
"isAttachmentVisible": true,
"initialSourceType": "",
"initialSourceId": "",
"isAuthor": true,
"isCoAuthor": false,
"isOwner": true,
"isBulkDocument": false,
"isConversionNeeded": true,
"primarySupplierName": "",
"isApprover": false,
"isTeamMember": true,
"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": [
{
"signatories": [],
"name": "GEP Pvt Ltd",
"id": "7b4be109-2276-4e41-9efb-8d748991bd7d",
"clientCode": "GEP Pvt Ltd"
}
],
"legalTerm": {
"isAutoRenew": false,
"aggregatedLinetotal": 0.0,
"currencyConversionDate": "2024-09-12T12:04:25.802Z",
"effectiveDate": "2024-09-12T12:04:25.802Z",
"effectiveForInDays": 0,
"effectiveForInMonths": 0,
"isCoterminous": false,
"isPerpetual": false,
"originalExpiryDate": "2024-10-12T12:04:25.802Z",
"renewelCounter": 0,
"renewelFrequency": 0,
"renewelTerm": 0,
"utilizedValue": 0.0,
"baseCurrencyValue": 10.0,
"initialLimit": 0.0,
"initialValue": 0.0,
"value": 100.0,
"limit": 0.0,
"originalValue": 0.0,
"expiryTimeline": "Oct-24",
"expiryDate": "2024-10-12T12:04:25.802Z",
"lineTotalAmount": 0.0,
"noticePeriod": 0,
"effectivePeriod": 0,
"previousContractValue": 100.0,
"originalContractValue": 100.0,
"previousContractValueInBaseCurrency": 10.0,
"contractValueDifference": 0.0,
"contractValueDifferenceInPercentage": 0.0,
"contractValueDifferenceAbsolute": 0.0,
"autoTerminationDate": null,
"originalEffectiveDate": null,
"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": 100.0,
"currencyValue": 0.0,
"convertedValue": 10.0,
"isInitialContractValue": false,
"percent": 0.0
},
"currency": {
"code": "EUR",
"name": "Euro"
},
"initialContractValue": {
"fromCurrency": "",
"conversionDate": "",
"value": 100.0,
"currencyValue": 0.0,
"convertedValue": 2458.0,
"isInitialContractValue": false,
"percent": 0.0
},
"initialCurrency": {
"code": "EUR",
"name": "Euro"
},
"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": 100.0,
"currencyValue": 0.0,
"convertedValue": 10.0,
"isInitialContractValue": false,
"percent": 100.0
},
"contractBaseCurrency": {
"code": "",
"name": ""
}
},
"stage": {
"stateCode": "1",
"stateName": "Draft",
"culture": "",
"version": "",
"name": "Draft",
"code": "1",
"stageKey": ""
},
"review": {
"sentDate": null,
"reviewedDate": null,
"isActive": false,
"reviewers": [
{
"firstName": "",
"lastName": "",
"emailId": "",
"contactCode": 0
}
]
},
"utilizationDetailsList": [
{
"sourceDocumentnumber": "",
"contractNumber": "",
"utilizedValue": 0,
"sourceDocumentCurrency": "",
"id": ""
}
],
"orgEntities": [
{
"entityName": "Activity 4",
"entityId": "",
"entityDetailName": "",
"entityCode": "AC4",
"entityDetailCode": "51",
"entityDetailDescription": "Activity 4",
"id": "",
"displayName": "Activity 4",
"parentDetails": [
{
"entityName": "Project 3-No Compass",
"level": 4,
"entityDetailCode": 47
},
{
"entityName": "Business Unit 2",
"level": 3,
"entityDetailCode": 31
},
{
"entityName": "Line of Business",
"level": 2,
"entityDetailCode": 29
},
{
"entityName": "Organization",
"level": 1,
"entityDetailCode": 1
}
]
}
],
"categories": [
{
"id": 31191507,
"name": "Abrasive belts",
"gepId": "31191507",
"displayName": "Abrasive belts",
"level": 1,
"parentDetails": []
}
],
"externalParties": [],
"interfaceDetails": {
"errorDetails": "",
"sourceSystemValue": "",
"sourceSystemName": "",
"errorCode": "",
"documentNumber": "",
"outBoundStatus": {
"culture": "",
"version": "",
"id": "1",
"name": "Pick",
"code": "",
"localeKey": "Pick"
}
},
"paymentFrequency": {
"name": "",
"id": 0
},
"basicDetail": {
"description": "PRQ-003689",
"signedOn": null,
"executedOn": null,
"mode": 2,
"modeName": "Authoring Contract",
"submittedOn": null,
"closedOn": null,
"sourceType": "amend",
"sourceDocumentId": "b2c5aab2-6ee3-448a-8057-9b60521f6ac1",
"approvedOn": null,
"isConfidential": false,
"isGlobal": false,
"isTemplate": false,
"isArchived": false,
"revisionNo": "1",
"oldParentDocumentCode": "",
"comments": "",
"executionCycleTimeInMins": 48685,
"contractMode": "contractMode_2",
"isTransactable": false,
"owner": {
"clientContactCode": "CC-2023.001001",
"emailId": "Lokesh.Vaddi@gep.com",
"firstName": "Jane",
"fullName": "Jane Doe1",
"isActive": false,
"lastName": "Doe1",
"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": {
"clientContactCode": "",
"emailId": "",
"firstName": "",
"fullName": "",
"isActive": false,
"lastName": "",
"isGroup": false,
"contactCode": 0,
"userId": 0,
"fullNameAndEmailId": "",
"id": "",
"buyerPartnerName": ""
},
"parentDocument": {
"documentCode": "2b615a3b-525a-439d-9a6c-4c3fdf462fba",
"documentName": "",
"documentNumber": "",
"revisedContractNumber": ""
},
"approvers": [],
"operationReason": [],
"amendmentType": {
"culture": "",
"version": "",
"id": "",
"name": "",
"code": "",
"localeKey": ""
},
"contractSubType": {
"contractTypeId": "13483002-5a1b-4ebc-be35-60509d64d2dc",
"subContractTypeCode": "Services",
"isDefault": false,
"culture": "",
"version": "",
"id": "cbf31aa5-0352-441f-88ac-cce6738ad777",
"name": "Services",
"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": "b2c5aab2-6ee3-448a-8057-9b60521f6ac1",
"documentType": "1667294432",
"documentLinkType": "Flip",
"documentId": "18576d8f-9b36-46fc-b71b-bec1556f594e"
}
],
"documentLinks": [],
"stageHistory": {
"stateCode": "",
"stateName": "",
"culture": "",
"version": "",
"name": "",
"code": "",
"stageKey": ""
},
"flagcollection": {
"flowCompleted": false,
"isAmendmentContract": true
},
"ultimateParent": {
"documentName": "PRQ-003689",
"documentNumber": "CDR0029376",
"documentCode": "b2c5aab2-6ee3-448a-8057-9b60521f6ac1",
"revisedContractNumber": ""
},
"notesAndLinks": [],
"documentStatus": {
"stateCode": "1",
"stateName": "Draft",
"culture": "",
"version": "",
"statusKey": ""
},
"regions": [
{
"code": "28",
"id": 28,
"name": "Caribbean",
"culture": "",
"version": "",
"displayName": "Caribbean",
"level": 1877,
"parentDetails": [
{
"name": "191",
"code": "191",
"level": 1
}
]
}
],
"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": {},
"teamMembers": [
{
"_id": "3597bf0b-b845-40ab-85e9-7d6b7633ab71",
"clientContactCode": null,
"coAuthor": false,
"contactCode": 7002220104000056,
"documentCode": "712d0250-eb5e-4e91-a8bf-6b4e0516c8f5",
"emailId": "shital.birnale@gep.com",
"firstName": "Autoleosmb",
"fullName": "Autoleosmb Validator",
"isActive": true,
"isAttachmentVisible": true,
"isGroup": false,
"isSelected": false,
"lastName": "Validator",
"lineReviewer": false,
"parent_id": "a88548de-3957-4578-aee3-1425a066c83f",
"queueId": null,
"queueName": null,
"reviewer": false,
"role": {},
"root_id": "a88548de-3957-4578-aee3-1425a066c83f",
"termReviewer": false,
"userId": null,
"viewer": false,
"id": null,
"teamId": null,
"teamName": null,
"groupName": null,
"groupId": null,
"buyerPartnerName": null,
"action": null,
"isDeleted": null,
"clmDetails_documentCode": null,
"group": {},
"address": {
"smartAddressCode": "2549085",
"addressCode": "2549085",
"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": 0,
"countryCode": "IN",
"countryName": "India",
"defaultLanguageCode": "en-US"
}
}
},
{
"_id": "8820b51e-6365-42d3-926b-c1007c178e25",
"clientContactCode": null,
"coAuthor": false,
"contactCode": 7002220104000001,
"documentCode": "712d0250-eb5e-4e91-a8bf-6b4e0516c8f5",
"emailId": "Lokesh.Vaddi@gep.com",
"firstName": "Jane",
"fullName": "Jane Doe1",
"isActive": true,
"isAttachmentVisible": true,
"isGroup": false,
"isSelected": false,
"lastName": "Doe1",
"lineReviewer": false,
"parent_id": "a88548de-3957-4578-aee3-1425a066c83f",
"queueId": null,
"queueName": null,
"reviewer": false,
"role": {},
"root_id": "a88548de-3957-4578-aee3-1425a066c83f",
"termReviewer": false,
"userId": null,
"viewer": false,
"id": null,
"teamId": null,
"teamName": null,
"groupName": null,
"groupId": null,
"buyerPartnerName": null,
"action": null,
"isDeleted": null,
"clmDetails_documentCode": null,
"group": {},
"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"
}
}
},
{
"_id": "f2b02c6f-3d16-484c-8b7f-3527725c3033",
"clientContactCode": null,
"coAuthor": false,
"contactCode": 7002220104000004,
"documentCode": "712d0250-eb5e-4e91-a8bf-6b4e0516c8f5",
"emailId": "amruta.deo@gep.com",
"firstName": "CWB",
"fullName": "CWB Admin",
"isActive": true,
"isAttachmentVisible": true,
"isGroup": false,
"isSelected": false,
"lastName": "Admin",
"lineReviewer": false,
"parent_id": "a88548de-3957-4578-aee3-1425a066c83f",
"queueId": null,
"queueName": null,
"reviewer": false,
"role": {},
"root_id": "a88548de-3957-4578-aee3-1425a066c83f",
"termReviewer": false,
"userId": null,
"viewer": false,
"id": null,
"teamId": null,
"teamName": null,
"groupName": null,
"groupId": null,
"buyerPartnerName": null,
"action": null,
"isDeleted": null,
"clmDetails_documentCode": null,
"group": {}
},
{
"_id": "25b4f947-7dbb-41c9-b060-0b07a4eb3cd2",
"clientContactCode": null,
"coAuthor": false,
"contactCode": 7002220104000023,
"documentCode": "712d0250-eb5e-4e91-a8bf-6b4e0516c8f5",
"emailId": "shital.birnale@gep.com",
"firstName": "leosmb",
"fullName": "leosmb Validator",
"isActive": true,
"isAttachmentVisible": true,
"isGroup": false,
"isSelected": false,
"lastName": "Validator",
"lineReviewer": false,
"parent_id": "a88548de-3957-4578-aee3-1425a066c83f",
"queueId": null,
"queueName": null,
"reviewer": false,
"role": {},
"root_id": "a88548de-3957-4578-aee3-1425a066c83f",
"termReviewer": false,
"userId": null,
"viewer": false,
"id": null,
"teamId": null,
"teamName": null,
"groupName": null,
"groupId": null,
"buyerPartnerName": null,
"action": null,
"isDeleted": null,
"clmDetails_documentCode": null,
"group": {},
"address": {
"smartAddressCode": "2548741",
"addressCode": "2548741",
"addressline1": "",
"addressline2": "",
"addressline3": "",
"city": "",
"zipCode": "",
"stateCode": "0",
"phoneNo1": "",
"extensionNo1": "",
"phoneNo2": "",
"extensionNo2": "",
"mobileNo": "",
"faxNo": "",
"emailAddress": "",
"poBoxNumber": "",
"isdCode": "",
"country": {
"countryId": 100,
"countryCode": "IN",
"countryName": "India",
"defaultLanguageCode": null
}
}
},
{
"_id": "3c34c9b1-c28e-44b5-ac21-e6ef96556054",
"clientContactCode": null,
"coAuthor": false,
"contactCode": 7002220104000016,
"documentCode": "712d0250-eb5e-4e91-a8bf-6b4e0516c8f5",
"emailId": "smartautomation17@gep.com",
"firstName": "Approver1",
"fullName": "Approver1 LeoSMBAuto",
"isActive": true,
"isAttachmentVisible": true,
"isGroup": false,
"isSelected": false,
"lastName": "LeoSMBAuto",
"lineReviewer": false,
"parent_id": "a88548de-3957-4578-aee3-1425a066c83f",
"queueId": null,
"queueName": null,
"reviewer": false,
"role": {},
"root_id": "a88548de-3957-4578-aee3-1425a066c83f",
"termReviewer": false,
"userId": null,
"viewer": false,
"id": null,
"teamId": null,
"teamName": null,
"groupName": null,
"groupId": null,
"buyerPartnerName": null,
"action": null,
"isDeleted": null,
"clmDetails_documentCode": 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
}
}
},
{
"_id": "81fa4878-739f-4f9d-a32f-219ca884acbd",
"clientContactCode": null,
"coAuthor": false,
"contactCode": 7002220104000011,
"documentCode": "712d0250-eb5e-4e91-a8bf-6b4e0516c8f5",
"emailId": "smartautomation6@gep.com",
"firstName": "TeamMember1",
"fullName": "TeamMember1 LeoSMBAuto",
"isActive": true,
"isAttachmentVisible": true,
"isGroup": false,
"isSelected": false,
"lastName": "LeoSMBAuto",
"lineReviewer": false,
"parent_id": "a88548de-3957-4578-aee3-1425a066c83f",
"queueId": null,
"queueName": null,
"reviewer": false,
"role": {},
"root_id": "a88548de-3957-4578-aee3-1425a066c83f",
"termReviewer": false,
"userId": null,
"viewer": false,
"id": null,
"teamId": null,
"teamName": null,
"groupName": null,
"groupId": null,
"buyerPartnerName": null,
"action": null,
"isDeleted": null,
"clmDetails_documentCode": null,
"group": {},
"address": {
"smartAddressCode": "2548558",
"addressCode": "2548558",
"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
}
}
}
],
"url": "https://nexxeqc.gep.com/LeoSMB/v3/#/contract_create/712d0250-eb5e-4e91-a8bf-6b4e0516c8f5"
}
],
"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 |
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 |
|