DownloadThis POST API can be used to capture new additions in Partner Details from ERP into GEP SMART, that can be used as reference in P2P transactions.
URL Format: https://<Instance>/SmartBulkInterfaceAPI/api/Partner/PartnerDetails
[
{
"gepPartnerCode": 0,
"partnerCode": "string",
"legalCompanyName": "string",
"dunAndBradNumber": "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"
},
"companyIdentification": "string",
"yearOfEstablishment": 0,
"parentCompanyName": "string",
"companyWebsite": "string",
"isActive": true,
"isDeleted": true,
"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": [
{
"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": [
null
],
"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"
}
]
}
],
"isPrimary": true,
"isActive": true,
"isDeleted": true,
"userActivities": [
{
"activityName": "NONE"
}
],
"sourceSystemDetails": [
{
"name": "String",
"value": "String"
}
],
"cultureCode": "string",
"contactTrackingTypeName": [
"string"
]
}
],
"partnerLocations": [
{
"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": [
null
],
"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"
}
]
}
],
"otherIdentificationTypes": [
{
"identificationType": "NONE",
"identificationNumber": "string"
}
],
"doingBusinessAs": "string",
"businessCriticality": "None",
"relationshipType": "None",
"goodsAndServices": [
0
],
"categories": [
{
"pasCode": 0,
"isDefault": true,
"clientPasCode": "string",
"isDeleted": true
}
],
"regions": [
"string"
],
"partnerManagers": [
"string"
],
"businessUnits": [
"string"
],
"businessTypes": "None",
"supportsPCARD": true,
"currenciesSupported": [
"string"
],
"partnerStatus": "string",
"diversityDetails": [
{
"diversityName": "string",
"diversityDescription": "string",
"certificateDetails": {
"certificateName": "string",
"certificateNumber": "string",
"certificateType": "None",
"issuingAuthority": "string",
"effectiveDate": " String ",
"expiryDate": " String ",
"isDeleted": true,
"typeOfCertificate": "string",
"fileDetail": [
{
"fileName": "string",
"fileData": "string",
"fileExtn": "string",
"isdeleted": true,
"contentType": "string",
"attachmentID": 0,
"certificateID": 0
}
]
}
}
],
"certifications": [
{
"certificateName": "string",
"certificateNumber": "string",
"certificateType": "None",
"issuingAuthority": "string",
"effectiveDate": " String ",
"expiryDate": " String ",
"isDeleted": true,
"typeOfCertificate": "string",
"fileDetail": [
{
"fileName": "string",
"fileData": "string",
"fileExtn": "string",
"isdeleted": true,
"contentType": "string",
"attachmentID": 0,
"certificateID": 0
}
]
}
],
"additionalInformation": [
{
"questionId": 0,
"questionText": "string",
"questionsResponseList": [
{
"responseValue": "string",
"childQuestionList": [
null
],
"columnText": "string",
"rowId": 0
}
],
"isDeleted": true
}
],
"paymentTerms": [
{
"paymentTermName": "string",
"isDefault": true,
"paymentTermCode": "string",
"orgEntities": [
{
"entityCode": "String",
"isDefault": true,
"entityType": "String",
"lobEntityCode": "String"
}
],
"lobEntityCode": "string"
}
],
"blockingReason": [
"string"
],
"autoAcknowledgeOrder": "string",
"sourceType": "string",
"transactionTypes": [
{
"transactionTypeName": "string",
"transactionMethod": "string",
"clientPartnerCode": "string"
}
],
"matchType": "string",
"normalizedName": "string",
"sourceSystemDetails": [
{
"name": " String ",
"value": " String "
}
],
"engagementType": [
"string"
],
"isAllLocationORGMapped": true,
"isPreferredSupplier": true,
"businessType": "string",
"languagesSupported": [
{
"languageCode": "string",
"languageDescription": "string"
}
],
"shippingDetails": [
{
"lobEntityCode": "string",
"fobCode": "string",
"fobDescription": "string",
"locationCode": "String",
"locationDescription": "string",
"orgEntities": [
{
"entityCode": "String",
"isDefault": true,
"entityType": "String",
"lobEntityCode": "String"
}
]
}
],
"orgEntities": [
{
"entityCode": " String ",
"isDefault": true,
"entityType": " String ",
"lobEntityCode": " String "
}
],
"currencyOrgMapping": [
{
"currencyCode": "string",
"orgEntities": [
{
"entityCode": " String ",
"isDefault": true,
"entityType": " String ",
"lobEntityCode": "String"
}
],
"lobEntityCode": "string"
}
],
"sourceSystemName": "string",
"dateModified": "String",
"paymentType": "string",
"isAllowCreateASN": true,
"averageProfit": 0,
"totalEmployees": 0,
"partnerRiskTypeName": "string",
"supplierApprovers": [
"string"
],
"formerlyKnownAs": [
{
"sequenceNumber": 0,
"name": "string",
"modifiedDate": "String",
"isDeleted": true
}
],
"businessCriticalityName": "string",
"partnerStatusHistory": "string",
"partnerRelationshipTypeName": "string",
"parentCompanyIdentificationType": "string",
"parentCompanyIdentificationValue": "string"
}
]
{
"statusCode": 202,
"url": "String",
"batchID": "String",
"interval": 0,
"interval Type": "Seconds",
"receivedCount": 0
}
Success Scenario - Request
Request below describes that this contains only the mandatory attributes:
[
{
"PartnerCode": "9bc94945-d66f-42a6-84e3-9e6b0f226c5b",
"LegalCompanyName": "LegalCompanyName1223333444555",
"Address": {
"AddressLine1": "REMARKABLES PARK",
"City": "QUEENSTOWN",
"CountryCode": "NZ",
"FaxNo": "34423067",
"PhoneNo": "34423045",
"StateOther": "ZZ",
"ZipCode": "00000"
},
"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"
}
],
"PartnerLocations": [
{
"LocationCode": "0002001931_1-000200193111",
"LocationName": "ayanoly WORLD WAKATIPU1",
"Address": {
"AddressLine1": "REMARKABLES PARK",
"City": "QUEENSTOWN",
"CountryCode": "NZ",
"FaxNo": "34423067",
"PhoneNo": "34423045",
"StateOther": "ZZ",
"ZipCode": "00000"
},
"IsDeleted": false,
"LocationType": [
"OrderingLocation",
"RemitToLocation"
],
"LocationTypes": null,
"PartnerContact": null,
"BankingStatus": "BankingStatus1",
"PaymentMethod": "PaymentMethod1"
}
],
"DoingBusinessAs": "DoingBusinessAs1",
"PartnerManagers": null,
"BusinessUnits": [
"KENZ"
],
"CurrenciesSupported": [
"CAD"
],
"PartnerStatus": "Approved",
"PaymentTerms": [
{
"PaymentTermCode": "NT30",
"LOBEntityCode": "KAP-SAP"
}
],
"SourceSystemDetails": [
{
"Name": "KAP-SAP",
"Value": "0002001931_1"
}
]
}
]
Success Scenario - Response
{
"statusCode": 202,
"url": "https://<Instance>/SmartBulkInterfaceAPI/api/BulkResult/GetBulkResult?batchId=ac3e2c55f59c4394b2ae2f3840b2921a",
"batchID": "ac3e2c55f59c4394b2ae2f3840b2921a",
"interval": 60,
"interval Type": "Seconds",
"receivedCount": 10
}
Error Scenario - Request
Request below describes that a missing value of the Authorization Header which is mandatory: (401 – Unauthorized)
Error Scenario - Response
Access to interface BulkAPI is denied, Authorization Header is missing.
|
Partner |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1 |
PartnerCode |
Yes |
String(100) |
Note: Client Partner Code must be unique from the <CLIENT NAME> systems, so if there are duplicates within the service layer, the SSID will have to be appended to the Client Partner Code, and the resulting value will be ClientPartnerCode-SSID |
|
|
2 |
LegalCompanyName |
Yes |
String(100) |
Legal company name of the partner Note: LegalCompanyName will also have the SSID appended due to name search. Example: “Grainger | LL012”, “Grainger | JD001”, “Grainger | CP001” |
|
|
3 |
Yes |
List of PartnerContact object |
An array of partner contacts |
||
|
4 |
AutoAcknowledgeOrder |
Yes |
String |
Auto Acknowledge Order of entity |
|
|
5 |
GEPPartnerCode |
No |
Long |
Unique ID for this Partner in GEP systems This field is available only on Outbound not on Inbound |
|
|
6 |
DunAndBradNumber |
No |
String(20) |
Dun & Brad number of the partner |
|
|
7 |
No |
Address object |
Address of partner’s head quarters |
|
|
|
8 |
CompanyIdentification |
No |
String(30) |
A string used to identify the partner |
|
|
9 |
YearOfEstablishment |
No |
Int |
The year of establishment of the partner |
|
|
10 |
ParentCompanyName |
No |
String(100) |
Parent company of the partner if any |
|
|
11 |
CompanyWebsite |
No |
String(50) |
Partner’s website |
|
|
12 |
IsActive |
No |
Boolean |
Status of the partner if they are active or not |
|
|
13 |
IsDeleted |
No |
Boolean |
Status of the partner if they are to be visible or not, on the application |
|
|
14 |
No |
List of Location object |
An array of locations where the partner operates |
|
|
|
15 |
No |
List of OtherIdentificationType object |
Identification attribute to uniquely identify partner |
|
|
|
16 |
DoingBusinessAs |
No |
String |
Name with which the partner conducts the business |
|
|
17 |
PartnerRelationshipTypeName |
No |
String |
Name of Partner Relationship Type |
|
|
18 |
ParentCompanyIdentificationType |
No |
String |
Type of Parent Company Identification |
|
|
19 |
GoodsAndServices |
No |
List of long |
An array of categories in which the partner supplies goods or services |
|
|
20 |
No |
List of PAS object |
Check data type PAS for details
|
|
|
|
21 |
Regions |
No |
List of string |
An array of regions where the partner operates |
|
|
22 |
PartnerManagers |
No |
List of string |
An array of partner managers |
|
|
23 |
BusinessUnits |
No |
List of string |
An array of business units to which the partner is associated |
|
|
24 |
ParentCompanyIdentificationValue |
No |
String |
Value of Parent Company Identification |
|
|
25 |
SupportsPCARD |
No |
Boolean |
Boolean value whether partner supports PCARD or not |
|
|
26 |
CurrenciesSupported |
No |
List of string |
An array of currencies that are supported by the partner |
|
|
27 |
PartnerStatus |
No |
String |
Status of the partner on GEP SMART platform |
|
|
28 |
No |
List of DiversityDetails object |
An array of diversity details that are applicable to the partner |
|
|
|
29 |
No |
List of Certificate object |
An array of certificates that this partner has obtained This field is available only on outbound not on inbound |
|
|
|
30 |
No |
List of Question object |
An array of questions and their responses, that are available in the partner profile This field is available only on outbound not on inbound Check data type Question for details |
|
|
|
31 |
No |
List of PaymentTerm object |
An array of payment terms This field is available only on outbound not on inbound |
|
|
|
32 |
BlockingReason |
No |
List of string |
An array of strings which denote reasons for blocking this partner This field is available only on outbound not on inbound |
|
|
33 |
SourceType |
No |
String |
Source Type of entity |
|
|
34 |
No |
List of Transationtype object |
Check data type Transationtype for details
|
|
|
|
35 |
MatchType |
No |
String |
Match Type of entity |
|
|
36 |
NormalizedName |
No |
String(256) |
Normalized name of the partner |
|
|
37 |
No |
List of SourceSystemDetails object |
An array of strings that contain information on source systems of partner data |
|
|
|
38 |
EngagementType |
No |
List of string |
Engagement Type of entity |
|
|
39 |
IsAllLocationORGMapped |
No |
Boolean |
|
|
|
40 |
IsPreferredSupplier |
No |
Boolean |
|
|
|
41 |
No |
List of Language object |
Check data type Language for details
|
|
|
|
42 |
No |
List of ShippingDetails object |
Check data type ShippingDetails for details
|
|
|
|
43 |
No |
List of OrgEntity object |
Check data type OrgEntity for details |
|
|
|
44 |
No |
List of Currency object |
Check data type Currency for details
|
|
|
|
45 |
SourceSystemName |
No |
String |
Source System Name of entity |
|
|
46 |
DateModified |
No |
DateTime |
Date Modified for partner |
|
|
47 |
PaymentType |
No |
String |
Payment Type of entity |
|
|
48 |
IsAllowCreateASN |
No |
Boolean |
|
|
|
49 |
AverageProfit |
No |
Double |
Average Profit |
|
|
50 |
TotalEmployees |
No |
Long |
Total Employees of partner |
|
|
51 |
PartnerRiskTypeName |
No |
String |
Name of Partner Risk Type |
|
|
52 |
SupplierApprovers |
No |
List of String |
Supplier Approvers |
|
|
53 |
No |
List of FormerlyKnownAs object |
Check data type FormerlyKnownAs for details
|
|
|
|
54 |
BusinessCriticalityName |
No |
String |
|
|
|
55 |
PartnerStatusHistory |
No |
String |
Partner Status History |
|
|
Address |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
7.1 |
AddressLine1 |
Yes |
String (500) |
Address line 1 of the entity |
|
|
7.2 |
CountryCode |
Yes |
String (2) |
Country code of the entity |
|
|
7.3 |
StateCode |
Yes |
String (10) |
State code of the entity |
|
|
7.4 |
ZipCode |
Yes |
String (10) |
Zip code of the entity |
|
|
7.5 |
AddressLine2 |
No |
String |
Address line 2 of the entity |
|
|
7.6 |
AddressLine3 |
No |
String (100) |
Address line 3 of the entity |
|
|
7.7 |
City |
No |
String (50) |
City of the entity |
|
|
7.8 |
FaxNo |
No |
String (20) |
Fax number of the entity |
|
|
7.9 |
PhoneExtension |
No |
String (10) |
Phone extension of the entity |
|
|
7.10 |
PhoneNo |
No |
String (50) |
Phone number of the entity |
|
|
7.11 |
PhoneOther |
No |
String (20) |
Phone 2 of the entity |
|
|
7.12 |
PhoneOtherExtension |
No |
String (10) |
Phone 2’s extension of the entity |
|
|
7.13 |
StateOther |
No |
String |
State name (in case of others) of the entity |
|
|
7.14 |
PoBoxNumber |
No |
String |
|
|
|
7.15 |
County |
No |
String (50) |
County of the address |
|
|
PartnerContact |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
3.1 |
ContactCode |
Yes |
String(100) |
Contact ode of the partner contact |
|
|
3.2 |
FirstName |
Yes |
String(50) |
First name of the partner contact |
|
|
3.3 |
EmailAddress |
Yes |
String(100) |
Email address of the partner contact |
|
|
3.4 |
UserName |
No |
String(100) |
Username of the partner contact |
|
|
3.5 |
GEPContactCode |
No |
Long |
GEP contact code of the partner contact This field is available only on outbound and not on inbound |
|
|
3.6 |
PartnerCode |
No |
String(100) |
Partner code of the partner to which this contact belongs to |
|
|
3.7 |
No |
Address object |
Check data type Address for details |
|
|
|
3.8 |
LastName |
No |
String |
Last name of the partner contact |
|
|
3.9 |
TimeZone |
No |
String(100) |
Partner code of the partner to which this contact belongs to |
|
|
3.10 |
No |
List of Location object |
Check data type Location for details |
||
|
3.11 |
IsPrimary |
No |
Boolean |
Status of the partner contact if this contact is the primary contact or not |
|
|
3.12 |
IsActive |
No |
Boolean |
Status of the partner contact if active or not |
|
|
3.13 |
IsDeleted |
No |
Boolean |
Visibility status of the partner contact if visible on the application platform of not |
|
|
3.14 |
No |
List of Activity object |
Check data type Activity for details |
||
|
3.15 |
No |
List of SourceSystemDetails object |
An array of strings that contain information on source systems of contact data |
|
|
|
3.16 |
CultureCode |
No |
String |
Culture Code of partner |
|
|
3.17 |
ContactTrackingTypeName |
No |
List of String |
Contact Tracking Type Name |
|
|
PartnerLocations |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
3.10.1 |
LocationCode |
Yes |
String |
Location code of this location |
|
|
3.10.2 |
LocationName |
Yes |
String(100) |
Name of this location |
|
|
3.10.3 |
GEPLocationCode |
No |
Long |
GEP location code of the entity This field is only available on outbound and not on inbound |
|
|
3.10.4 |
No |
Address object |
Check data type Address for details |
|
|
|
3.10.5 |
IsDeleted |
No |
Boolean |
Visibility status of the entity on whether it should be visible on the application or not |
|
|
3.10.6 |
LocationType |
No |
List of LocationType object |
An Array of location types. The list of location types that are available to select are as follows; “None”, “RemitToLocation”, “OrderingLocation”, “SolicitationLocation”, “InvoicingLocation”, “Other” Note: The values in this field are case sensitive |
|
|
3.10.7 |
LocationTypes |
No |
List of string |
|
|
|
3.10.8 |
No |
List of PartnerContact object |
Check data type PartnerContact for details This field is only available on outbound and not on inbound |
|
|
|
3.10.9 |
No |
List of EngagementEntityDetail object |
Check data type EngagementEntityDetail for details |
||
|
3.10.10 |
SourceSystemDetails |
No |
List of SourceSystemDetails object |
An array of strings that contain information on source systems of location data |
|
|
3.10.11 |
No |
List of OtherIdentificationType object |
Check data type OtherIdentificationType for Details |
||
|
3.10.12 |
No |
List of LinkedLocationDetails object |
Check data type LinkedLocationDetails for details |
||
|
3.10.13 |
BankingStatus |
No |
String |
||
|
3.10.14 |
PaymentMethod |
No |
String |
||
|
3.10.15 |
ContactRole |
No |
List of string |
Any array of contact role |
|
|
3.10.16 |
IsDefault |
No |
Boolean |
Status of location if this location is default or not |
|
|
3.10.17 |
No |
List of PartnerBankingInformations object |
Check data type PartnerBankingInformations for details |
||
|
EngagementModel |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validation/Exceptions |
|
3.10.9.1 |
EntityCode |
No |
String |
Entity Code of entity |
|
|
3.10.9.2 |
EntityType |
No |
String |
Entity type of entity |
|
|
3.10.9.3 |
EngagementType |
No |
List of String |
Engagement Type of entity |
|
|
3.10.9.4 |
LobEntityCode |
No |
String |
Lob Entity Code of entity |
|
|
SourceSystemDetails |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
3.10.10.1 |
Name |
Yes |
String |
Source system name |
|
|
3.10.10.2 |
Value |
Yes |
String |
Source system value |
|
|
OtherIdentificationTypes |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
3.10.11.1 |
IdentificationNumber |
No |
String(30) |
Identification number of the entity |
|
|
3.10.11.2 |
IdentificationType |
No |
IdentificationType object |
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 |
|
3.10.12.1 |
LinkedGEPLocationID |
No |
Long |
GEP Linked Location Id |
|
|
3.10.12.2 |
No |
List of SourceSystemDetails object |
Check data type SourceSystemDetails for details |
|
|
|
3.10.12.3 |
GEPLocationID |
No |
Long |
GEP Location Id |
|
|
3.10.12.4 |
isDeleted |
No |
Boolean |
Visibility status of the entity on whether it should be visible on the application or not |
|
|
3.10.12.5 |
LocationCode |
No |
String |
Location code of linked location |
|
|
BankingInfo |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
3.10.17.1 |
BankName |
No |
String |
Bank Name of the entity |
|
|
3.10.17.2 |
BeneficiaryName |
No |
String |
Beneficiary Name of the entity |
|
|
3.10.17.3 |
BankBranch |
No |
String |
Bank Branch of the entity |
|
|
3.10.17.4 |
Country |
No |
String |
Country name of the entity |
|
|
3.10.17.5 |
BankAccountNumber |
No |
String |
Bank Account Number of the entity |
|
|
3.10.17.6 |
Swift_BIC |
No |
String |
|
|
|
3.10.17.7 |
IBAN |
No |
String |
|
|
|
3.10.17.8 |
BankKey_ABA |
No |
String |
|
|
|
3.10.17.9 |
ChipUid |
No |
String |
|
|
|
3.10.17.10 |
AccountTypeName |
No |
String |
Account Type Name of entity |
|
|
3.10.17.11 |
PaymentMethodName |
No |
String |
Payment Method Name |
|
|
3.10.17.12 |
IsDeleted |
No |
Boolean |
Visibility status of the entity on whether it should be visible on the application or not |
|
|
3.10.17.13 |
FIKCode |
No |
String |
|
|
|
3.10.17.14 |
FactoringCompanyName |
No |
String |
GEP Linked Location Id |
|
|
3.10.17.15 |
FactoringCompanyCVR |
No |
String |
|
|
|
3.10.17.16 |
Comments |
No |
String |
Comments |
|
|
UserActivities |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
3.14.1 |
UserActivity |
No |
String |
|
|
|
Categories |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
20.1 |
PasCode |
No |
Long |
Pas Code of entity |
|
|
20.2 |
IsDefault |
No |
Boolean |
Status of the entity if this is default or not |
|
|
20.3 |
ClientPasCode |
No |
String |
Client Pas Code of entity |
|
|
20.4 |
IsDeleted |
No |
Boolean |
Status of the entity on whether it should be visible on the application or not |
|
|
DiversityDetails |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
28.1 |
DiversityName |
Yes |
String(2000) |
Name of the diversity |
|
|
28.2 |
DiversityDescription |
No |
String |
Description of the diversity |
|
|
28.3 |
No |
Certificate object |
Check data type certificates for details This field is only available on outbound and not on inbound |
|
|
|
CertificateDetails |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
29.1 |
CertificateName |
Yes |
String(100) |
Name of the certificate |
|
|
29.2 |
CertificateNumber |
Yes |
String(100) |
Number of the certificate |
|
|
29.3 |
CertificateTypes |
Yes |
CertificateType Enum |
One of the following values will be provided in this field; “None", "Other”, "COICertificateOfInsurance", "Diversity", "ISO_InternationalStandardizationOrganization", "PCI_PaymentCardIndustrySecurityStandardsReports", "RStamp", "SOC_ServiceOrganizationControlReports", “TQM_TotalQualityManagement”. Note: The values in this field are case sensitive |
|
|
29.4 |
IssuingAuthority |
Yes |
String (100) |
Organization or authority which issued this certificate |
|
|
29.5 |
EffectiveDate |
No |
dateTime |
Date from when the certificate is effective |
|
|
29.6 |
ExpiryDate |
No |
dateTime |
Date from when the certificate will expire |
|
|
29.7 |
TypeOfCertificate |
No |
String (100) |
Certificate Type |
|
|
29.8 |
IsDeleted |
No |
Boolean |
Status of the certificate |
|
|
29.9 |
No |
List of BZFileDetails object |
Check Data Type BZFileDetails for details |
||
|
FileDetail |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
29.9.1 |
FileName |
No |
String |
File Name of entity |
|
|
29.9.2 |
FileData |
No |
Byte |
File Data of entity |
|
|
29.9.3 |
FileExtn |
No |
String |
File Extn of entity |
|
|
29.9.4 |
ContentType |
No |
String |
Content Type of entity |
|
|
29.9.5 |
IsDeleted |
No |
Boolean |
Visibility status of the entity on whether it should be visible on the application or not |
|
|
29.9.6 |
AttachmentID |
No |
Long |
Attachment ID of entity |
|
|
29.9.7 |
CertificateID |
No |
Long |
Attachment ID of entity |
|
|
AdditionalInformation |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
30.1 |
QuestionText |
No |
String |
Text of the question |
|
|
30.2 |
No |
List of QuestionResponse object |
An array of question response |
|
|
|
30.3 |
QuestionId |
No |
Long |
Id of question |
|
|
30.4 |
isDeleted |
No |
Boolean |
Status of the entity if they are to be visible or not, on the application |
|
|
QuestionsResponseList |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
30.2.1 |
No |
List of Question object |
An array of child questions (if any) under this parent question |
|
|
|
30.2.2 |
ResponseValue |
No |
String |
Response value that is available under a question |
|
|
30.2.3 |
ColumnText |
No |
String |
Text of the column |
|
|
30.2.4 |
RowId |
No |
Long |
Row Id |
|
|
PaymentTerms |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
31.1 |
PaymentTermName |
No |
String |
The name of the payment term |
|
|
31.2 |
IsDefault |
No |
Boolean |
Status of the payment term if this payment term is default or not |
|
|
31.3 |
PaymentTermCode |
No |
String |
The code of the payment term |
|
|
31.4 |
No |
List of OrgEntity object |
Check data type OrgEntity for details |
|
|
|
31.5 |
LobEntityCode |
No |
String |
LobEntityCode of the payment term |
|
|
OrgEntities |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
31.4.1 |
EntityCode |
No |
String |
Entity Code of entity |
|
|
31.4.2 |
IsDefault |
No |
Boolean |
Status of the entity if this is default or not |
|
|
31.4.3 |
EntityType |
No |
String |
Entity Type of entity |
|
|
31.4.4 |
LOBEntityCode |
No |
String |
LOB Entity Code of entity |
|
|
TransactionTypes |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
34.1 |
TransactionTypeName |
No |
String |
Name of Transaction Type |
|
|
34.2 |
TransactionMethod |
No |
String |
Method of Transaction |
|
|
34.3 |
ClientPartnerCode |
No |
String |
Client Partner Code of transaction |
|
|
LanguagesSupported |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
41.1 |
LanguageCode |
No |
String |
Language Code of entity |
|
|
41.2 |
LanguageDescription |
No |
String |
Language Description of entity |
|
|
ShippingDetails |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
42.1 |
FOBCode |
Yes |
String |
FOB Code for shipping |
|
|
42.2 |
LocationCode |
Yes |
String |
Location Code for shipping |
|
|
42.3 |
FOBDescription |
No |
String |
FOB Description for shipping |
|
|
42.4 |
LOBEntityCode |
No |
String |
LOB Entity Code for shipping |
|
|
42.5 |
LocationDescription |
No |
String |
Location Description for shipping |
|
|
42.6 |
No |
List of OrgEntity object |
Check data type OrgEntity for details |
|
|
|
CurrencyOrgMapping |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
44.1 |
CurrencyCode |
Yes |
String |
|
|
|
44.2 |
No |
List of OrgEntity object |
Check data type OrgEntity for details |
|
|
|
44.3 |
LOBEntityCode |
No |
String |
||
|
FormerlyKnownAs |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
53.1 |
SequenceNumber |
No |
Long |
Sequence Number of entity |
|
|
53.2 |
Name |
No |
String |
Name for FormelyKnownAs |
|
|
53.3 |
ModifiedDate |
No |
DateTime |
Modified Date |
|
|
53.4 |
IsDeleted |
No |
Boolean |
Status of the entity on whether it should be visible on the application or not |
|