This POST API can be used to capture new additions in partner location mapping details from ERP into GEP SMART, that can be used as reference in P2P transactions.
URL Format: https://<Instance>/SmartInterfaceAPI/api/Partner/LocationMapping
{
"locationsMapping": [
{
"partnerCode": "string",
"locations": [
{
"gepLocationCode": 0,
"locationCode": "string",
"locationName": "string",
"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": [
{
"userName": "string",
"gepContactCode": 0,
"contactCode": "string",
"partnerCode": "string",
"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": [
null
],
"isPrimary": true,
"isActive": true,
"isDeleted": true,
"userActivities": [
{
"activityName": "NONE"
}
],
"sourceSystemDetails": [
{
"name": "string",
"value": "string"
}
],
"cultureCode": "string",
"contactTrackingTypeName": [
"string"
]
}
],
"engagementModel": [
{
"entityCode": "string",
"entityType": "string",
"engagementType": [
"string"
],
"lobEntityCode": "string"
}
],
"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"
}
],
"paymentTerms": [
{
"paymentTermName": "string",
"isDefault": true,
"paymentTermCode": "string",
"orgEntities": [
{
"entityCode": "string",
"isDefault": true,
"entityType": "string",
"lobEntityCode": "string"
}
],
"lobEntityCode": "string"
}
]
}
]
}
]
}
{
"data": {},
"statusCode": "string",
"errorDetails": [
{
"key": "string",
"errors": [
{
"errorCode": "string",
"errorDescription": "string"
}
]
}
],
"successDetails": [
{
"key": "string"
}
]
}
Success Scenario - Request
Request below describes that this contains only the mandatory attributes:
{
"locationsMapping": [
{
"partnerCode": "PC-2014.000012",
"locations": [
{
"gepLocationCode": 0,
"locationCode": "LOCTest3",
"locationName": "LOCTest3",
"address": {
"addressLine1": "LOC12102019",
"addressLine2": "string2",
"addressLine3": "string3",
"city": "LOC12102019",
"stateCode": "MH",
"stateOther": "MH",
"countryCode": "US",
"zipCode": "23109",
"faxNo": "098-2310989",
"phoneNo": "231-908-9098",
"phoneOther": "231-908-9098",
"phoneExtension": "1233",
"phoneOtherExtension": "231-908-90",
"county": "",
"poBoxNumber": ""
},
"isDeleted": false,
"locationType": [
"OrderingLocation"
],
"PartnerContact": [
{
"ContactCode": "00020019311@Supplier.com",
"PartnerCode": "00020019311",
"Address": {
"AddressLine1": "-1_1",
"City": "-1_1",
"CountryCode": "NZ",
"StateOther": "ZZZ",
"ZipCode": "000001"
},
"FirstName": "FirstName1",
"LastName": "LastName1",
"EmailAddress": "sayanoly1@newworld-si.co.nz"
}
]
}
]
}
]
}
Success Scenario - Response
{
"data": null,
"statusCode": "200",
"errorDetails": [],
"successDetails": [
{
"key": "PC-2014.000012"
}
]
}
Error Scenario - Request
Request below describes that this has a missing value of Location Code which is mandatory attribute.
{
"locationsMapping": [
{
"partnerCode": "PC-2014.000012",
"locations": [
{
"gepLocationCode": 0,
"locationCode": "",
"locationName": "LOCTest3",
"address": {
"addressLine1": "LOC12102019",
"addressLine2": "string2",
"addressLine3": "string3",
"city": "LOC12102019",
"stateCode": "MH",
"stateOther": "MH",
"countryCode": "US",
"zipCode": "23109",
"faxNo": "098-2310989",
"phoneNo": "231-908-9098",
"phoneOther": "231-908-9098",
"phoneExtension": "1233",
"phoneOtherExtension": "231-908-90",
"county": "",
"poBoxNumber": ""
},
"isDeleted": false,
"locationType": [
"OrderingLocation"
],
"PartnerContact": [
{
"ContactCode": "00020019311@Supplier.com",
"PartnerCode": "00020019311",
"Address": {
"AddressLine1": "-1_1",
"City": "-1_1",
"CountryCode": "NZ",
"StateOther": "ZZZ",
"ZipCode": "000001"
},
"FirstName": "FirstName1",
"LastName": "LastName1",
"EmailAddress": "sayanoly1@newworld-si.co.nz"
}
]
}
]
}
]
}
Error Scenario – Response
{
"data": null,
"statusCode": "400",
"errorDetails": [
{
"key": "PC-2014.000012",
"errors": [
{
"errorCode": "MandatoryField",
"errorDescription": "LocationCode Is Mandatory"
}
]
}
],
"successDetails": []
}
Save Partner Location Mapping |
|||||
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
1 |
Yes |
List of PartnerLocationsMapping object |
Partner Locations Mapping |
|
LocationsMapping |
|||||
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
1.1 |
PartnerCode |
Yes |
String |
Partner Code of entity |
|
1.2 |
No |
List of Location object |
List of locations |
Location |
|||||
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
1.2.1 |
LocationCode |
Yes |
String(100) |
Location code of this location |
|
1.2.2 |
LocationName |
Yes |
String(100) |
Name of this location |
|
1.2.3 |
isDefault |
No |
Boolean |
Status of location if this location is default or not |
|
1.2.4 |
GEPLocationCode |
No |
Long |
GEP location code of the entity This field is only available on Outbound and not on Inbound |
|
1.2.5 |
No |
Address object |
Check Data Type Address for details |
||
1.2.6 |
IsDeleted |
No |
Boolean |
Visibility status of the entity on whether it should be visible on the application or not |
|
1.2.7 |
LocationType |
No |
List of LocationType Enum |
An Array of location types. The list of location types that are available to select are as follows; “None”, “Remit To Location”, “Ordering Location”, “Solicitation Location”, “Invoicing Location”, “Other” Note: The values in this field are case sensitive |
|
2.8 |
LocationTypes |
No |
List of string |
|
|
1.2.9 |
No |
List of PartnerContact object |
Check Data Type Partner Contact for details This field is only available on Outbound and not on Inbound |
||
1.2.10 |
No |
List of EngagementEntityDetail object |
Check Data Type Engagement Entity Detail for details |
||
1.2.11 |
No |
List of SourceSystemDetails object |
An array of strings that contain information on source systems of location data |
||
1.2.12 |
No |
List of OtherIdentificationType object |
Check Data type Other Identification Type for Details |
||
1.2.13 |
No |
List of LinkedLocationDetails object |
Check Data Type Linked Location Details for details |
||
1.2.14 |
BankingStatus |
No |
String |
Banking status |
|
1.2.15 |
PaymentMethod |
No |
String |
Method of payment |
|
1.2.16 |
ContactRole |
No |
List of string |
Any array of contact role |
|
1.2.17 |
No |
List ofPartnerBankingInformations object |
Check Data Type Partner Banking Information’s for details |
||
1.2.18 |
No |
List of PaymentTerms object |
Payment Terms |
Address |
|||||
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
1.2.5.1 |
AddressLine1 |
Yes |
String (500) |
Address line 1 of the entity |
|
1.2.5.2 |
StateCode |
Yes |
String (10) |
State code of the entity |
|
1.2.5.3 |
CountryCode |
Yes |
String (2) |
Country code of the entity |
|
1.2.5.4 |
ZipCode |
Yes |
String (10) |
Zip code of the entity |
|
1.2.5.5 |
AddressLine2 |
No |
String (100) |
Address line 2 of the entity |
|
1.2.5.6 |
AddressLine3 |
No |
String (100) |
Address line 3 of the entity |
|
1.2.5.7 |
City |
No |
String (50) |
City of the entity |
|
1.2.5.8 |
FaxNo |
No |
String (20) |
Fax number of the entity |
|
1.2.5.9 |
PhoneExtension |
No |
String (5) |
Phone extension of the entity |
|
1.2.5.10 |
PhoneNo |
No |
String (20) |
Phone number of the entity |
|
1.2.5.11 |
PhoneOther |
No |
String (20) |
Phone 2 of the entity |
|
1.2.5.12 |
PhoneOtherExtension |
No |
String (5) |
Phone 2’s extension of the entity |
|
1.2.5.13 |
StateOther |
No |
String (15) |
State name (in case of others) of the entity |
|
1.2.5.14 |
PoBoxNumber |
No |
String |
||
1.2.5.15 |
County |
No |
String (50) |
County of the address |
|
PartnerContact |
|||||
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
1.2.9.1 |
ContactCode |
Yes |
String(100) |
Contact code of the partner contact |
|
1.2.9.2 |
FirstName |
Yes |
String(50) |
First name of the partner contact |
|
1.2.9.3 |
EmailAddress |
Yes |
String(100) |
Email address of the partner contact |
|
1.2.9.4 |
UserName |
No |
String(100) |
Username of the partner contact |
|
1.2.9.5 |
GEPContactCode |
No |
Long |
GEP contact code of the partner contact This field is available only on Outbound and not on Inbound |
|
1.2.9.6 |
PartnerCode |
No |
String(100) |
Partner code of the partner to which this contact belongs |
|
1.2.9.7 |
No |
Address object |
|
||
1.2.9.8 |
LastName |
No |
String(50) |
Last name of the partner contact |
|
1.2.9.9 |
TimeZone |
No |
String(100) |
Partner code of the partner to which this contact belongs |
|
1.2.9.10 |
No |
List of Location object |
Check Data Type Location for details |
||
1.2.9.11 |
IsPrimary |
No |
Boolean |
Status of the partner contact if this contact is the primary contact or not |
|
1.2.9.12 |
IsActive |
No |
Boolean |
Status of the partner contact if active or not |
|
1.2.9.13 |
IsDeleted |
No |
Boolean |
Visibility status of the partner contact if visible on the application platform of not |
|
1.2.9.14 |
No |
List of Activity object |
Check Data Type Activity for details |
||
1.2.9.15 |
No |
List of SourceSystemDetails object |
An array of strings that contain information on source systems of contact data |
||
1.2.9.16 |
CultureCode |
No |
String |
Culture Code of partner |
|
1.2.9.17 |
ContactTrackingTypeName |
No |
List of String |
Contact Tracking Type Name |
UserActivities |
|||||
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
1.2.9.14.1 |
ActivityName |
No |
Activities |
One of the following values will be provided in this field; “NONE”, “ADMINISTRATION”, “HOME”, “VIEW_GEPICENTER etc. |
SourceSystemDetails |
|||||
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
1.2.9.15.1 |
Name |
Yes |
String |
Source system name |
|
1.2.9.15.2 |
Value |
Yes |
String |
Source system value |
|
EngagementModel |
|||||
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
1.2.10.1 |
EntityCode |
No |
String |
Entity Code of entity |
|
1.2.10.2 |
EntityType |
No |
String |
Entity type of entity |
|
1.2.10.3 |
EngagementType |
No |
List of String |
Engagement Type of entity |
|
1.2.10.4 |
LobEntityCode |
No |
String |
Lob Entity Code of entity |
OtherIdentificationTypes |
|||||
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
1.2.12.1 |
IdentificationNumber |
No |
String(30) |
Identification number of the entity |
|
1.2.12.2 |
IdentificationType |
No |
IdentificationType Enum |
One of the following values will be provided in this field; “NONE”, “US_FEDERAL_TAX_ID_EIN_NUMBER”, “SOCIAL_SECURITY_NUMBER”, “VAT_REGISTRATION_NUMBER”, “GST_QST_HST”, “LEI”, “SIC_CODE”, “NACIS_CODE”, “TIN_NUMBER”. Note: The values in this field are case sensitive |
|
LinkedLocationDetails |
|||||
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
1.2.13.1 |
LinkedGEPLocationID |
No |
Long |
GEP Linked Location Id |
|
1.2.13.2 |
No |
List of SourceSystemDetails object |
Check data type SourceSystemDetails for details |
||
1.2.13.3 |
GEPLocationID |
No |
Long |
GEP Location Id |
|
1.2.13.4 |
isDeleted |
No |
Boolean |
Visibility status of the entity on whether it should be visible on the application or not |
|
1.2.13.5 |
LocationCode |
No |
String |
Location code of linked location |
BankingInfo |
|||||
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
1.2.17.1 |
BankName |
No |
String |
Bank Name of the entity |
|
1.2.17.2 |
BeneficiaryName |
No |
String |
Beneficiary Name of the entity |
|
1.2.17.3 |
BankBranch |
No |
String |
Bank Branch of the entity |
|
1.2.17.4 |
Country |
No |
String |
Country name of the entity |
|
1.2.17.5 |
BankAccountNumber |
No |
String |
Bank Account Number of the entity |
|
1.2.17.6 |
Swift_BIC |
No |
String |
Swift BIC |
|
1.2.17.7 |
IBAN |
No |
String |
IBAN |
|
1.2.17.8 |
BankKey_ABA |
No |
String |
Bank key ABA |
|
1.2.17.9 |
ChipUid |
No |
String |
Chip uid |
|
1.2.17.10 |
AccountTypeName |
No |
String |
Account Type Name of entity |
|
1.2.17.11 |
PaymentMethodName |
No |
String |
Payment Method Name |
|
1.2.17.12 |
IsDeleted |
No |
Boolean |
Visibility status of the entity on whether it should be visible on the application or not |
|
1.2.17.13 |
FIKCode |
No |
String |
||
1.2.17.14 |
FactoringCompanyName |
No |
String |
GEP Linked Location Id |
|
1.2.17.15 |
FactoringCompanyCVR |
No |
String |
Factoring Company CVR |
|
1.2.17.16 |
Comments |
No |
String |
Comments |
PaymentTerms |
|||||
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
1.2.18.1 |
PaymentTermName |
No |
String |
The name of the payment term |
|
1.2.18.2 |
IsDefault |
No |
Boolean |
Status of the payment term if this payment term is default or not |
|
1.2.18.3 |
PaymentTermCode |
No |
String |
The code of the payment term |
|
1.2.18.4 |
No |
List of OrgEntity object |
Check data type OrgEntity for details |
|
|
1.2.18.5 |
LobEntityCode |
No |
String |
LobEntityCode of the payment term |
|
OrgEntities |
|||||
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
1.2.18.4.1 |
EntityCode |
No |
String |
Entity Code of entity |
|
1.2.18.4.2 |
IsDefault |
No |
Boolean |
Status of the entity if this is default or not |
|
1.2.18.4.3 |
EntityType |
No |
String |
Entity Type of entity |
|
1.2.18.4.4 |
LOBEntityCode |
No |
String |
LOB Entity Code of entity |
|