DownloadThis GET API can be used to retrieve partner contacts by contact code details in GEP SMART to post them into ERP.
URL Format: https://<Instance>/SmartInterfaceAPI/api/Partner/PartnerContactByContactCode
https:///SmartInterfaceAPI/api/Partner/PartnerContactByContactCode?ClientPartnerCode= PC2014.0000054&ClientContactCode=1895730040000001
{
"data": [
{
"userName": "string",
"gepContactCode": 0,
"contactCode": "string",
"partnerCode": "string",
"isUpdated": true,
"address": {
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"city": "string",
"stateCode": "string",
"stateOther": "string",
"countryCode": "string",
"zipCode": "string",
"faxNo": "string",
"phoneNo": "string",
"phoneOther": "string",
"phoneExtension": "string",
"phoneOtherExtension": "string",
"county": "string",
"poBoxNumber": "string"
},
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"timeZone": "string",
"locations": [
{
"gepLocationCode": 0,
"locationCode": "string",
"locationName": "string",
"isUpdated": true,
"address": {
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"city": "string",
"stateCode": "string",
"stateOther": "string",
"countryCode": "string",
"zipCode": "string",
"faxNo": "string",
"phoneNo": "string",
"phoneOther": "string",
"phoneExtension": "string",
"phoneOtherExtension": "string",
"county": "string",
"poBoxNumber": "string"
},
"isDeleted": true,
"locationType": [
"None"
],
"locationTypes": [
"string"
],
"partnerContact": [
null
],
"engagementModel": [
{
"entityCode": "string",
"entityType": "string",
"engagementType": [
"string"
],
"lobEntityCode": "string",
"locationType": "string",
"status": "string",
"isDelete": true
}
],
"sourceSystemDetails": [
{
"name": "string",
"value": "string"
}
],
"otherIdentificationTypes": [
{
"identificationType": "NONE",
"identificationNumber": "string"
}
],
"linkedLocationDetails": [
{
"linkedGEPLocationID": 0,
"sourceSystemDetails": [
{
"name": "string",
"value": "string"
}
],
"gepLocationID": 0,
"locationCode": "string",
"isDeleted": true
}
],
"bankingStatus": "string",
"paymentMethod": "string",
"contactRole": [
"string"
],
"isDefault": true,
"bankingInfo": [
{
"bankName": "string",
"beneficiaryName": "string",
"bankBranch": "string",
"country": "string",
"bankAccountNumber": "string",
"swift_BIC": "string",
"iban": "string",
"bankKey_ABA": "string",
"chipUid": "string",
"accountTypeName": "string",
"paymentMethodName": "string",
"isDeleted": true,
"fikCode": "string",
"factoringCompanyName": "string",
"factoringCompanyCVR": "string",
"comments": "string"
}
],
"gepPartnerCode": 0,
"partnerCode": "string",
"paymentTerms": [
{
"paymentTermName": "string",
"isDefault": true,
"paymentTermCode": "string",
"orgEntities": [
{
"entityCode": "string",
"isDefault": true,
"entityType": "string",
"lobEntityCode": "string"
}
],
"lobEntityCode": "string",
"locationType": "string",
"status": "string",
"isDelete": true
}
],
"partnerLocationCurrencyList": [
"string"
],
"shippingDetails": [
{
"lobEntityCode": "string",
"fobCode": "string",
"fobDesciption": "string",
"locationCode": "string",
"locationDescription": "string",
"orgEntities": [
{
"entityCode": "string",
"isDefault": true,
"entityType": "string",
"lobEntityCode": "string"
}
]
}
],
"contactRoleMapping": [
{
"contactCode": "string",
"contactEmailAddress": "string",
"contactRole": [
"string"
]
}
}
],
"isPrimary": true,
"isActive": true,
"isDeleted": true,
"userActivities": [
{
"activityName": "NONE"
}
],
"sourceSystemDetails": [
{
"name": "string",
"value": "string"
}
],
"cultureCode": "string",
"contactTrackingTypeName": [
"string"
],
"defaultRole": "string",
"designation": "string",
"categories": [
{
"pasCode": 0,
"isDefault": true,
"clientPasCode": "string",
"isDeleted": true
}
],
"regions": [
"string"
]
}
],
"statusCode": " String ",
"errorDetails": [
{
"key": "string",
"errors": [
{
"errorCode": "string",
"errorDescription": "string"
}
]
}
],
"successDetails": [
{
"key": "String"
}
]
}
Success Scenario - Request
https://<Instance>/SmartInterfaceAPI/api/Partner/PartnerContactByContactCode?ClientPartnerCode= PC-2014.0000054&ClientContactCode=1895730040000001
Success Scenario - Response
{
"data": {
"userName": null,
"gepContactCode": 0,
"contactCode": "CC-2019.012735",
"partnerCode": null,
"address": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"city": "",
"stateCode": null,
"stateOther": null,
"countryCode": null,
"zipCode": "",
"faxNo": "",
"phoneNo": "",
"phoneOther": "",
"phoneExtension": "",
"phoneOtherExtension": "",
"county": "",
"poBoxNumber": ""
},
"firstName": "tyry",
"lastName": "rytr",
"emailAddress": "ac@gemo.com",
"timeZone": "Mountain Standard Time",
"locations": [],
"isPrimary": true,
"isActive": false,
"isDeleted": false,
"userActivities": [],
"cultureCode": "en-US"
},
"statusCode": "200",
"errorDetails": [],
"successDetails": [
{
"key": "PC-2019.000623"
}
]
}
|
Partner Contacts by Contact Code |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1 |
List of partnercontact object |
||||
|
2 |
StatusCode |
String(100) |
|||
|
3 |
List of Errordetails object |
||||
|
4 |
List of Successdetails object |
||||
|
Data |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.1 |
List of SourceSystemDetails object |
Source details of system |
|||
|
1.2 |
List of Activity object |
Activities of user |
|||
|
1.3 |
IsDeleted |
Boolean |
Is deleted |
||
|
1.4 |
IsActive |
Boolean |
Is active |
||
|
1.5 |
IsPrimary |
|
Boolean |
Is primary |
|
|
1.6 |
|
List of Location object |
List locations |
|
|
|
1.7 |
TimeZone |
|
String |
Time zone |
|
|
1.8 |
EmailAddress |
|
String |
Email address |
|
|
1.9 |
LastName |
|
String |
Last name |
|
|
1.10 |
FirstName |
|
String |
First name |
|
|
1.11 |
|
Address object |
|||
|
1.12 |
PartnerCode |
|
String |
Code of partner |
|
|
1.13 |
ContactCode |
|
String |
Code of contact |
|
|
1.14 |
GEPContactCode |
|
Int |
GEP contact code |
|
|
1.15 |
UserName |
|
String |
User name |
|
|
1.16 |
CultureCode |
|
String |
Code of culture |
|
|
1.17 |
ContactTrackingTypeName |
|
List of String |
List of contract tracking type names |
|
|
Sourcesystemdetails |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.1.1 |
Name |
String |
Name of source system details |
||
|
1.1.2 |
Value |
String |
Value of source system details |
||
|
UserActivities |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.2.1 |
ActivityName |
Long |
ENUM |
||
|
Locations |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.6.1 |
ContactRole |
List of String |
Role of contact |
||
|
1.6.2 |
PaymentMethod |
String |
Method of payment |
||
|
1.6.3 |
BankingStatus |
String |
Banking status |
||
|
1.6.4 |
List of LinkedLocationDetails object |
List of linked location details |
|||
|
1.6.5 |
List of OtherIdentificationType object |
List of other identification types |
|||
|
1.6.6 |
List of SourceSystemDetails object |
||||
|
1.6.7 |
List of EngagementEntityDetail object |
List of engagement model |
|||
|
1.6.8 |
List of PartnerContact object |
List partner contact |
|||
|
1.6.9 |
LocationTypes |
List of String |
|||
|
1.6.10 |
LocationType |
LocationType Enum |
Type of locations |
||
|
1.6.11 |
IsDeleted |
Boolean |
Is deleted |
||
|
1.6.12 |
Address object |
||||
|
1.6.13 |
LocationName |
String |
Name of location |
||
|
1.6.14 |
LocationCode |
String |
Code of location |
||
|
1.6.15 |
GEPLocationCode |
Long |
GEP location code |
||
|
1.6.17 |
IsDefault |
Boolean |
Is default |
||
|
1.6.18 |
List of PartnerBankingInformations object |
List of banking info |
|||
|
1.6.19 |
List of PaymentTerm object |
Payment Term |
|||
|
ShippingDetails |
List of ShippingDetails object | Check Data Type ShippingDetails for details | |||
|
ContactRoleMapping |
List of Contact role mapping object | Check contact role mapping details | |||
|
defaultRole |
String | Default role field | |||
|
designation |
String | Designation field | |||
| List of categories object | Check categories details | ||||
|
regions |
List of regions object | Check regions details | |||
|
LinkedLocationDetails |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.6.4.1 |
LinkedGEPLocationID |
Long |
Linked GEP location id |
||
|
1.6.4.2 |
SourceSystemDetails |
List of SourceSystemDetails object |
|||
|
1.6.4.3 |
GEPLocationID |
Long |
GEP location id |
||
|
1.6.4.4 |
LocationCode |
String |
Location code |
||
|
1.6.4.5 |
isDeleted |
Boolean |
Is deleted |
||
|
OtherIdentificationTypes |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.6.5.1 |
IdentificationType |
IdentificationType Enum |
Identification Type |
|
|
|
1.6.5.2 |
IdentificationNumber |
String |
IdentificationNumber |
|
|
|
EngagementModel |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.6.7.1 |
EntityCode |
String |
Entity code |
|
|
|
1.6.7.2 |
EntityType |
String |
Entity Type |
|
|
|
1.6.7.3 |
EngagementType |
List of String |
Engagement Type |
|
|
|
1.6.7.4 |
LobEntityCode |
String |
Lob(line of business) Entity Code |
|
|
|
LocationType |
String | EntityCode location type | |||
|
Status |
String | Entity Code Status | |||
|
isDelete |
bool | Visibility of entity code | |||
|
PartnerContact |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.6.8.1 |
List of SourceSystemDetails object |
||||
|
1.6.8.2 |
List of Activity object |
||||
|
1.6.8.3 |
IsDeleted |
Boolean |
UserActivates |
||
|
1.6.8.4 |
IsActive |
Boolean |
Is deleted |
||
|
1.6.8.5 |
IsPrimary |
Boolean |
Is primary |
||
|
1.6.8.6 |
List of Location object |
||||
|
1.6.8.7 |
TimeZone |
String |
Time zone |
||
|
1.6.8.8 |
EmailAddress |
String |
Email address |
||
|
1.6.8.9 |
LastName |
String |
Last name |
||
|
1.6.8.10 |
FirstName |
String |
First name |
||
|
1.6.8.11 |
Address Object |
Address |
|||
|
1.6.8.12 |
PartnerCode |
String |
Partner code |
||
|
1.6.8.13 |
ContactCode |
String |
Contact code |
||
|
1.6.8.14 |
GEPContactCode |
Long |
GEP contact code |
||
|
1.6.8.15 |
UserName |
String |
User name |
||
|
1.6.8.16 |
CultureCode |
String |
Culture code |
||
|
1.6.8.17 |
ContactTrackingTypeName |
List of String |
List of Contact Tracking Type Names |
||
|
Address |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.6.8.11.1 |
AddressLine1 |
String (500) |
Address Line 1 |
|
|
|
1.6.8.11.2 |
AddressLine2 |
String (500) |
Address Line 2 |
|
|
|
1.6.8.11.3 |
AddressLine3 |
String (100) |
Address Line 3 |
|
|
|
1.6.8.11.4 |
City |
String (50) |
city |
|
|
|
1.6.8.11.5 |
StateCode |
String (10) |
State code |
|
|
|
1.6.8.11.6 |
StateOther |
String (50) |
State other |
|
|
|
1.6.8.11.7 |
CountryCode |
String (2) |
Country code |
|
|
|
1.6.8.11.8 |
ZipCode |
String (10) |
Zip code |
|
|
|
1.6.8.11.9 |
FaxNo |
String (20) |
Fax no |
|
|
|
1.6.8.11.10 |
PhoneNo |
String (50) |
Phone no |
|
|
|
1.6.8.11.11 |
PhoneOther |
String (20) |
Other phone no |
|
|
|
1.6.8.11.12 |
PhoneExtension |
String (10) |
Extension of phone |
|
|
|
1.6.8.11.13 |
PhoneOtherExtension |
String (10) |
Extension of other phone no |
|
|
|
1.6.8.11.14 |
PoBoxNumber |
String |
Post box number |
|
|
|
1.6.8.11.15 |
County |
String (50) |
Country |
|
|
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.6.18.1 |
FactoringCompanyName |
String |
Factoring Company Name |
|
|
|
1.6.18.2 |
FIKCode |
String |
FIK Code |
|
|
|
1.6.18.3 |
IsDeleted |
Boolean |
Is Deleted |
|
|
|
1.6.18.4 |
PaymentMethodName |
String |
Payment Method Name |
|
|
|
1.6.18.5 |
AccountTypeName |
String |
Account Type Name |
|
|
|
1.6.18.6 |
ChipUid |
String |
Uid of chip |
|
|
|
1.6.18.7 |
FactoringCompanyCVR |
String |
Factoring Company CVR |
|
|
|
1.6.18.8 |
BankKeyABA |
String |
Bank Key ABA |
|
|
|
1.6.18.9 |
Swift_BIC |
String |
Swift BIC |
|
|
|
1.6.18.10 |
BankAccountNumber |
String |
Bank Account Number |
|
|
|
1.6.18.11 |
Country |
String |
Country |
|
|
|
1.6.18.12 |
BankBranch |
String |
Branch of bank |
|
|
|
1.6.18.13 |
BeneficiaryName |
String |
Name of Beneficiary |
|
|
|
1.6.18.14 |
BankName |
String |
Name of bank |
|
|
|
1.6.18.15 |
IBAN |
String |
IBAN |
|
|
|
1.6.18.16 |
Comments |
String |
Comments |
|
|
|
PaymentTerm |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.6.19.1 |
PaymentTermName |
|
String |
Payment Term Name |
|
|
1.6.19.2 |
IsDefault |
|
Boolean |
Is Default |
|
|
1.6.19.3 |
PaymentTermCode |
|
String |
Payment Term Code |
|
|
1.6.19.4 |
List of OrgEntities object |
Organization Entities |
|||
|
OrgEntity |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.6.19.4.1 |
EntityCode |
|
String |
Entity Code of entity |
Invalid Entity Code |
|
1.6.19.4.2 |
IsDefault |
|
Boolean |
Status of the entity if this is default or not |
|
|
1.6.19.4.3 |
EntityType |
|
String |
Entity Type of entity |
|
|
1.6.19.4.4 |
LOBEntityCode |
|
String |
LOB Entity Code of entity |
|
|
ErrorDetails |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
3.1 |
Key |
String |
Key of error |
||
|
3.2 |
List of Errors object |
List of errors |
|||
|
Errors |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
3.2.1 |
ErrorCode |
String |
Code of error |
||
|
3.2.2 |
ErrorDescription |
String |
Description of error |
||
|
SuccessDetails |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
4.1 |
Key |
String(100) |
Key of success |
||
|
ShippingDetails |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
4.1 |
lobEntityCode |
String |
lobEntityCode string field |
||
|
fobCode |
String | lobEntityCode string field | |||
|
fobDesciption |
String | fobDesciption is string field | |||
|
locationCode |
String | locationCode is string field | |||
|
locationDescription |
String | locationDescription is string field | |||
|
orgEntities |
List of OrgEntities object | Organization Entities | |||
|
orgEntities |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
4.1 |
isDefault |
Boolean |
Is Default |
||
|
entityType |
String | entityType is a string field | |||
|
lobEntityCode |
String | lobEntityCode is a string field | |||