This GET API allows retrieval of Service Confirmation details created in GEP SMART to post them into ERP.
URL Format: https://<Instance>/SmartInterfaceAPI/api/ServiceConfirmation/All
https://<Instance>/SmartInterfaceAPI/api/ServiceConfirmation/All
{
"data": [
{
"serviceConfirmationRequestHeader": {
"serviceConfirmationNumber": "string",
"partnerServiceConfirmationNumber": "string",
"description": "string",
"operation": "string",
"orderNumber": "string",
"orderName": "string",
"currency": "string",
"submittedBy": "string",
"submittedOn": "2020-05-28T13:26:07.239Z",
"serviceConfirmationName": "string",
"serviceConfirmationStatus": "string",
"serviceConfirmationApprover": "string",
"createdBy": "string",
"totalAmount": 0,
"clientPartnerCode": "string",
"serviceStartDate": "2020-05-28T13:26:07.239Z",
"serviceEndDate": "2020-05-28T13:26:07.239Z",
"workLocation": "string",
"headerComments": [
{
"commentText": "string",
"accessType": "string",
"commentAttachment": [
{
"fileName": "string",
"fileUri": "string",
"extension": "string",
"contentTransferEncoding": "string",
"attachmentData": "string"
}
]
}
],
"headerEntity": [
{
"entityCode": "string",
"isDefault": true,
"entityType": "string",
"lobEntityCode": "string"
}
],
"lob": {
"entityCode": "string",
"isDefault": true,
"entityType": "string",
"lobEntityCode": "string"
},
"sourceSystem": "string",
"serviceConfirmationDate": "2020-05-28T13:26:07.240Z",
"fieldSupervisorID": "string",
"originatingSourceSystem": "string",
"isERS": true,
"tax": 0
},
"serviceConfirmationOrder": {
"orderID": "string",
"serviceConfirmationItem": [
{
"serviceConfirmationLineNumber": 0,
"description": "string",
"quantity": 0,
"unitOfMeasure": "string",
"unitPrice": 0,
"poLineNumber": 0,
"itemType": "string",
"itemExtendedType": "string",
"contractNumber": "string",
"categoryName": "string",
"serviceStartDate": "2020-05-28T13:26:07.240Z",
"serviceEndDate": "2020-05-28T13:26:07.240Z",
"consumedDate": "2020-05-28T13:26:07.240Z",
"manufacturerPartID": "string",
"manufacturerName": "string",
"supplierPartID": "string",
"subLine": 0,
"scParentLine": 0,
"serviceLocation": {
"locationName": "string",
"locationNumber": "string",
"address": {
"addressline1": "string",
"addressline2": "string",
"addressline3": "string",
"city": "string",
"zipCode": "string",
"stateInfo": {
"stateAbbrevationCode": "string",
"stateName": "string"
},
"countryInfo": {
"countryCode": "string",
"countryName": "string"
},
"phoneNo1": "string",
"extenstionNo1": "string",
"phoneNo2": "string",
"extenstionNo2": "string",
"mobileNo": "string",
"faxNo": "string",
"county": "string"
},
"deliverTo": "string",
"registrationDetails": [
{
"companyIdentificationDisplayName": "string",
"companyIdentification": "string"
}
]
},
"itemSplit": [
{
"itemSplitEntities": [
{
"id": "string",
"name": "string",
"description": "string"
}
],
"charge": 0,
"splitType": "string",
"name": "string",
"quantity": 0,
"percentage": 0
}
],
"lineComment": [
{
"commentText": "string",
"accessType": "string",
"commentAttachment": [
{
"fileName": "string",
"fileUri": "string",
"extension": "string",
"contentTransferEncoding": "string",
"attachmentData": "string"
}
]
}
],
"agreementID": "string",
"tax": 0,
"supplierPersonalName": "string"
}
]
}
}
],
"statusCode": "String",
"errorDetails": [
{
"key": "string",
"errors": [
{
"errorCode": "string",
"errorDescription": "string"
}
]
}
],
"successDetails": [
{
"key": "String"
},
{
"key": "String"
}
]
}
Success Scenario - Request
https://<Instance>/SmartInterfaceAPI/api/ServiceConfirmation/All
Success Scenario - Response
{
"data": [
{
"ServiceConfirmationRequestHeader": {
"ServiceConfirmationNumber": "SC0504203",
"PartnerServiceConfirmationNumber": "SC0504203",
"Currency": "USD",
"ServiceConfirmationName": "ServiceConfirmation13 for PO1 for Untitled Requisition51 - Copy",
"ServiceConfirmationStatus": "Approved",
"ServiceConfirmationApprover": "ChevronTraining3.Admin@gep.com",
"CreatedBy": "123@gep.com",
"TotalAmount": 0,
"ClientPartnerCode": "0050007745",
"ServiceStartDate": "2020-03-13T06:30:00",
"ServiceEndDate": "2020-03-13T06:30:00",
"WorkLocation": "--",
"HeaderComments": [],
"HeaderEntity": [
{
"EntityCode": "PC2",
"IsDefault": false
},
{
"EntityCode": "ElSegundo",
"IsDefault": false
},
{
"EntityCode": "ElSegundo-0061",
"IsDefault": false
},
{
"EntityCode": "0061",
"IsDefault": false
},
{
"EntityCode": "DRES",
"IsDefault": false
},
{
"EntityCode": "DPDS",
"IsDefault": false
},
{
"EntityCode": "PCA",
"IsDefault": false
}
],
"ServiceConfirmationDate": "2020-05-29T06:36:02.62",
"FieldSupervisorID": "chevron ng5",
"IsERS": false,
"Tax": 0
},
"ServiceConfirmationOrder": {
"OrderID": "0060202536",
"ServiceConfirmationItem": [
{
"ServiceConfirmationLineNumber": 1,
"Description": "a",
"Quantity": 1,
"UnitOfMeasure": "AM",
"UnitPrice": 1,
"POLineNumber": 1,
"ItemType": "Service",
"ItemExtendedType": "Fixed",
"ServiceStartDate": "2020-03-13T06:30:00",
"ServiceEndDate": "2020-03-13T06:30:00",
"SubLine": 1,
"ScParentLine": 1,
"ServiceLocation": {
"LocationName": "EL SEGUNDO CA RFY CHEVRON:DRES",
"Address": {
"Addressline1": "324 WEST EL SEGUNDO BLVD",
"City": "EL SEGUNDO",
"ZipCode": "90245",
"StateInfo": {
"StateAbbrevationCode": "CA"
},
"CountryInfo": {
"CountryCode": "US",
"CountryName": "United States"
}
},
"RegistrationDetails": []
},
"ItemSplit": [
{
"ItemSplitEntities": [
{
"Id": "CC-2020.004830",
"Name": "Requester",
"Description": "chevron ng5"
},
{
"Id": "PC2",
"Name": "Division",
"Description": "PC2"
},
{
"Id": "ElSegundo",
"Name": "Business Unit",
"Description": "Manufacturing - El Segundo"
},
{
"Id": "ElSegundo-0061",
"Name": "BU-Company Code",
"Description": "ElSegundo-0061"
},
{
"Id": "0061",
"Name": "Company code",
"Description": "Chevron Products Company"
},
{
"Id": "DRES",
"Name": "Plant",
"Description": "EL SEGUNDO CA RFY CHEVRON:DRES"
},
{
"Id": "DPDS",
"Name": "Purchasing Org",
"Description": "CHEV PRODUCTS CO"
},
{
"Id": "PCA",
"Name": "Purchasing Group",
"Description": "PURCH CENTRAL ADM"
},
{
"Id": "X",
"Name": "Account Assignment Category",
"Description": "All aux.acct.assgts."
},
{
"Id": "DCA3727603",
"Name": "Cost Center",
"Description": "MS Mar Purch-Asp"
},
{
"Id": "0066900000",
"Name": "GL Account",
"Description": "BURDEN-OTHER COMPANY BENEFITS"
}
],
"Charge": 0.5,
"SplitType": "Quantity",
"Quantity": 0,
"Percentage": 0
},
{
"ItemSplitEntities": [
{
"Id": "CC-2020.004882",
"Name": "Requester",
"Description": "Sawan Buyer"
},
{
"Id": "PC2",
"Name": "Division",
"Description": "PC2"
},
{
"Id": "ElSegundo",
"Name": "Business Unit",
"Description": "Manufacturing - El Segundo"
},
{
"Id": "ElSegundo-0061",
"Name": "BU-Company Code",
"Description": "ElSegundo-0061"
},
{
"Id": "0061",
"Name": "Company code",
"Description": "Chevron Products Company"
},
{
"Id": "DRES",
"Name": "Plant",
"Description": "EL SEGUNDO CA RFY CHEVRON:DRES"
},
{
"Id": "DPDS",
"Name": "Purchasing Org",
"Description": "CHEV PRODUCTS CO"
},
{
"Id": "PCA",
"Name": "Purchasing Group",
"Description": "PURCH CENTRAL ADM"
},
{
"Id": "X",
"Name": "Account Assignment Category",
"Description": "All aux.acct.assgts."
},
{
"Id": "DCA3727603",
"Name": "Cost Center",
"Description": "MS Mar Purch-Asp"
},
{
"Id": "0066900000",
"Name": "GL Account",
"Description": "BURDEN-OTHER COMPANY BENEFITS"
}
],
"Charge": 0.5,
"SplitType": "Quantity",
"Quantity": 0,
"Percentage": 0
},
{
"ItemSplitEntities": [
{
"Id": "CC-2020.004882",
"Name": "Requester",
"Description": "Sawan Buyer"
},
{
"Id": "PC2",
"Name": "Division",
"Description": "PC2"
},
{
"Id": "ElSegundo",
"Name": "Business Unit",
"Description": "Manufacturing - El Segundo"
},
{
"Id": "ElSegundo-0061",
"Name": "BU-Company Code",
"Description": "ElSegundo-0061"
},
{
"Id": "0061",
"Name": "Company code",
"Description": "Chevron Products Company"
},
{
"Id": "DRES",
"Name": "Plant",
"Description": "EL SEGUNDO CA RFY CHEVRON:DRES"
},
{
"Id": "DPDS",
"Name": "Purchasing Org",
"Description": "CHEV PRODUCTS CO"
},
{
"Id": "PCA",
"Name": "Purchasing Group",
"Description": "PURCH CENTRAL ADM"
},
{
"Id": "X",
"Name": "Account Assignment Category",
"Description": "All aux.acct.assgts."
},
{
"Id": "DCA3727603",
"Name": "Cost Center",
"Description": "MS Mar Purch-Asp"
},
{
"Id": "0066900000",
"Name": "GL Account",
"Description": "BURDEN-OTHER COMPANY BENEFITS"
}
],
"Charge": 0.5,
"SplitType": "Quantity",
"Quantity": 0,
"Percentage": 0
},
{
"ItemSplitEntities": [
{
"Id": "CC-2020.004882",
"Name": "Requester",
"Description": "Sawan Buyer"
},
{
"Id": "PC2",
"Name": "Division",
"Description": "PC2"
},
{
"Id": "ElSegundo",
"Name": "Business Unit",
"Description": "Manufacturing - El Segundo"
},
{
"Id": "ElSegundo-0061",
"Name": "BU-Company Code",
"Description": "ElSegundo-0061"
},
{
"Id": "0061",
"Name": "Company code",
"Description": "Chevron Products Company"
},
{
"Id": "DRES",
"Name": "Plant",
"Description": "EL SEGUNDO CA RFY CHEVRON:DRES"
},
{
"Id": "DPDS",
"Name": "Purchasing Org",
"Description": "CHEV PRODUCTS CO"
},
{
"Id": "PCA",
"Name": "Purchasing Group",
"Description": "PURCH CENTRAL ADM"
},
{
"Id": "X",
"Name": "Account Assignment Category",
"Description": "All aux.acct.assgts."
},
{
"Id": "DCA3727603",
"Name": "Cost Center",
"Description": "MS Mar Purch-Asp"
},
{
"Id": "0066900000",
"Name": "GL Account",
"Description": "BURDEN-OTHER COMPANY BENEFITS"
}
],
"Charge": -0.5,
"SplitType": "Quantity",
"Quantity": 0,
"Percentage": 0
}
],
"LineComment": [],
"Tax": 0,
"supplierPersonalName": "abc"
}
]
}
}
],
"statusCode": "200",
"errorDetails": [],
"successDetails": [
{
"key": "93241"
}
]
}
Failure Scenario - Request
https://<Instance>/SmartInterfaceAPI/api/ServiceConfirmation/All
Failure Scenario – Response
{
"data": null,
"statusCode": "200",
"errorDetails": [],
"successDetails": []
}
Model |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
Yes |
ServiceConfirmationRequestHeader object |
Check data type ServiceConfirmationRequestHeader for details |
|
|
Yes |
ServiceConfirmationOrder object |
Check ServiceConfirmationOrder for details |
|
ServiceConfirmationRequestHeader |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
IsERS |
No |
Boolean |
|
|
WorkLocation |
No |
String |
|
|
ServiceEndDate |
Yes |
DateTime |
ServiceConfirmation completion date |
|
ServiceStartDate |
Yes |
DateTime |
ServiceConfirmation Start date |
|
FieldSupervisorID |
Yes |
String |
|
|
SubmittedOn |
No |
DateTime |
|
|
SubmittedBy |
No |
String |
|
|
ServiceConfirmationDate |
Yes |
DateTime |
Serviceconfirmation Creation Date |
|
OrderName |
No |
String |
Order Name for which SC is created |
|
OrderNumber |
Yes |
String |
Order Number for which SC is created |
|
Description |
No |
String |
|
|
No |
List of OrgEntity object |
Check OrgEntity for details |
|
|
SourceSystem |
No |
String |
SourceSystemName |
|
OriginatingSourceSystem |
No |
String |
OriginatingSourceSystemName |
|
Tax |
No |
Decimal |
|
|
CreatedBy |
No |
String |
|
|
ServiceConfirmationStatus |
No |
String |
Status of ServiceConfirmation |
|
LOB |
No |
String |
Line of Business |
|
serviceConfirmationApprover |
|
String |
Service Confirmation Approver |
|
ServiceConfirmationName |
No |
String |
|
|
partnerServiceConfirmationNumber |
Yes |
String |
|
|
clientPartnerCode |
No |
String |
|
|
No |
List of InterfaceComment object |
Check InterfaceComment for details |
|
|
Operation |
Yes |
String |
Operation of ServiceConfirmation i.e. new/update/Delete |
|
ServiceConfirmationNumber |
Yes |
String |
ServiceConfirmation Number |
|
Currency |
Yes |
String |
Currency |
|
TotalAmount |
Yes |
String |
|
|
HeaderEntity |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
EntityCode |
No |
String |
|
|
IsDefault |
No |
Boolean |
|
|
EntityType |
No |
String |
|
|
LOBEntityCode |
No |
String |
|
|
HeaderComments |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
CommentText |
No |
String |
|
|
AccessType |
No |
String |
|
|
No |
List of InterfaceCommentAttachment object |
Check InterfaceCommentAttachment for details |
|
CommentAttachment |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
FileName |
No |
String |
|
|
FileUri |
No |
String |
|
|
attachmentData |
|
string |
Data in attachment |
|
Extension |
|
string |
Extension |
|
contentTransferEncoding |
|
string |
Content Transfer Encoding |
|
ServiceConfirmationOrder |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
OrderID |
Yes |
String |
OrderId sor which SC is created |
|
Yes |
List of ServiceConfirmationItem object |
Check ServiceConfirmationItem for details |
|
ServiceConfirmationItem |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
LineComment |
No |
List of InterfaceComment object |
Check InterfaceComment for details |
|
No |
List of Accounting object |
Check Accounting for details |
|
|
ScParentLine |
Yes, if EnableGenericFlowForServiceConfirmation is true |
Int |
|
Lines without subline cannot have duplicate scParentline number |
SubLine |
Yes, if EnableGenericFlowForServiceConfirmation is true |
Int |
|
|
SupplierPartID |
No |
String |
|
|
LineNumber |
Yes |
Int |
Order Line number |
|
ManufacturerName |
No |
String |
|
|
ManufacturerPartID |
No |
String |
|
|
ConsumedDate |
Yes |
DateTime |
|
|
CategoryName |
Yes |
String |
|
|
ServiceEndDate |
Yes |
DateTime |
Service confirmation End date |
|
ServiceStartDate |
Yes |
DateTime |
Service confirmation Start date |
|
UnitPrice |
Yes |
Decimal |
Unit Price for the Line Item |
|
UnitOfMeasure |
Yes |
String |
Unit of Measure for the Line item |
|
No |
InterfaceShiptoLocation |
Check InterfaceShiptoLocation for details |
|
|
ContractNumber |
No |
String |
|
|
ItemExtendedType |
Yes, if EnableGenericFlowForServiceConfirmation is true |
String |
|
Below validation is only if setting (EnableGenericFlowForServiceConfirmation=true)
|
ItemType |
Yes |
String |
|
|
Quantity |
Yes |
Decimal |
|
|
Description |
No |
String |
|
|
ServiceConfirmationLineNumber |
Yes |
int |
|
|
AgreementID |
No |
String |
|
|
PoLineNumber |
No |
Int |
|
|
Tax |
No |
Decimal |
|
|
supplierPersonalName |
No |
String |
Check supplierPersonalName |
400-character length validation |
ItemSplit |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
No |
List of AccountingSegment object |
Check Accounting Segment for details |
|
|
Charge |
No |
Decimal |
|
|
SplitType |
No |
String |
|
|
Name |
No |
String |
|
|
Quantity |
No |
Decimal |
|
|
Percentage |
No |
Decimal |
|
|
ItemSplitEntities |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
Id |
No |
String |
|
|
Name |
No |
String |
|
|
Description |
No |
string |
|
|
ServiceLocation |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
ShiptoLocationName |
No |
String |
|
|
ShiptoLocationNumber |
No |
String |
|
|
No |
InterfaceAddress object |
|
|
|
TelephoneNumber |
No |
Int |
|
|
No |
List of PartnerWiseIdentificationDetail object |
|
|
Address |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
IsdCode |
No |
String |
|
|
PoBoxNumber |
No |
String |
|
|
County |
No |
String |
|
|
FaxNo |
No |
String |
|
|
MobileNo |
No |
String |
|
|
ExtenstionNo2 |
No |
String |
|
|
PhoneNo2 |
No |
String |
|
|
GeoCode |
No |
String |
|
|
ExtenstionNo1 |
No |
String |
|
|
No |
InterfaceCountryInfo object |
|
|
|
No |
InterfaceStateInfo object |
|
|
|
ZipCode |
No |
String |
|
|
City |
No |
String |
|
|
Addressline3 |
No |
String |
|
|
Addressline2 |
No |
String |
|
|
Addressline1 |
No |
String |
|
|
PhoneNo1 |
No |
String |
|
|
AreaCode |
No |
String |
|
|
CountryInfo |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
CountryCode |
No |
String |
|
|
CountryName |
No |
String |
|
|
StateInfo |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
StateAbbrevationCode |
No |
String |
|
|
StateName |
No |
String |
|
|
RegistrationDetails |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
CompanyIdentificationDisplayName |
No |
String |
|
|
CompanyIdentification |
No |
String |
|
|