This GET API allows retrieval of contract details created in GEP SMART to post them into ERP.
URL Format: https://<Instance>/SmartInterfaceAPI/api/Contract/All
{
"data": [
{
"contractDetails": {
"contractTypeDescription": null,
"contractDocumentTypeDescription": null,
"dateEffective": null,
"dateExecuted": null,
"contractTerm": 0,
"contractTermTypeInfo": null,
"contractRenewalType": null,
"dateExpiry": null,
"expiryDateType": null,
"contractValue": 0.0,
"contractCurrency": null,
"legalCompanys": [
{
"legalCompanyName": null,
"partnerTypeName": null
}
],
"contractAdministrator": null,
"contractAuthorFirstName": null,
"contractAuthorLastName": null,
"url": null,
"paymentTermDetails": {
"noOfDays": 0,
"discount": 0.0,
"discountDays": 0,
"paymentTermCode": null
},
"contractTerminationDate": null,
"lastApprover": null,
"documentName": null,
"documentNumber": null,
"documentStatusInfo": null,
"documentPasList": [
{
"pasName": null,
"clientPASCode": null
}
],
"documentRegionList": [
{
"regionCode": 0,
"regionName": null,
"regionLevel": 0,
"isSelected": false,
"isSingleNode": false
}
],
"documentBuList": [
{
"businessUnitCode": null,
"businessUnitName": null
}
],
"documentStakeHolderList": [
{
"stakeholderType": null,
"partnerName": null,
"contactName": null,
"emailId": null,
"clientContactCode": null,
"address": null,
"clientPartnerCode": null,
"documentAddressDetailsList": [
{
"locationName": null,
"clientLocationCode": null
}
]
}
],
"isConfidential": false,
"interfaceDocumentStatus": null,
"createdOn": null,
"contractLanguageAttachmentName": [
""
],
"contractDescription": null,
"parentContractTitle": null,
"parentContractNumber": null,
"renewalTerm": null,
"renewalTermType": null,
"renewalFrequency": 0,
"terminationTypeDescription": null,
"terminationTerm": 0,
"terminationTermType": null,
"penaltyAmount": 0.0,
"erpNumber": null,
"entityDetails": [
{
"entityCode": null,
"entityType": null,
"lob": null
}
],
"paymentType": null,
"sourceSystemInformation": [
{
"name": null,
"value": null
}
],
"isAmendment": false,
"revisionNumber": 0,
"amendmentTypeDescription": null
},
"contractLineItemList": [
{
"startDate": null,
"endDate": null,
"itemId": 0,
"itemCode": 0,
"itemName": null,
"itemDescription": null,
"pasCode": 0,
"uomCode": null,
"unitPrice": 0.0,
"taxAmount": 0.0,
"totalPrice": 0.0,
"quantity": 0.0,
"unspscId": 0,
"itemType": null,
"itemAbbrevationCode": null,
"manufacturerName": null,
"partnerItemNumber": null,
"manufacturerItemNumber": null,
"gtin": null,
"catalogName": null,
"clientPasCode": null,
"isTaxExempt": null,
"lineItemNo": 0,
"lineItemStatus": null
}
],
"additionalInformationTabList": [
{
"tabName": null,
"additionalInformationSectionList": [
{
"sectionName": null,
"additionalInformationQuestionList": [
{
"questionText": null,
"questionsResponseList": [
{
"isChildQuestionPresent": false,
"answer": null,
"childQuestionList": [
{
"questionText": null,
"questionsResponseList": null
}
]
}
]
}
]
}
]
}
],
"lstContractLinkInfo": [
{
"documentTypeCode": null,
"documentName": null,
"dateCreated": null,
"documentNumber": null,
"createdBy": null,
"associationType": null
}
],
"contractAttachments": {
"accessibletoSupplier": false,
"isCompressed": false,
"compressedAttachmentsData": null,
"attachmentDetails": [
{
"attachmentType": 0,
"attachmentName": null,
"attachmentData": null,
"action": null
}
],
"errorMessage": null
}
}
],
"statusCode": "string",
"errorDetails": [
{
"key": "string",
"errors": [
{
"errorCode": "string",
"errorDescription": "string"
}
]
}
],
"successDetails": [
{
"key": "string"
}
]
}
{
"data": [
{
"contractDetails": {
"contractTypeDescription": "MPA",
"contractDocumentTypeDescription": "High CHESM Risk, $0 - $2.5MM / total contract life",
"dateEffective": "2019-05-15T00:00:00",
"dateExecuted": "2019-05-15T10:17:13.803",
"expiryDateType": "on need basis",
"contractValue": 0,
"contractCurrency": "currency_0",
"legalCompanys": [
{
"legalCompanyName": "North America Exploration and Production Company (U.S.A. Inc. division)",
"partnerTypeName": "Company"
}
],
"contractTerm": 1,
"contractTermTypeInfo": "Test Term",
"contractRenewalType": "NA",
"dateExpiry": "2020-01-21T09:20:02.619Z",
"contractAdministrator": "Admin",
"contractAuthorFirstName": "test",
"contractAuthorLastName": "Admin",
"contractLanguageAttachmentName": [
"test.pdf", "1.docx"
],
"paymentType": "NA",
"sourceSystemInformation": [
{
"name": "OSR",
"value": 1
}
],
"isAmendment": false,
"revisionNumber": 0,
"amendmentTypeDescription": "Pricebook amendment",
"url": "https://smartdev.gep.com/Contract/ContractInfo/CreateContract?dd=ZGM9NTQyMzkmYnBjPTcwMDIxNzA00&md=bT0yJnNtPTY1&oloc=104&c=NzAwMjE3MDQ1",
"paymentTermDetails": {
"noOfDays": 0,
"discount": 0,
"discountDays": 0,
"paymentTermCode": "Z261"
},
"contractTerminationDate": null,
"lastApprover": null,
"documentName": "Copy of test con reg pb 1",
"documentNumber": "2019.001511",
"documentStatusInfo": "Live",
"documentPasList": [
{
"pasName": "00A - Buildings - Fixed",
"clientPASCode": "00A"
}
],
"documentRegionList": [
{
"regionCode": 369,
"regionName": "Africa, Asia Pacific & Middle East",
"isSelected": false,
"isSingleNode": false
}
],
"documentBuList": [
{
"businessUnitCode": "1003",
"businessUnitName": "EUREKA CA TRM :1003"
}
],
"documentStakeHolderList": [
{
"partnerName": null,
"stakeHolderType": “Author”,
"contactName": "Test",
"emailId": "123@gep.com",
"clientContactCode": "CC-2018.000062",
"address": {
"addressCode": 0,
"addressline1": null,
"addressline2": null,
"addressline3": null,
"city": "",
"zipCode": null,
"stateInfo": null,
"countryInfo": {
"countryCode": "US",
"countryName": "United States"
},
"phoneNo1": null,
"phoneNo2": null
},
"clientPartnerCode": null,
"partnerTypeName": null,
"documentAddressDetailsList": null
},
{
"partnerName": null,
"contactName": "CVX Admin Coordinator's",
"emailId": "tejas.patil@gep.com",
"clientContactCode": "SAPPC3_User",
"address": {
"addressCode": 0,
"addressline1": "Airoli Station",
"addressline2": "Thane - Belapur Road",
"addressline3": "Mind Space",
"city": "Navi Mumbai",
"zipCode": "400708",
"stateInfo": null,
"countryInfo": {
"countryCode": "US",
"countryName": "United States"
},
"phoneNo1": "91 (22) 6137 210\t\t\t\t0",
"phoneNo2": "91 (22) 6137 210\t\t\t\t0"
},
"clientPartnerCode": null,
"partnerTypeName": null,
"documentAddressDetailsList": null
},
{
"partnerName": "ABCD",
"contactName": null,
"emailId": null,
"clientContactCode": null,
"address": {
"addressCode": 0,
"addressline1": "asd",
"addressline2": "fgh",
"addressline3": null,
"city": "werer",
"zipCode": "Select a P",
"stateInfo": {
"stateAbbrevationCode": "AL"
},
"countryInfo": {
"countryCode": "US",
"countryName": "United States"
},
"phoneNo1": "45667789",
"phoneNo2": "45667789"
},
"clientPartnerCode": "PC-2019.000883",
"partnerTypeName": "Vendor",
"documentAddressDetailsList": []
}
],
"isConfidential": false,
"interfaceDocumentStatus": "new",
"createdOn": "2019-05-15T10:12:17.503",
"contractDescription": "test con reg pb 1",
"parentContractTitle": "",
"parentContractNumber": null,
"renewalTerm": 0,
"renewalTermType": "Years",
"renewalFrequency": 0,
"terminationTypeDescription": "Non-Performance",
"terminationTerm": 0,
"terminationTermType": 0,
"penaltyAmount": 0,
"erpNumber": null,
"entityDetails": [
{
"entityCode": "1003",
"entityType": "Plant",
"lob": "PC2_Tax"
}
]
},
"contractLineItemList": [
{
"startDate": "1999-05-31T23:50:00+05:30",
"endDate": "1999-05-31T23:50:00+05:30",
"itemId": 10,
"itemCode": 0,
"itemName": "BuyerItemName_0",
"itemDescription": "ShortName_0",
"pasCode": 0,
"uomCode": "UnitOfMeasure_0",
"unitPrice": 10,
"taxAmount": 10,
"totalPrice": 10,
"quantity": 10.4,
"unspscId": 0,
"itemType": "ItemType_0",
"itemAbbrevationCode": "BuyerItem10",
"manufacturerName": "ManufacturerName_0",
"partnerItemNumber": "SupplierPartID_0",
"manufacturerItemNumber": "ManufacturerPartID_0",
"gtin": null,
"catalogName": "BuyerCategoryName_0",
"clientPasCode": null,
"isTaxExempt": "zeroRated",
"lineItemNo": 10,
"lineItemStatus": "true"
},
{
"startDate": "1999-05-31T23:50:00+05:30",
"endDate": "1999-05-31T23:50:00+05:30",
"itemId": 10,
"itemCode": 0,
"itemName": "BuyerItemName_0",
"itemDescription": "ShortName_0",
"pasCode": 0,
"uomCode": "UnitOfMeasure_0",
"unitPrice": 10,
"taxAmount": 10,
"totalPrice": 10,
"quantity": 10.4,
"unspscId": 0,
"itemType": "ItemType_0",
"itemAbbrevationCode": "BuyerItem10",
"manufacturerName": "ManufacturerName_0",
"partnerItemNumber": "SupplierPartID_0",
"manufacturerItemNumber": "ManufacturerPartID_0",
"gtin": null,
"catalogName": "BuyerCategoryName_0",
"clientPasCode": null,
"isTaxExempt": "zeroRated",
"lineItemNo": 10,
"lineItemStatus": "true"
}
],
"additionalInformationTabList": [
{
"tabName": "Lease Questions",
"additionalInformationSectionList": [
{
"sectionName": "Additional Information",
"additionalInformationQuestionList": [
{
"questionText": "ACW Reference Number",
"questionsResponseList": [
{
"isChildQuestionPresent": false,
"childQuestionList": null
}
]
}
]
}
]
}
]
}
],
"statusCode": "200",
"errorDetails": [],
"successDetails": []
}
|
Get Contract Model |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
List of InterfaceContractModel object |
||||
|
Status Code |
String(100) |
|||
|
List of Error details |
||||
|
List of Success details |
||||
|
Data |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
List of ContractDetails object |
Details of contract |
|||
|
List of ContractLineItem object |
List of contract line items |
|||
|
List of AdditionalInformationTab object |
List of additional information |
|||
|
List of Linked ContractLinkInfo object |
List of Linked Documents |
|||
|
ContractDetails |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
List of DocumentStakeHolder object |
List of document stakeholder |
|||
|
IsConfidential |
Boolean |
Is confidential |
||
|
InterfaceDocumentStatus |
String |
Status of an interface document |
||
|
CreatedOn |
datetime |
Created on |
||
|
ContractDescription |
String |
Contract Description |
||
|
ParentContractTitle |
String |
Parent Contract Title |
||
|
List of DocumentBuList object |
Document Bu List |
|||
|
ParentContractNumber |
String |
Parent Contract Number |
||
|
RenewalTermType |
String |
Renewal Term Type |
||
|
RenewalFrequency |
Int |
Renewal Frequency |
||
|
TerminationTypeDescription |
String |
Termination Type Description |
||
|
TerminationTerm |
Int |
Termination Term |
||
|
TerminationTermType |
Int |
Termination Term Type |
||
|
PenaltyAmount |
Decimal |
Penalty Amount |
||
|
RenewalTerm |
Int |
Renewal Term |
||
|
ErpNumber |
String |
Erp Number |
||
|
List of InterfaceDocumentRegion object |
Document Region List |
|||
|
DocumentStatusInfo |
String |
Document Status Info |
||
|
ContractTypeDescription |
String |
Contract Type Description |
||
|
ContractDocumentTypeDesc ription |
String |
Contract Document Type Description |
||
|
DateEffective |
Datetime |
Date Effective |
||
|
DateExecuted |
Datetime |
Date Executed |
||
|
ContractTerm |
Long |
Effective Period |
||
|
ContractTermTypeInfo |
String |
Effective Period Frequency |
||
|
ContractRenewalType |
String |
Renewal |
||
|
DateExpiry |
Datetime |
Expiry Date |
||
|
ExpiryDateType |
String |
Expiry Date Type |
||
|
ContractValue |
Decimal |
Contract Value |
||
|
List of InterfaceDocumentPas object |
Document Pas List |
|||
|
ContractCurrency |
String |
Contract Currency |
||
|
Url |
String |
|||
|
List of InterfacePaymentTermDetails object |
PaymentTermDetails |
|||
|
ContractTerminationDate |
String |
Termination Date of Contract |
||
|
LastApprover |
String |
Last Approver |
||
|
DocumentName |
String |
Document Name |
||
|
DocumentNumber |
String |
Document Number |
||
|
List of LegalCompanys object |
Legal Companys |
|||
|
ContractAuthor |
String |
Contract Administrator |
||
|
List of EntityDetail object |
Entity Details |
|||
|
IsAmendment |
|
Boolean | IsAmendment | |
|
RevisionNumber |
Int | Revision Number | ||
|
ContractMode |
Yes |
String(50) |
Contract Mode |
|
|
PreUtilizedValue |
No |
Decimal |
Pre Utilized Value |
|
|
ContractLimit |
No |
Decimal |
Contract Limit |
|
|
ContractAdministrator |
Yes |
String(508) |
Contract Administrator |
|
|
ContractAuthorFirstName |
Yes |
String(800) |
Contract Author First Name |
|
|
ContractAuthorLastName |
Yes |
String(60) |
Contract Author Last Name |
|
|
ContractTerminationComments |
Yes |
String(100) |
Contract Termination Comments |
In the case of Termination, this is mandatory |
|
ContractLanguageAttachmentName |
No |
List of String |
Contract Language Attachment Name |
Not using this field |
|
RenewalFrequencyValue |
Yes |
int |
Renewal Frequency Value |
In the case of Renewal, this is mandatory |
|
PaymentType |
Yes |
String |
Payment Type |
|
|
IsAmendment |
No |
bool |
Is Amendment |
|
|
Operation |
No |
String(50) |
Operation |
|
|
AmendmentTypeDescription |
Yes |
String(100) |
Amendment Type Description |
In case of Amendment, this is mandatory |
|
SourceSystemInformation |
No | List of SourceSystemInformation object | Source System Information | |
|
DocumentStakeHolderList |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
PartnerName |
String |
Name of Partner |
||
|
ContactName |
String |
Name of contact |
||
|
EmailId |
String |
Email id |
||
|
ClientContactCode |
String |
Client contact code |
||
|
Address |
List of InterfaceContractAddress object |
Address |
||
|
ClientPartnerCode |
String |
Client partner code |
||
|
PartnerTypeName |
String |
Partner type name |
||
|
GroupSequenceId |
Yes | int | Sequence Id of the group | |
|
StakeholderType |
Yes | String(50) | Stakeholder Type | |
|
Address |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
AddressCode |
Long |
Address Code |
||
|
Addressline1 |
String |
Address line 1 |
||
|
Addressline2 |
String |
Address line 2 |
||
|
Addressline3 |
String |
Address line 3 |
||
|
City |
String |
City |
||
|
ZipCode |
String |
Zip code |
||
|
StateInfo |
StateInfo object |
State info |
||
|
CountryInfo |
CountryInfo object |
Country info |
||
|
PhoneNo1 |
String |
Phone no 1 |
||
|
PhoneNo2 |
String |
Phone no 2 |
||
|
County |
No | String(200) | County Name | |
|
PoBoxNumber |
No | String(100) | Po Box Number | |
|
ExtenstionNo1 |
No | String(20) | Extension No 1 | |
|
ExtenstionNo2 |
No | String(20) | Extension No 2 | |
|
FaxNo |
No | String(100) | FaxNo | |
|
StateInfo |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
StateAbbrevationCode |
String |
State Abbreviation Code |
||
|
StateOther |
No | String(15) | State Other | |
|
CountryInfo |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
CountryCode |
String |
Country Code |
||
|
CountryName |
String |
Country Name |
||
|
DocumentAddressDetails |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
ClientLocationCode |
String |
Client Location Code |
||
|
DocumentBuList |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
BusinessUnitCode |
String |
Business Unit Code |
|
|
|
BusinessUnitName |
String |
Business Unit Name |
|
|
|
DocumentRegionList |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
RegionCode |
Long |
Region Code |
|
|
|
RegionName |
String |
Region Name |
|
|
|
IsSelected |
Boolean |
Is Selected |
|
|
|
IsSingleNode |
Boolean |
Is Single Node |
|
|
|
ClientRegionCode |
Yes | String(50) | Client Region Code | |
|
RegionLevel |
Yes | int | Region Level | |
|
DocumentPasList |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
PasName |
String |
Pas Name |
|
|
|
ClientPASCode |
String |
Client PAS Code |
|
|
|
PaymentTermDetails |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
NoOfDays |
Int |
No Of Days |
|
|
|
Discount |
Decimal |
Discount |
|
|
|
DiscountDays |
Int |
Discount Days |
|
|
|
PaymentTermCode |
String |
Payment Term Code |
|
|
|
LegalCompanys |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
LegalCompanyName |
String |
Legal Company Name |
|
|
|
PartnerTypeName |
String |
Partner Type Name |
|
|
|
SequenceId |
Yes | int | Sequence ID | |
|
EntityDetails |
||||
|
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
|
EntityCode |
String |
Entity code | ||
|
EntityType |
String |
Entity type | ||
|
Lob |
String |
Line of business | ||
|
ContractLineItemList |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
IsTaxExempt |
String |
|||
|
ClientPasCode |
String |
|||
|
CatalogName |
String |
Name of the catalog | ||
|
Gtin |
String |
|||
|
ManufacturerItemNumber |
String |
|||
|
PartnerItemNumber |
String |
|||
|
ManufacturerName |
String |
|||
|
ItemAbbrevationCode |
String |
|||
|
ItemType |
String |
|||
|
UnspscId |
Long |
|||
|
LineItemNo |
Long |
|||
|
Quantity |
Decimal |
|||
|
TaxAmount |
Decimal |
|||
|
UnitPrice |
Decimal |
|||
|
UomCode |
String |
|||
|
PasCode |
Long |
|||
|
ItemDescription |
String |
|||
|
ItemName |
String |
|||
|
ItemCode |
Long |
|||
|
ItemId |
Long |
|||
|
EndDate |
DateTime |
|||
|
StartDate |
DateTime |
|||
|
TotalPrice |
Decimal |
|||
|
LineItemStatus |
String |
|||
|
AdditionalInformationTabList |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
TabName |
String |
|||
|
List of AdditionalInformationSection object |
||||
|
AdditionalInformationSectionList |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
SectionName |
String |
|||
|
List of AdditionalInformationQuestions object |
||||
|
AdditionalInformationQuestionsList |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
QuestionText |
String |
|||
|
List of AdditionalInformationQuestionsResponse object |
||||
|
QuestionsResponseList |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
IsChildQuestionPresent |
bool |
|||
|
List of AdditionalInformationQuestions object |
||||
|
ErrorDetails |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
Key |
String |
|||
|
List of Error object |
||||
|
Errors |
|||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
|
ErrorCode |
String |
||||
|
ErrorDescription |
String |
||||
|
SuccessDetails |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
Key |
String |
|||
|
ContractLinkInfo |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
DocumentTypeCode |
String |
|||
|
DocumentName |
String |
|||
|
DateCreated |
DateTime |
|||
|
DocumentNumber |
String |
|||
|
CreatedBy |
String |
|||
|
AssociationType |
String |
|||
|
SourceSystemInformation |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
Name |
No |
String(100) |
Name of Source System Information | |
|
Value |
No | String(50) | Value of Source System Information | |
|
InboundContractComments |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
CommentSequenceNumber |
Yes |
String(Max) |
Comment Sequence Number |
|
|
CommentText |
Yes |
String(Max) |
Comment Text |
|
|
CommentBy |
Yes |
String(Max) |
Comment By |
|
|
VisibleTo |
Yes |
String(Max) |
Visible To |
|
|
CommentType |
Yes |
String(Max) |
Comment Type |
|