DownloadThe Supplier Inbound Bulk API is designed to post supplier profile details from an external ERP system to the GEP system. This API facilitates the seamless transfer of supplier data, ensuring that profiles from the ERP are integrated into the GEP platform.
URLs:
Upload the JSON File to BLOB:
https://<instance>.gep.com/clickservice/api/v1/ClickBlobProxy/GetFileIdFromUploadFileFromByteArray
Submit the File ID to Bulk API Framework:
https://<instance>.gep.com/leo-bulkprocess-api/api/BulkProcess/Upload
Body:
{
"FileId": "aDkTfVsvvQQ6fqgeSfL7cIUYj9YHmPdCVGZNCZxlLWJJeEHn4m9e3hTTEXWz709z",
"TemplateId": "BulkUploadSupplierJsonTemplateV2"
}
{
"clientPartnerCode": "string",
"rootMetaData": {
"clientPartnerCode": "string"
},
"partnerCode": "string",
"isDeleted": "boolean",
"sections": {
"isDeleted": "boolean",
"paymentTerm": {
"rows": [
{
"businessUnits": [
{
"entityDetailCode": "integer",
"entityName": "string",
"entityType": "string",
"entityCode": "string",
"entityDetailDescription": "string",
"parentEntityDetailCode": "integer",
"parentEntity": "string",
"parentEntityCode": "string",
"gepId": "string",
"lobName": "string",
"lobCode": "string",
"isDefault": "boolean",
"level": "integer",
"childCount": "integer",
"displayName": "string",
"parentDetails": [
{
"entityName": "string",
"entityDetailCode": "integer",
"level": "integer"
}
]
}
],
"paymentTerms": [
{
"paymentTermCode": "string",
"lob": "string",
"orgEntityDetailCode": "string",
"paymentTermName": "string",
"description": "string",
"dueDays": "integer",
"discountPercentage": "float",
"discountDays": "integer",
"markAsDefault": "boolean",
"isActive": "boolean",
"isPrimary": "boolean"
},
{
"paymentTermCode": "string",
"lob": "string",
"orgEntityDetailCode": "string",
"paymentTermName": "string",
"description": "string",
"dueDays": "integer",
"discountPercentage": "float",
"discountDays": "integer",
"markAsDefault": "boolean",
"isActive": "boolean",
"isPrimary": "boolean"
}
],
"paymentTermsId": "string",
"partnerCode": "string",
"rowAuditFields": {
"createdDate": "string",
"updatedDate": "string"
},
"isDeleted": "boolean",
"id": "string"
}
]
},
"basicDetails": {
"supplierId": "string",
"doingBusinessAs": "string",
"legalCompanyName": "string",
"origination": "string",
"normalisedName": "string",
"uniqueIdentificationNumber": "string",
"isUINUpdated": "boolean",
"domainName": "string",
"formerlyKnownAs": "string",
"isUniqueIdentificationNumberEncrypted": "boolean",
"isDomainOwner": "boolean",
"similarSupplier": "array",
"widgetId": "string",
"supplierCreatedOn": "string",
"sustainabilityScore": "number",
"isManagedFlag": "boolean",
"isRnDFlag": "boolean",
"isManaged": "string",
"lastTriggerDate": "string",
"isDiversity": "string",
"isUINMaskedUpdated": "boolean",
"hierarchySupplierManager": "number",
"reasonForDeactivation": "string",
"spendValue": "string",
"qualificationScore": "string",
"imageURL": "string",
"isDirectLink": "boolean",
"isAllLocationORGMapped": "boolean",
"partnerRescreeningStatus": "number",
"qualificationIndicator": "string",
"formUpdatedDate": "string",
"bvdId": "string",
"nppSpendStatus": "string",
"prodSpendStatus": "string",
"spendStatus": "string",
"tpiapprovername": "string",
"tpiapprovercode": "string",
"interfaceToPlant": "string",
"ecovadisSustainibilityScore": "number",
"capacityApproveForVendor": "string",
"airwallxId": "string",
"chkReasonAddingSup1": "boolean",
"chkReasonAddingSup2": "boolean",
"chkReasonAddingSup3": "boolean",
"reasonCommentAddingSup": "string",
"reasonCommentAddingSup1": "string",
"isTurnoverAboveFiveCr": "string",
"regions": [
{
"id": "number",
"code": "string",
"name": "string",
"childCount": "number",
"parentDetails": "array",
"isDefault": "boolean",
"level": "number",
"displayName": "string"
}
],
"tradingPartner": "array",
"categories": [
{
"id": "number",
"name": "string",
"parentId": "number",
"clientCode": "string",
"isDefault": "boolean",
"childCount": "number",
"level": "number",
"parentDetails": "array",
"displayName": "string"
}
],
"nDSAStatus": {
"name": "string",
"code": "string"
},
"heirachicalDetails": {
"parentClientSupplierCode": "string",
"parentLegalCompanyName": "string",
"parentName": "string",
"parentPartnerCode": "string",
"parentSmartPartnerCode": "string"
},
"formerlyFieldData": "array",
"uniqueIdentificationNumberStatus": {
"name": "string",
"code": "string"
},
"businessUnits": [
{
"entityDetailCode": "number",
"entityName": "string",
"entityType": "string",
"entityCode": "string",
"entityDetailDescription": "string",
"parentEntityDetailCode": "number",
"parentEntity": "string",
"parentEntityCode": "string",
"gepId": "string",
"lobName": "string",
"lobCode": "string",
"isDefault": "boolean",
"level": "number",
"childCount": "number",
"displayName": "string"
}
],
"supplierManagers": "array",
"starRating": {
"starRating": "string",
"code": "string"
},
"partnerStatus": {
"name": "string",
"code": "string",
"nameKey": "string"
},
"isDeversity": {
"name": "string",
"code": "string",
"nameKey": "string"
},
"searchParentCompanyUsing": {
"name": "string",
"code": "string"
},
"reasonForAddingSupplier": {
"name": "string",
"code": "string"
},
"supplierScope": {
"code": "string",
"name": "string",
"codeType": "string"
}
},
"identification": {
"rows": [
{
"identificationNumber": "string",
"attachment": "array",
"identificationnumberEncrypt": "boolean",
"id": "string",
"country": {
"code": "string",
"name": "string"
},
"identificationType": {
"code": "string",
"name": "string"
},
"isDeleted": "boolean",
"identificationkey": "string",
"thirdPartyId": "string",
"isIdentificationUpdated": "boolean",
"rowAuditFields": {
"createdDate": "string",
"updatedDate": "string"
},
"isNewlyCreated": "boolean"
}
]
},
"transactionTypeDetails": {
"contractFormat": {
"name": "string",
"code": "string"
},
"servConfFormat": {
"name": "string",
"code": "string"
},
"rFXFormat": {
"name": "string",
"code": "string"
},
"pOFormat": {
"name": "string",
"code": "string"
},
"auctionFormat": {
"name": "string",
"code": "string"
},
"invoiceFormat": {
"name": "string",
"code": "string"
}
},
"supplierSourceInfo": {
"rows": [
{
"createdInErp": "string",
"code": "integer",
"id": "string",
"name": "string",
"sourceIdentificationNo": "string",
"updatedDate": "string",
"createdDate": "string",
"interfaceComments": "string",
"isInterfaced": "boolean",
"isDeleted": "boolean",
"interfaceStatus": {
"name": "string",
"code": "string"
}
}
]
},
"onboarding": {
"rows": [
{
"formCode": "string",
"formName": "string",
"formResponseSubmittedBy": "string",
"formSubmissionUserType": "string",
"isInvitePrimaryContact": "boolean",
"isTriggerRelationship": "boolean",
"transactionFormCode": "string",
"transactionFormCodes": [
"array of strings"
],
"formResponseSubmissionDate": "string",
"lastRefreshDate": "string",
"id": "string",
"categories": [
{
"childCount": "integer",
"clientCode": "string",
"displayName": "string",
"isDefault": "boolean",
"level": "integer",
"name": "string",
"id": "integer",
"parentId": "integer",
"parentDetails": [
{
"id": "integer",
"name": "string",
"level": "integer"
}
]
}
],
"onboardingRelationshipInfo": {
"isRelationshipApproved": "boolean",
"isMailSentForExpiry": "boolean",
"approvers": "string",
"approversFullName": "string",
"autoCalculatedOverallStatus": "boolean",
"finalActionTakenUsername": "string",
"instanceid": "string",
"isActive": "boolean",
"isFormTriggered": "boolean",
"isOnboardingSentBack": "boolean",
"isOnboardingSubmitted": "boolean",
"isOnboardingTriggered": "boolean",
"isRelationshipRejected": "boolean",
"numberOfOnboardingApprovalSentBackCycles": "integer",
"numberOfRefreshApprovalSentBackCycles": "integer",
"onboardingApprovedBy": "string",
"onboardingRejectedBy": "string",
"onboardingRowId": "string",
"onboardingSentBackBy": "string",
"onboardingSubmittedBy": "string",
"onboardingTriggeredBy": "string",
"oridSendBackType": "string",
"overallStatusId": "string",
"profileSubmissionUserName": "string",
"profileSubmissionUserType": "string",
"relationshipTypeId": "integer",
"relationshipTypeName": "string",
"status": "string",
"tradingPartnerTypeCode": "string",
"tradingPartnerTypeName": "string",
"isMailSent": "boolean",
"onboardingSentBackDate": "string",
"onboardingSubmittedDate": "string",
"onboardingTriggeredDate": "string",
"profileSubmissionDate": "string",
"onboardingFinalActionTakenDate": "string",
"statusId": "string",
"onboardingApprovedOn": "string",
"onboardingRejectedon": "string",
"isApprovedViaInterface": "boolean",
"oldOverallStatusId": "string",
"oldOverallStatus": "string",
"overallStatus": "string",
"isFirstRelationship": "boolean",
"onboardingReviewedBy": "string",
"onboardingApprovedByReviewer": "boolean",
"onboardingReviewTriggered": "boolean",
"alertDate": "string",
"nBOHDate": "string",
"isMailSentForAlert": "boolean",
"isMailSentForNBOH": "boolean",
"isRelationshipWithdrawn": "boolean",
"onboardingWithdrawnBy": "string",
"onboardingWithdrawnOn": "string",
"refreshSupplierWorkflowDetails": [
{
"actionTakenDate": "string",
"approvers": "string",
"isNoChangesNeeded": "boolean",
"isSentBack": "boolean",
"isSubmittedOboSupplier": "boolean",
"refreshDate": "string",
"refreshProfileInstanceId": "string",
"refreshSupplierActionTaken": "string",
"refreshTriggerStatus": "string",
"rid": "string",
"sendBackAction": "integer",
"refreshedOn": "string",
"requestedDate": "string",
"actionTaken": "string",
"currentStatus": "string",
"formStatus": "string",
"orId": "string",
"createdByCC": "string",
"approvedBy": "string",
"refreshTriggeredDate": "string",
"refreshTriggeredBy": "string",
"triggerSubmissionDate": "string",
"isRefreshTriggerSubmitted": "boolean",
"actionTakenId": "string",
"instanceId": "string",
"isRefreshTriggerApproved": "boolean",
"rejectedOn": "string",
"rejectedBy": "string",
"isRefreshSentBack": "boolean",
"isRefreshTriggerRejected": "boolean",
"partnerCode": "string",
"isActive": "boolean",
"refreshSupplierWorkflowDetailsId": "string",
"contactCode": "string",
"orIdList": "string",
"triggerType": "string",
"lastRefreshDate": "string"
}
]
},
"businessUnits": [
{
"childCount": "integer",
"displayName": "string",
"entityCode": "string",
"entityDetailDescription": "string",
"entityDetailId": "string",
"entityDetailName": "string",
"entityId": "integer",
"entityName": "string",
"entityType": "string",
"gepId": "string",
"isDefault": "boolean",
"level": "integer",
"lobCode": "string",
"lobName": "string",
"parentEntity": "string",
"parentEntityCode": "string",
"parentEntityDetailCode": "integer",
"entityDetailCode": "integer",
"parentDetails": [
{
"entityName": "string",
"level": "integer",
"entityDetailCode": "integer"
}
]
}
],
"regions": [
{
"childCount": "integer",
"code": "string",
"displayName": "string",
"isDefault": "boolean",
"level": "integer",
"name": "string",
"id": "integer",
"parentDetails": [
{
"code": "string",
"name": "string",
"level": "integer"
}
]
}
],
"overallStatus": {
"name": "string",
"code": "string",
"translationCode": "string"
},
"usageType": {
"usageTypeId": "integer",
"usageTypeName": "string"
},
"vendorType": {
"name": "string",
"code": "string"
}
}
],
"defaultOnboardingType": {
"name": "string",
"code": "string"
}
},
"teamMember": {
"rows": [
{
"id": "string",
"teamMemberId": "string",
"createdBy": "string",
"contactCode": "string",
"stakeholderName": "string",
"emailAddress": "string",
"roleId": "string",
"roleName": "string",
"businessUnits": [
"array of objects"
],
"isRowDisabled": "boolean",
"isDeleted": "boolean"
}
]
},
"relationshipInfo": {
"businessCriticality": {
"name": "string",
"code": "string"
},
"vendorType": {
"name": "string",
"code": "string"
},
"relationshipType": {
"name": "string",
"code": "string"
},
"supplierRiskType": {
"name": "string",
"code": "string"
},
"matchingType": {
"name": "string",
"code": "string"
},
"sourceType": {
"name": "string",
"code": "string"
}
},
"businessInfo": {
"annualRevenue": "number",
"annualProfit": "number",
"employees": "number",
"website": "string",
"facebookURL": "string",
"linkedInURL": "string",
"twitterURL": "string",
"about": "string",
"currentCustomers": "string",
"widgetId": "string",
"autoAcknowledgeOrder": "boolean",
"isPCardSupported": "boolean",
"isAllowCreateASN": "boolean",
"isAllowAutoReceiving": "boolean",
"isERSEnabled": "boolean",
"dateOfIncorporation": "string (date format)",
"amount": "string",
"commercialOffering": "string",
"clients": "string",
"paymentType": {
"name": "string",
"code": "string"
},
"languageDetails": [
{
"code": "string",
"displayName": "string"
}
],
"businessType": {
"name": "string",
"code": "string"
},
"currency": {
"name": "string",
"code": "string"
},
"fOnBoard": {
"name": "string",
"code": "string"
},
"prepaidFrieght": {
"name": "string",
"code": "string"
},
"shippingMethod": {
"name": "string",
"code": "string"
},
"taxIndicator": {
"name": "string",
"code": "string"
}
}
},
"certificateDiversity": {
"isDiverseSupplier": "boolean",
"certificateUnrecognized": "boolean",
"certificateMismatchThreshold": "boolean",
"isDeleted": "boolean",
"root_id": "string",
"parent_id": "string",
"rows": [
{
"id": "string",
"certificateId": "string",
"aIValidationStatus": "string",
"certificateCategory": {
"code": "string",
"name": "string"
},
"certificateType": {
"code": "string",
"name": "string",
"plsCertificateTypesCodeMapping": "string"
},
"certificateSubType": {
"code": "string",
"name": "string"
},
"certificateNumber": "string",
"issuingAuthority": "string",
"certificateStatus": {
"code": "string",
"name": "string"
},
"mandatoryForComplience": {
"code": "string",
"name": "string"
},
"repeatEvery": "number",
"sendEmail": "number",
"certificateAttachment": [
{
"id": "string",
"fileName": "string",
"expireOn": "string (date format)",
"effectiveFrom": "string (date format)",
"uploadedBy": "string",
"uploadedOn": "string (date format)",
"fileId": "string",
"doesNotExpire": "boolean",
"aIValidationStatus": "string",
"isAttachmentUpdated": "boolean"
}
],
"isNewlyCreated": "boolean",
"isDeleted": "boolean",
"isNewlyCreatedCertificate": "boolean"
}
]
},
"location": {
"isDeleted": "boolean",
"root_id": "string",
"parent_id": "string",
"rows": [
{
"isHeadquarter": "boolean",
"locationId": "number",
"isDeleted": "boolean",
"supplierProfile_partnerCode": "string",
"isNewlyCreated": "boolean",
"id": "string",
"sections": {
"locationOrgEntityMapping": {
"rows": [
{
"id": "string",
"eRSFlag": "boolean",
"isDeleted": "boolean",
"locationtype": [
{
"code": "string",
"name": "string"
}
],
"businessUnits": "array",
"engagementModel": [
{
"code": "string",
"name": "string"
}
],
"status": {
"code": "string",
"name": "string"
},
"defaultCurrency": {
"code": "string",
"name": "string"
},
"locorgersflag": {
"code": "string",
"name": "string"
},
"currency": [
{
"code": "string",
"name": "string"
}
],
"isNewlyCreated": "boolean"
}
]
},
"locationAddress": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"zipCode": "string",
"pOBoxnumber": "string",
"id": "string",
"county": "string",
"postalCode": "string",
"addressLine3": "string",
"runTrilliumCheck": "boolean",
"trilliumVerified": "boolean",
"areaCode": "string",
"street3": "string",
"country": {
"code": "string",
"name": "string"
},
"state": {
"code": "string",
"name": "string",
"countryCode": "string"
},
"cityLocode": {
"name": "string",
"code": "string"
}
},
"locationContactRoles": {
"rows": [
{
"id": "string",
"contactRoleId": "string",
"contactRoleName": "string",
"contacts": "string",
"roleId": "string",
"roleName": "string",
"role": "string",
"customAttributes": "string",
"isDeleted": "boolean",
"isNewlyCreated": "boolean",
"contactNames": [
{
"clientContactCode": "string",
"firstName": "string",
"lastName": "string"
}
],
"contactRole": {
"name": "string",
"code": "string"
}
}
]
},
"locationTransactionType": {
"contractFormat": {
"code": "string",
"name": "string"
},
"servConfFormat": {
"code": "string",
"name": "string"
},
"rFXFormat": {
"code": "string",
"name": "string"
},
"pOFormat": {
"code": "string",
"name": "string"
},
"auctionFormat": {
"code": "string",
"name": "string"
},
"invoiceFormat": {
"code": "string",
"name": "string"
}
},
"locationBasicDetails": {
"isNoInvoicinginGEP": "boolean",
"changeOrder": "boolean",
"autoAcknowlegeOrder": "boolean",
"isDefaultCurrencyCodeAvailable": "boolean",
"autoacknowledgereturnnote": "boolean",
"isSingleCurrencyAvailable": "string",
"locationName": "string",
"primaryBusinessPhone": "string",
"secondaryBusinessPhone": "string",
"supplierLocationCode": "string",
"bankingInformationCodes": "string",
"allLocationType": "string",
"primaryNumberExtn": "string",
"secondaryNumberExtn": "string",
"faxNumber": "string",
"isLocationStatus": "string",
"isCountryCurrencyUpdated": "boolean",
"faxNoExtension": "string",
"alternateLocationName": "string",
"isERSEnabled": "boolean",
"primaryPaySite": "boolean",
"payEachInvoiceAlone": "boolean",
"isParentLocation": "boolean",
"alternatePaySiteLocationID": "number",
"latitude": "string",
"longitude": "string",
"bpdh": "boolean",
"legalEntityID": "string",
"locationType": [
{
"code": "string",
"name": "string"
}
],
"supportedCurrencies": [
{
"code": "string",
"name": "string"
}
],
"supportingCurrencies": {
"code": "string",
"name": "string"
},
"climateRiskRating": {
"name": "string",
"code": "string"
}
},
"locationIdentification": {
"rows": [
{
"identificationNumber": "string",
"identificationnumberEncrypt": "boolean",
"id": "string",
"country": {
"code": "string",
"name": "string"
},
"identificationType": {
"code": "string",
"name": "string"
},
"isDeleted": "boolean",
"isIdentificationUpdated": "boolean",
"identificationkey": "string",
"thirdPartyId": "string",
"isNewlyCreated": "boolean"
}
]
},
"locationIncoTerms": {
"rows": [
{
"id": "string",
"isDeleted": "boolean",
"isNewlyCreated": "boolean",
"division": "string",
"description": "string",
"incoTerms": {
"name": "string",
"code": "string"
},
"businessUnits": [
{
"entityDetailCode": "number",
"entityName": "string",
"entityType": "string",
"entityCode": "string",
"entityDetailDescription": "string",
"parentEntityDetailCode": "number",
"parentEntity": "string",
"parentEntityCode": "string",
"gepId": "string",
"lobName": "string",
"lobCode": "string",
"isDefault": "boolean",
"level": "number",
"childCount": "number",
"displayName": "string"
}
]
}
]
}
},
"defaultBanking": {
"locationName": "string",
"locationId": "string",
"clientBankingCode": "string",
"bankingDetails": "string",
"bankingId": "string"
},
"creditBanking": {
"locationName": "string",
"locationId": "string",
"clientBankingCode": "string",
"bankingDetails": "string",
"bankingId": "string"
}
}
],
"referenceMetaData": {
"partnerCode": "string",
"isChangeRequest": "boolean",
"isDraft": "boolean",
"draftId": "string",
"isDeleted": "boolean",
"draftContactCode": "string",
"changeRequestVersionId": "string",
"isSupplierRequest": "boolean",
"isDataAutoPopulatedByTealbook": "boolean"
}
},
"contactInformation": {
"isDeleted": "boolean",
"root_id": "string",
"parent_id": "string",
"rows": [
{
"isDeleted": "boolean",
"isAICreatedContact": "boolean",
"contactCode": "string",
"id": "string",
"contactMappingId": "string",
"forwardedByContactCode": "string",
"forwardedByContactEmailId": "string",
"contactState": {
"clientContactCode": "string",
"contactCode": "string",
"designation": "string",
"faxNo": "string",
"isBuyerVisible": "boolean",
"iSDCode": "string",
"isDeleted": "boolean",
"isInvitedBeforeSave": "boolean",
"isPrimaryContact": "boolean",
"isSupplierVisible": "boolean",
"mobileNo": "string",
"primaryPhoneExtension": "string",
"primaryPhoneNumber": "string",
"secondaryPhoneExtension": "string",
"secondaryPhoneNumber": "string",
"emailId": "string",
"firstName": "string",
"lastName": "string",
"registerdate": "string",
"dateDeleted": "string",
"dateOfCreation": "string",
"dateOfUpdation": "string",
"title": "string",
"fullName": "string",
"contactLastLoginDate": "string",
"language": {
"name": "string",
"code": "string"
},
"statusCode": {
"name": "string",
"code": "string"
},
"timezone": {
"name": "string",
"code": "string"
},
"department": {
"name": "string",
"code": "string"
}
},
"rowAuditFields": {
"createdBy": "string",
"createdDate": "string",
"updatedBy": "string",
"updatedDate": "string",
"deletedDate": "string"
}
}
],
"primaryContactInfo": {
"firstName": "string",
"lastName": "string",
"emailId": "string",
"primaryPhoneNumber": "string",
"primaryPhoneExtension": "string",
"isFollower": "boolean",
"isInvite": "boolean",
"contactCode": "string",
"clientContactCode": "string",
"primaryContactLanguage": {
"code": "string",
"displayName": "string"
},
"timezone": {
"name": "string",
"code": "string"
}
},
"contactMappingRows": [
{
"clientContactCode": "string",
"contactCode": "string",
"contactMappingCode": "string",
"isDeleted": "boolean",
"isNewlyCreated": "boolean",
"roleId": "number",
"roleName": "string",
"contactMappingId": "string",
"id": "string",
"defaultRoleId": "boolean",
"smartContactCode": "string",
"categories": "array",
"businessUnits": "array",
"regions": "array",
"personas": [
{
"personaCode": "string",
"smartPersonaCode": "string",
"personaName": "string",
"relationshipCode": "string",
"tradingPartnerCode": "string"
}
],
"divisions": "array"
}
]
},
"attachments": {
"root_id": "string",
"parent_id": "string",
"rows": [
{
"isDeleted": "boolean",
"isNewlyCreated": "boolean",
"isFormsAttachment": "boolean",
"createdBy": "string",
"fileId": "string",
"fileName": "string",
"fileSize": "number",
"fileSizeInKB": "number",
"id": "string",
"uploadedBy": "string",
"visibility": "string",
"classification": {
"code": "string",
"name": "string"
},
"uploadedOn": "string"
}
],
"auditFields": {
"createdBy": "string",
"createdDateTime": "string",
"modifiedBy": "string",
"modifiedDateTime": "string"
},
"personaCode": "string",
"relationshipCode": "string",
"tradingPartnerCode": "string"
},
"bankingInformationDetails": {
"isDeleted": "boolean",
"root_id": "string",
"parent_id": "string",
"rows": [
{
"sections": {
"bankingInformation": {
"abaBankKey": "string",
"addedByContactCode": "string",
"addedByFullName": "string",
"bankAccountNumber": "string",
"confirmBankAccountNumber": "string",
"bankBranch": "string",
"bankingInformationCode": "string",
"bankingInformationId": "string",
"bankName": "string",
"beneficiaryName": "string",
"clientBankReferenceId": "string",
"iban": "string",
"modifiedByFullName": "string",
"swiftBic": "string",
"linkedLocations": [
"string"
],
"unitedStatesACHABA": "string",
"unitedStatesFEDWireABA": "string",
"uSDwithinPaymentAcceptedVia": "string",
"bankTransitNumber": "string",
"bSBNo": "string",
"iFSCcode": "string",
"branchSortcode": "string",
"regulatoryType": "string",
"regulatoryValue": "string",
"nCCTypeCode": "string",
"uSDPaymentAcceptedVia": "string",
"paymentMethod": {
"name": "string",
"code": "string"
},
"country": {
"code": "string",
"name": "string"
},
"id": "string",
"airwallexLinkStatus": {
"name": "string",
"code": "string"
}
},
"beneficiaryAddress": {
"addressline1": "string",
"addressline2": "string",
"city": "string",
"zipPostalcode": "string",
"country": {
"code": "string",
"name": "string"
},
"state": {
"_id": "string",
"code": "string",
"name": "string",
"countryCode": "string"
}
},
"intermediaryAddress": {
"rows": [
{
"addressline1": "string",
"addressline2": "string",
"city": "string",
"zipPostalcode": "string",
"isDeleted": "boolean",
"isNewlyCreated": "boolean",
"id": "string",
"aba": "string",
"swift": "string",
"countryId": "string",
"country": {
"code": "string",
"name": "string"
},
"state": {
"code": "string",
"name": "string"
}
}
]
}
},
"isDeleted": "boolean",
"isNewlyCreated": "boolean",
"id": "string"
}
]
}
}
{
"returnValue": {
"isSuccess": "bool",
"errorCode": "int",
"errorMessage": "null",
"responseMessage": "string",
"gepPartnerCode": "string",
"clientPartnerCode": "string"
},
"isSuccess": "bool",
"errors": "null",
"exception": "null",
"errorMessage": "null",
"errorCode": "null",
"correlationId": "null"
}
• isSuccess: A boolean indicating whether the request was successful (true) or not (false). • errorCode: An integer code representing the type of error (if any).
• errorMessage: A message describing the error (if any).
• responseMessage: A general message detailing the response, such as "Supplier Profile Successfully Created". • gepPartnerCode: The GEP system's generated partner code for the supplier.
• clientPartnerCode: The original partner code from the client ERP system.
• isSuccess: A boolean indicating the overall success of the request.
• errors: A field containing error details (if any).
• exception: Any exception encountered during the processing of the request.
• errorMessage: Any additional error messages.
• errorCode: The error code (if applicable).
• correlationId: An identifier used for tracing the request across systems.
Property | Required? | Data Type | Description | Validations / Exceptions |
FileId | Yes | String | Unique identifier for the file uploaded to the system. | Must be a valid string or unique identifier; alphanumeric, no special characters allowed. |
TemplateId | Yes | String | Identifier for the template used for the bulk "BulkUploadSupplierJsonTemplateV2". | Must be a valid, predefined template name string. |
Property | Required? | Data Type | Description | Validations / Exceptions |
GUID |
| GUID | A globally unique identifier (GUID) used for tracking or identifying an entity. | Must be a valid GUID format (e.g., xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). |
ClientPartnerCode |
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
clientPartnerCode | Yes | String | A unique identifier or code for the client partner | Must be a valid string | ||||
|
|
|
|
| ||||
Sub-Object: rootMetaData |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
clientPartnerCode | Yes | String | A unique identifier or code for the client partner | Must be a valid string | ||||
|
|
|
|
| ||||
Certificate |
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
isDiverseSupplier | Yes | Boolean | Indicates if the supplier is diverse. | N/A | ||||
widgetId | Yes | String | Unique widget ID. | N/A | ||||
supplierProfile_partnerCode | No | String | Partner code for the supplier profile. | Can be empty | ||||
skipIngestion | Yes | Boolean | Flag to skip ingestion of the data. | N/A | ||||
skipEsIngestion | Yes | Boolean | Flag to skip ingestion into ElasticSearch (ES). | N/A | ||||
certificateUnrecognized | Yes | Boolean | Flag indicating if the certificate is unrecognized. | N/A | ||||
certificateMismatchThreshold | Yes | Boolean | Flag for certificate mismatch threshold. | N/A | ||||
isDeleted | Yes | Boolean | Flag indicating if the certificate is deleted. | N/A | ||||
root_id | Yes | String | Root ID for tracking the root object. | N/A | ||||
parent_id | Yes | String | Parent ID for hierarchical structure. | N/A | ||||
rows | Yes | Array of objects | List of certificate rows associated with the supplier | N/A | ||||
|
|
|
|
| ||||
Row Object |
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
id | Yes | String | Unique identifier for the certificate row. | N/A | ||||
certificateId | No | String | Certificate ID, if applicable. | Can be empty | ||||
aIValidationStatus | No | String | AI validation status of the certificate. | Can be empty | ||||
certificateCategory | Yes | Object | Details of the certificate category. | Must contain valid code and name properties | ||||
certificateCategory.code | Yes | String | Code representing the certificate category. | Must be valid code | ||||
certificateCategory.name | Yes | String | Name of the certificate category. | N/A | ||||
certificateType | Yes | Object | Details of the certificate type. | Must contain valid code and name properties | ||||
certificateType.code | Yes | String | Code for the certificate type. | Must be valid code | ||||
certificateType.name | Yes | String | Name of the certificate type. | N/A | ||||
certificateType.plsCertificateTypesCodeMapping | No | String | Mapping for certificate type code, if applicable. | Can be empty | ||||
certificateSubType | Yes | Object | Details of the certificate subtype. | Must contain valid code and name properties | ||||
certificateSubType.code | Yes | String | Code for the certificate sub-type. | Must be valid code | ||||
certificateSubType.name | Yes | String | Name of the certificate sub-type. | N/A | ||||
certificateNumber | Yes | String | Unique number of the certificate. | N/A | ||||
issuingAuthority | Yes | String | ID of the issuing authority. | N/A | ||||
certificateStatus | Yes | Object | Details of the certificate status. | Must contain valid code and name properties | ||||
certificateStatus.code | Yes | String | Code representing the certificate status. | Must be valid code | ||||
certificateStatus.name | Yes | String | Name of the certificate status. | N/A | ||||
mandatoryForComplience | Yes | Object | Details for mandatory compliance status. | Must contain valid code and name properties | ||||
mandatoryForComplience.code | Yes | String | Code for mandatory compliance. | Must be valid code | ||||
mandatoryForComplience.name | Yes | String | Name for mandatory compliance status. | N/A | ||||
supplierManagerFlag | Yes | Boolean | Flag indicating if the supplier manager is flagged. | N/A | ||||
repeatEvery | Yes | Integer | Interval (in days) to repeat the certificate. | N/A | ||||
sendEmail | Yes | Integer | Flag indicating if email should be sent. | N/A | ||||
certificateAttachment | Yes | Array of objects | List of attachments related to the certificate. | N/A | ||||
|
|
|
|
| ||||
CertificateAttachment Object |
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
id | Yes | String | Unique identifier for the attachment. | N/A | ||||
fileName | Yes | String | Name of the attached certificate file. | N/A | ||||
expireOn | Yes | String (Date) | Expiry date of the certificate attachment. | Must be in valid date format | ||||
effectiveFrom | Yes | String (Date) | Start date when the certificate is effective. | Must be in valid date format | ||||
uploadedBy | Yes | String | Name of the person who uploaded the attachment. | N/A | ||||
uploadedOn | Yes | String (Date) | Date when the attachment was uploaded. | Must be in valid date format | ||||
fileId | Yes | String | Unique ID for the attachment file. | N/A | ||||
doesNotExpire | Yes | Boolean | Flag indicating if the attachment does not expire. | N/A | ||||
isAttachmentUpdated | Yes | Boolean | Flag indicating if the attachment has been updated. | N/A | ||||
attachmentAIValidationResponse | Yes | Object | AI validation response for the certificate attachment | N/A | ||||
|
|
|
|
| ||||
Location Object |
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
isDeleted | Yes | Boolean | Indicates if the location is deleted. | N/A | ||||
root_id | Yes | String | Root ID for tracking the root object. | N/A | ||||
parent_id | Yes | String | Parent ID for hierarchical structure. | N/A | ||||
rows | Yes | Array of objects | List of location rows associated with the location. | N/A | ||||
|
|
|
|
| ||||
Row Object |
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
isHeadquarter | Yes | Boolean | Flag indicating if the location is a headquarter. | N/A | ||||
locationId | Yes | Integer | ID for the location. | Must be a valid integer | ||||
isDeleted | Yes | Boolean | Flag indicating if the row is deleted. | N/A | ||||
supplierProfile_partnerCode | Yes | String | Partner code for the supplier profile. | N/A | ||||
isNewlyCreated | Yes | Boolean | Flag indicating if the row is newly created. | N/A | ||||
id | Yes | String | Unique ID for the location row. | N/A | ||||
|
|
|
|
| ||||
Sections Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
locationOrgEntityMapping | Yes | Object | Mapping details for the organization entity. | N/A | ||||
LocationOrgEntityMapping Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
rows | Yes | Array of objects | List of organizational entity mappings. | N/A | ||||
|
|
|
|
| ||||
Organizational Row Object |
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
id | Yes | String | Unique ID for the organizational mapping. | N/A | ||||
eRSFlag | Yes | Boolean | Flag for ERS (Electronic Reporting System). | N/A | ||||
isDeleted | Yes | Boolean | Flag indicating if the row is deleted. | N/A | ||||
locationtype | Yes | Array of objects | Location types associated with the organization. | N/A | ||||
businessUnits | Yes | Array of objects | List of business units in the organization. | N/A | ||||
engagementModel | Yes | Array of objects | Engagement model details. | N/A | ||||
status | Yes | Object | Location status details. | N/A | ||||
defaultCurrency | Yes | Object | Default currency details for the location. | Can be empty | ||||
locorgersflag | Yes | Object | ERS flag details. | N/A | ||||
currency | Yes | Array of objects | List of supported currencies. | N/A | ||||
isNewlyCreated | Yes | Boolean | Flag indicating if the organizational mapping is newly created. | N/A | ||||
|
|
|
|
| ||||
Location Address Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
addressLine1 | Yes | String | Address line 1 of the location. | N/A | ||||
addressLine2 | Yes | String | Address line 2 of the location. | N/A | ||||
city | Yes | String | City for the location. | N/A | ||||
zipCode | Yes | String | Zip code for the location. | N/A | ||||
pOBoxnumber | No | String | PO Box number, if applicable. | Can be empty | ||||
id | Yes | String | ID for the location address. | N/A | ||||
county | No | String | County name for the location. | Can be empty | ||||
postalCode | No | String | Postal code for the location. | Can be empty | ||||
country | Yes | Object | Country details for the location. | N/A | ||||
state | Yes | Object | State details for the location. | N/A | ||||
cityLocode | Yes | Object | City location code details. | N/A | ||||
|
|
|
|
| ||||
Country and State Objects |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
code | Yes | String | Country or state code. | Must be valid code | ||||
name | Yes | String | Name of the country or state. | N/A | ||||
countryCode | No | String | Country code for state. | Can be empty | ||||
|
|
|
|
| ||||
Location Contact Roles Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
rows | Yes | Array of objects | List of contact roles associated with the location. | N/A | ||||
|
|
|
|
| ||||
Contact Role Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
id | Yes | String | Unique ID for the contact role. | N/A | ||||
contactRoleId | No | String | ID for the contact role. | Can be empty | ||||
contactRoleName | Yes | String | Name of the contact role. | N/A | ||||
contacts | Yes | String | Contact code associated with the role. | N/A | ||||
roleId | No | String | ID for the role. | Can be empty | ||||
roleName | No | String | Name of the role. | Can be empty | ||||
role | No | String | Description of the role. | Can be empty | ||||
|
|
|
|
| ||||
Location Transaction Type Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
contractFormat | Yes | Object | Contract format details. | N/A | ||||
servConfFormat | Yes | Object | Service confirmation format. | N/A | ||||
rFXFormat | Yes | Object | RFX format details. | N/A | ||||
pOFormat | Yes | Object | PO format details. | N/A | ||||
auctionFormat | Yes | Object | Auction format details. | N/A | ||||
invoiceFormat | Yes | Object | Invoice format details. | N/A | ||||
|
|
|
|
| ||||
Location Basic Details Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
isNoInvoicinginGEP | Yes | Boolean | Flag indicating if invoicing in GEP is not available. | N/A | ||||
changeOrder | Yes | Boolean | Flag indicating if change orders are allowed. | N/A | ||||
autoAcknowlegeOrder | Yes | Boolean | Flag for auto acknowledging orders. | N/A | ||||
locationName | Yes | String | Name of the location. | N/A | ||||
primaryBusinessPhone | Yes | String | Primary business phone number. | N/A | ||||
faxNumber | Yes | String | Fax number for the location. | N/A | ||||
|
|
|
|
| ||||
Location Identification Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
rows | Yes | Array of objects | List of location identification rows. | N/A | ||||
|
|
|
|
| ||||
Identification Row Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
identificationNumber | Yes | String | Unique identification number for the location. | Must be a valid string (no empty values). | ||||
identificationnumberEncrypt | Yes | String | Flag indicating if the identification number is encrypted. | Should be a boolean value in string form ("true" or "false"). | ||||
id | Yes | String | Unique ID for the identification row. | N/A | ||||
country | Yes | Object | Country details related to the identification. | N/A | ||||
identificationType | Yes | Object | Identification type details (e.g., "Security Scorecard"). | N/A | ||||
isDeleted | Yes | Boolean | Flag indicating if the identification is deleted. | N/A | ||||
isIdentificationUpdated | Yes | Boolean | Flag indicating if the identification has been updated. | N/A | ||||
identificationkey | No | String | Key associated with the identification. | Can be empty | ||||
thirdPartyId | No | String | Third-party ID associated with the identification. | Can be empty | ||||
isNewlyCreated | Yes | Boolean | Flag indicating if the identification row is newly created. | N/A | ||||
Country Object (Nested) |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
code | Yes | String | Country code (e.g., "US" for United States). | Should be a valid country code. | ||||
name | Yes | String | Name of the country (e.g., "United States of America"). | Should match the country name associated with the code. | ||||
|
|
|
|
| ||||
Identification Type Object (Nested) |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
code | Yes | String | Identification type code (e.g., "13" for Security Scorecard). | Should be a valid code for identification type. | ||||
name | Yes | String | Name of the identification type (e.g., "Security Scorecard"). | N/A | ||||
|
|
|
|
| ||||
Location IncoTerms Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
rows | Yes | Array of objects | List of rows related to Incoterms for location. | N/A | ||||
|
|
|
|
| ||||
IncoTerms Row Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
id | Yes | String | Unique ID for the Incoterms row. | N/A | ||||
isDeleted | Yes | Boolean | Flag indicating if the Incoterms entry is deleted. | N/A | ||||
isNewlyCreated | Yes | Boolean | Flag indicating if the Incoterms entry is newly created. | N/A | ||||
division | Yes | String | Division associated with the Incoterms. | N/A | ||||
description | Yes | String | Detailed description of the Incoterms. | N/A | ||||
incoTerms | Yes | Object | Incoterms information (name and code). | N/A | ||||
businessUnits | Yes | Array of objects | List of business units associated with the Incoterms row. | N/A | ||||
|
|
|
|
| ||||
IncoTerms Object (Nested) |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
name | Yes | String | Name of the Incoterms (e.g., "Carriage & Insurance Paid To Incoterms 2020"). | N/A | ||||
code | Yes | String | Code representing the Incoterms (e.g., "CIP"). | Should be a valid Incoterms code. | ||||
|
|
|
|
| ||||
Business Units Object (Nested) |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
entityDetailCode | Yes | Integer | Code for the entity detail associated with the business unit. | Should be an integer. | ||||
entityName | Yes | String | Name of the entity (e.g., "Organization"). | N/A | ||||
entityType | Yes | String | Type of the entity (e.g., "Organization"). | N/A | ||||
entityCode | Yes | String | Code for the entity (e.g., "Organization"). | N/A | ||||
entityDetailDescription | Yes | String | Description of the entity detail (e.g., "Organization"). | N/A | ||||
parentEntityDetailCode | Yes | Integer | Parent entity detail code. | N/A | ||||
parentEntity | No | String | Parent entity name. | Can be empty. | ||||
parentEntityCode | No | String | Parent entity code. | Can be empty. | ||||
gepId | Yes | String | Unique GEP ID associated with the entity. | N/A | ||||
lobName | Yes | String | Name of the line of business (e.g., "Default"). | N/A | ||||
lobCode | Yes | String | Code for the line of business (e.g., "DF"). | N/A | ||||
isDefault | Yes | Boolean | Flag indicating if this business unit is default. | N/A | ||||
level | Yes | Integer | Level of the business unit (e.g., 1). | N/A | ||||
childCount | Yes | Integer | Number of child units under this business unit. | N/A | ||||
displayName | Yes | String | Display name of the business unit (e.g., "Organization"). | N/A | ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
Default Banking Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
locationName | No | String | Name of the location for banking info. | Can be an empty string. | ||||
locationId | No | String | Unique ID for the location. | Can be an empty string. | ||||
clientBankingCode | No | String | Code identifying the client's banking info. | Can be an empty string. | ||||
bankingDetails | No | String | Detailed information about the banking. | Can be an empty string. | ||||
bankingId | No | String | Unique ID for the banking entry. | Can be an empty string. | ||||
|
|
|
|
| ||||
Credit Banking Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
locationName | No | String | Name of the location for banking info. | Can be an empty string. | ||||
locationId | No | String | Unique ID for the location. | Can be an empty string. | ||||
clientBankingCode | No | String | Code identifying the client's banking info. | Can be an | ||||
|
|
|
|
| ||||
Banking Information Details |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
isDeleted | No | Boolean | Indicates if the banking information is deleted. | Must be a boolean value (true/false). | ||||
root_id | Yes | String (GUID) | Unique identifier for the root object. | Must be a valid GUID format. | ||||
parent_id | Yes | String (GUID) | Unique identifier for the parent object. | Must be a valid GUID format. | ||||
rows | Yes | Array | List of banking information rows. | Must contain at least one row. | ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
Banking Information Row |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
id | Yes | String (GUID) | Unique identifier for the banking information. | Must be a valid GUID format. | ||||
sections | Yes | Object | Contains details about banking information, beneficiary address, and intermediary address. | Must include bankingInformation, beneficiaryAddress, and intermediaryAddress objects. | ||||
bankingInformation | Yes | Object | Detailed banking information including ABA, bank account number, SWIFT code, etc. | Must include valid ABA bank key, bank account number, and SWIFT/BIC codes. | ||||
beneficiaryName | Yes | String | Name of the beneficiary. | Cannot be empty. | ||||
clientBankReferenceId | Yes | String | Client's bank reference ID. | Cannot be empty. | ||||
country | Yes | Object | Country where the banking information is located. | Must include code (2-letter country code) and name of the country. | ||||
airwallexLinkStatus | Yes | Object | Status of the bank link with Airwallex. | Must contain code and name fields. | ||||
beneficiaryAddress | Yes | Object | Address of the beneficiary. | Must contain addressline1, city, zipPostalcode, and valid country. | ||||
intermediaryAddress | No | Array (Object) | List of intermediary addresses. | Can contain multiple intermediary addresses, each must have addressline1, city, zipPostalcode, and valid country. | ||||
isDeleted | No | Boolean | Marks if the banking information is deleted. | Should be a boolean (true/false). | ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
Beneficiary Address Validation |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
addressline1 | Yes | String | The first line of the address. | Cannot be empty. | ||||
addressline2 | No | String | The second line of the address. | Can be empty. | ||||
city | Yes | String | The city of the beneficiary. | Cannot be empty. | ||||
zipPostalcode | Yes | String | Zip or postal code. | Must be a valid postal code format. | ||||
country | Yes | Object | Country of the beneficiary. | Must have code (2-letter country code) and name. | ||||
state | Yes | Object | State or province. | Must have code and name. | ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
Intermediary Address Validation |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
addressline1 | Yes | String | The first line of the address. | Cannot be empty. | ||||
addressline2 | No | String | The second line of the address. | Can be empty. | ||||
city | Yes | String | The city of the intermediary. | Cannot be empty. | ||||
zipPostalcode | Yes | String | Zip or postal code. | Must be a valid postal code format. | ||||
country | Yes | Object | Country of the intermediary. | Must have code (2-letter country code) and name. | ||||
state | Yes | String | State or province. | Cannot be empty. | ||||
|
|
|
|
| ||||
Payment Term Object Breakdown |
|
|
|
| ||||
rows (Array of Rows) |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
businessUnits | Yes | Array of Objects | List of business units associated with the payment term. | Must contain at least one business unit object. | ||||
paymentTerms | Yes | Array of Objects | List of payment terms applicable to the row. | Must contain at least one payment term object. | ||||
paymentTermsId | Yes | String | Unique identifier for the payment terms. | Must be a valid identifier. | ||||
partnerCode | Yes | String (GUID) | Partner unique identifier. | Must be a valid GUID format. | ||||
rowAuditFields | Yes | Object | Audit details for the row. | Must contain createdDate and updatedDate as valid ISO 8601 dates. | ||||
isDeleted | No | Boolean | Indicates if the row is deleted. | Must be a boolean value (true/false). | ||||
id | Yes | String (GUID) | Unique identifier for the row. | Must be a valid GUID format. | ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
Business Unit Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
entityDetailCode | Yes | Integer | Code for the entity detail. | Must be a valid integer code. | ||||
entityName | Yes | String | Name of the entity. | Cannot be empty. | ||||
entityType | Yes | String | Type of the entity (e.g., SMART). | Cannot be empty. | ||||
entityCode | Yes | String | Code for the entity. | Cannot be empty. | ||||
entityDetailDescription | Yes | String | Description of the entity. | Cannot be empty. | ||||
parentEntityDetailCode | Yes | Integer | Code for the parent entity. | Must be a valid integer. | ||||
parentEntity | Yes | String | Name of the parent entity. | Cannot be empty. | ||||
parentEntityCode | Yes | String | Code for the parent entity. | Cannot be empty. | ||||
gepId | Yes | String (GUID) | Global entity ID. | Must be a valid GUID format. | ||||
lobName | Yes | String | Name of the Line of Business (LOB). | Cannot be empty. | ||||
lobCode | Yes | String | Code for the LOB. | Cannot be empty. | ||||
isDefault | Yes | Boolean | Indicates if the business unit is the default one. | Must be a boolean value (true/false). | ||||
level | Yes | Integer | Level of the business unit within the hierarchy. | Must be an integer. | ||||
childCount | Yes | Integer | Number of child entities under the business unit. | Must be a non-negative integer. | ||||
displayName | Yes | String | Display name for the business unit. | Cannot be empty. | ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
Payment Term Object |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
paymentTermCode | Yes | String | Unique code for the payment term. | Must be non-empty. | ||||
lob | Yes | String | Line of business associated with the payment term. | Must be ALL or a valid LOB code. | ||||
orgEntityDetailCode | Yes | String | Organization entity detail code associated with the payment term. | Must be `ALL | ||||
paymentTermName | Yes | String | Name of the payment term. | Cannot be empty. | ||||
description | Yes | String | Description of the payment term. | Cannot be empty. | ||||
dueDays | Yes | Integer | Number of days after the invoice when payment is due. | Must be a positive integer. | ||||
discountPercentage | No | Integer | Discount percentage for early payment. | Must be between 0 and 100. | ||||
discountDays | No | Integer | Days within which the discount is applicable. | Must be a positive integer. | ||||
markAsDefault | No | Boolean | Indicates if this payment term is the default one. | Must be a boolean value (true/false). | ||||
isActive | Yes | Boolean | Indicates if the payment term is active. | Must be a boolean value (true/false). | ||||
isPrimary | No | Boolean | Indicates if the payment term is the primary one. | Must be a boolean value (true/false). | ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
Audit Fields |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
createdDate | Yes | String (Date) | Date when the row was created. | Must be a valid ISO 8601 date. | ||||
updatedDate | Yes | String (Date) | Date when the row was last updated. | Must be a valid ISO 8601 date. | ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
Onboarding Approval Information |
|
|
|
| ||||
Column1 | Column2 | Column3 | Column4 | Column5 | ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
isOnboardingApproved | Yes | Boolean | Indicates if the onboarding process has been approved. | Must be a boolean value (true/false). | ||||
approvalStatus | Yes | Object | Contains the approval status details. | Must include name and code fields. | ||||
|
|
|
|
| ||||
Basic Details |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
doingBusinessAs | Yes | String | The name the business operates under | Must be a valid identifier for business | ||||
legalCompanyName | Yes | String | The official legal name of the company | Must be a formal, registered company name | ||||
origination | Yes | String | The source or origin of the supplier | Must be a predefined value (e.g., GEP) | ||||
normalisedName | Yes | String | A normalized version of the company name | Can be used for internal references, usually a standard format | ||||
uniqueIdentificationNumber | No | String | A unique identifier for the company, often tax ID or registration number | Can be empty if not applicable | ||||
isUINUpdated | No | Boolean | Flag to indicate if the unique ID has been updated | False by default; if true, UIN must be updated | ||||
domainName | No | String | The domain name of the company, if applicable | Optional for non-web-based suppliers | ||||
formerlyKnownAs | No | String | Previous names the company may have operated under | Optional; can be empty | ||||
supplierCreatedOn | Yes | DateTime | The timestamp when the supplier record was created | Must be a valid DateTime | ||||
sustainabilityScore | No | Integer | The sustainability score of the supplier | Range from 0-100, can be empty if not applicable | ||||
isManagedFlag | No | Boolean | Flag indicating whether the supplier is managed | Defaults to false | ||||
isRnDFlag | No | Boolean | Flag indicating whether the supplier is in research & development | Defaults to false | ||||
isManaged | No | String | The current management status of the supplier | Values: "Not Set", "Managed", "Not Managed" | ||||
lastTriggerDate | Yes | DateTime | The timestamp of the last event triggering an action | Must be a valid DateTime | ||||
isDiversity | No | String | Indicates whether the supplier is categorized as diverse | Values: "Yes", "No" | ||||
regions | Yes | Array of Objects | List of regions where the supplier operates or is registered | Each region must include id, name, parentDetails (sub-object) | ||||
categories | Yes | Array of Objects | Categories under which the supplier is classified | Each category must include id, name, and clientCode | ||||
partnerStatus | Yes | Object | The current status of the partnership | Must include name and code, e.g., "Invited" and "1" | ||||
onboardingApprovalInfo | Yes | Object | Information about the supplier’s onboarding approval status | Includes isOnboardingApproved and approvalStatus (sub-objects) | ||||
previousPartnerStatus | No | Object | Status of the partner before the current one | Optional, contains name and code | ||||
supplierLevel | Yes | Array of Objects | Supplier level classification (e.g., Unit, Group) | Each entry must include code and name | ||||
supplierScope | No | Object | The scope of the supplier’s offering or involvement | Can be empty, contains name, code, and codeType | ||||
uniqueIdentificationNumberStatus | No | Object | The current status of the UIN | Contains name and code (sub-object) | ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
Sub-objects |
|
|
|
| ||||
|
|
|
|
| ||||
1. regions (Array of Objects) |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
Column1 | Column2 | Column3 | Column4 | Column5 | ||||
id | Yes | String | Unique identifier for the region | Must be a valid ID | ||||
code | Yes | String | Code for the region | Must be a valid region code | ||||
name | Yes | String | Name of the region | Must be a valid region name | ||||
parentDetails (Array of Objects) | Yes | Array of Objects | Details about the parent region or hierarchy | Each entry contains name and level sub-properties | ||||
name | Yes | String | Name of the parent region | | |
|
|
|
| ||||
level | Yes | Integer | Level in the hierarchy (e.g., 1 for top-level region) | Must be a valid integer indicating the region's hierarchy level | |
|
|
|
| ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
2. categories (Array of Objects) |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
id | Yes | Integer | Category ID | Must be a valid unique category identifier | ||||
name | Yes | String | Name of the category | Must be a valid category name | ||||
clientCode | Yes | String | Client-specific code for the category | Must be a valid code | ||||
parentDetails (Array of Objects) | No | Array of Objects | Parent category details, if applicable | Optional; each entry contains parentId, parentName | ||||
parentId | Yes | Integer | ID of the parent categor |
| ||||
parentName | Yes | String | Name of the parent categor |
| ||||
parentName | Yes | String | Name of the parent category | | |
|
|
|
| ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
3. partnerStatus (Object) |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
name | Yes | String | Name of the partner status (e.g., "Invited") | Must be a valid status name | ||||
code | Yes | String | Code for the partner status (e.g., "1") | Must be a valid code for the status | ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
5. supplierScope (Object) |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
name | Yes | String | The name of the scope for the supplier | Must be a valid name | ||||
code | Yes | String | Code representing the scope | Must be a valid code | ||||
codeType | Yes | String | Type of the scope code (e.g., internal, external) | Must be a valid scope code type | ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
6. uniqueIdentificationNumberStatus (Object) |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
name | Yes | String | Name of the status of the unique ID | Must be a valid status name | ||||
code | Yes | String | Code representing the status of the unique ID | Must be a valid code | ||||
|
|
|
|
| ||||
Identification |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
rows | Yes | Array of Objects | List of identification details for the supplier | Each object in the array must include identification-related details | ||||
|
|
|
|
| ||||
Sub-Object: rows |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
identificationNumber | Yes | String | The identification number for the supplier | Must be a valid number, format dependent on country | ||||
attachment | No | Array of Objects | Attachments associated with the identification | Can be empty or contain file attachments | ||||
identificationnumberEncrypt | Yes | String | Flag indicating whether the identification number is encrypted | Must be "true" or "false" | ||||
id | Yes | String | Unique identifier for the identification row | Must be a valid unique identifier | ||||
country | Yes | Object | Country details associated with the identification | Contains code (country code) and name (country name) | ||||
identificationType | Yes | Object | Type of identification (e.g., "Security Scorecard") | Contains code and name for type | ||||
isDeleted | Yes | Boolean | Flag indicating whether the identification is marked as deleted | Must be a boolean (true or false) | ||||
identificationkey | No | String | Key for the identification, if available | Optional, can be empty | ||||
thirdPartyId | No | String | Third-party identifier, if applicable | Optional, can be empty | ||||
isIdentificationUpdated | No | Boolean | Flag indicating if the identification has been updated | Defaults to false | ||||
rowAuditFields | Yes | Object | Contains audit fields for creation and update timestamps | Contains createdDate and updatedDate (DateTime fields) | ||||
isNewlyCreated | Yes | Boolean | Flag indicating whether the row is newly created | Must be a boolean (true or false) | ||||
|
|
|
|
| ||||
Sub-Object: country |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
code | Yes | String | Country code (e.g., "US") | Must be a valid country code | ||||
name | Yes | String | Country name (e.g., "United States of America") | Must be a valid country name | ||||
|
|
|
|
| ||||
Sub-Object: identificationType |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
code | Yes | String | Code for the identification type (e.g., "13") | Must be a valid identification type code | ||||
name | Yes | String | Name of the identification type (e.g., "Security Scorecard") | Must be a valid identification type name | ||||
|
|
|
|
| ||||
Sub-Object: rowAuditFields |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
createdDate | Yes | DateTime | The timestamp when the identification row was created | Must be a valid DateTime format (e.g., ISO 8601) | ||||
updatedDate | Yes | DateTime | The timestamp when the identification row was last updated | Must be a valid DateTime format (e.g., ISO 8601) | ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
TransactionTypeDetails |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
widgetId | Yes | String | Unique identifier for the widget | Must be a valid unique widget ID | ||||
onboardingApprovalInfo | Yes | Object | Contains onboarding approval status and details | Contains isOnboardingApproved and approvalStatus (sub-objects) | ||||
contractFormat | Yes | Object | Contract format details | Contains name and code (sub-objects) | ||||
servConfFormat | Yes | Object | Service configuration format details | Contains name and code (sub-objects) | ||||
rFXFormat | Yes | Object | RFx (request for quotation) format details | Contains name and code (sub-objects) | ||||
pOFormat | Yes | Object | Purchase order format details | Contains name and code (sub-objects) | ||||
auctionFormat | Yes | Object | Auction format details | Contains name and code (sub-objects) | ||||
invoiceFormat | Yes | Object | Invoice format details | Contains name and code (sub-objects) | ||||
|
|
|
|
| ||||
Sub-Object: contractFormat, servConfFormat, rFXFormat, pOFormat, auctionFormat, invoiceFormat (Identical structure for each) |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
name | Yes | String | Name of the format | Must be a valid name | ||||
code | Yes | String | Code for the format | Must be a valid code | ||||
|
|
|
|
| ||||
SupplierSourceInfo |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
rows | Yes | Array of Objects | List of supplier source information | Each object in the array must include source-related details | ||||
|
|
|
|
| ||||
Sub-Object: rows |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
createdInErp | No | String | Information about the ERP system where the source was created | Optional, can be empty | ||||
code | Yes | Integer | Source code (e.g., 1) | Must be a valid integer value | ||||
id | Yes | String | Unique identifier for the source row | Must be a valid unique identifier | ||||
name | Yes | String | Name of the source (e.g., "Client Supplier Code") | Must be a valid name | ||||
sourceIdentificationNo | Yes | String | Supplier's source identification number | Must be a valid unique identification number | ||||
updatedDate | Yes | DateTime | Timestamp for when the source information was last updated | Must be a valid DateTime format (e.g., ISO 8601) | ||||
createdDate | Yes | DateTime | Timestamp for when the source information was created | Must be a valid DateTime format (e.g., ISO 8601) | ||||
interfaceComments | No | String | Additional comments for the interface | Optional, can be empty | ||||
isInterfaced | Yes | Boolean | Flag indicating if the source is interfaced with the system | Must be a boolean (true or false) | ||||
isDeleted | Yes | Boolean | Flag indicating if the source is marked as deleted | Must be a boolean (true or false) | ||||
interfaceStatus | Yes | Object | Contains status details for interfacing | Contains name and code (sub-objects) | ||||
|
|
|
|
| ||||
Sub-Object: interfaceStatus |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
name | No | String | Name of the interface status | Optional, can be empty | ||||
code | No | String | Code representing the interface status | Optional, can be empty | ||||
Onboarding |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
rows | Yes | Array of Objects | List of onboarding information | Each object in the array must include relevant onboarding details | ||||
defaultOnboardingType | Yes | Object | Default onboarding type | Contains name and code | ||||
|
|
|
|
| ||||
Sub-Object: rows |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
formCode | No | String | Code for the form submitted | Optional, can be empty | ||||
formName | No | String | Name of the form | Optional, can be empty | ||||
formResponseSubmittedBy | No | String | User who submitted the form response | Optional, can be empty | ||||
formSubmissionUserType | No | String | Type of user submitting the form response | Optional, can be empty | ||||
isInvitePrimaryContact | No | Boolean | Whether the primary contact is invited | Must be a boolean (true or false) | ||||
isTriggerRelationship | No | Boolean | Whether a relationship trigger is active | Must be a boolean (true or false) | ||||
transactionFormCode | No | String | Transaction form code | Optional, can be empty | ||||
transactionFormCodes | No | Array of String | List of transaction form codes | Optional, can be empty | ||||
formResponseSubmissionDate | Yes | DateTime | Timestamp for when the form response was submitted | Must be a valid DateTime format (e.g., ISO 8601) | ||||
lastRefreshDate | Yes | DateTime | Timestamp for when the form was last refreshed | Must be a valid DateTime format (e.g., ISO 8601) | ||||
id | Yes | String | Unique identifier for the onboarding row | Must be a valid unique identifier | ||||
categories | Yes | Array of Objects | List of categories related to the onboarding form | Each object in the array must include relevant category details | ||||
onboardingRelationshipInfo | Yes | Object | Contains relationship-specific onboarding information | Contains multiple properties and sub-objects | ||||
businessUnits | Yes | Array of Objects | List of business units for the onboarding | Each object in the array must include relevant business unit details | ||||
regions | Yes | Array of Objects | List of regions associated with the onboarding | Each object in the array must include relevant region details | ||||
overallStatus | Yes | Object | Overall status of the onboarding | Contains name, code, and translationCode | ||||
usageType | Yes | Object | Information about the usage type | Contains usageTypeId and usageTypeName | ||||
vendorType | Yes | Object | Information about the vendor type | Contains name and code | ||||
|
|
|
|
| ||||
Sub-Object: categories |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
childCount | Yes | Integer | Number of child categories | Must be a valid integer | ||||
clientCode | No | String | Client-specific code for the category | Optional, can be empty | ||||
displayName | No | String | Display name of the category | Optional, can be empty | ||||
isDefault | Yes | Boolean | Whether the category is the default category | Must be a boolean (true or false) | ||||
level | Yes | Integer | Level of the category (0 for root) | Must be a valid integer | ||||
name | No | String | Name of the category | Optional, can be empty | ||||
id | Yes | Integer | Unique identifier for the category | Must be a valid unique identifier | ||||
parentId | Yes | Integer | ID of the parent category | Must be a valid integer | ||||
parentDetails | Yes | Array of Objects | Parent details for the category | Each object must include id, name, and level properties | ||||
|
|
|
|
| ||||
Sub-Object: onboardingRelationshipInfo |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
isRelationshipApproved | Yes | Boolean | Whether the relationship is approved | Must be a boolean (true or false) | ||||
isMailSentForExpiry | Yes | Boolean | Whether a mail has been sent for expiry | Must be a boolean (true or false) | ||||
approvers | No | String | Approvers' names | Optional, can be empty | ||||
approversFullName | No | String | Full names of the approvers | Optional, can be empty | ||||
autoCalculatedOverallStatus | Yes | Boolean | Whether the overall status is auto-calculated | Must be a boolean (true or false) | ||||
finalActionTakenUsername | No | String | Username of the person who took the final action | Optional, can be empty | ||||
instanceid | No | String | Instance ID for the relationship | Optional, can be empty | ||||
isActive | Yes | Boolean | Whether the onboarding relationship is active | Must be a boolean (true or false) | ||||
isFormTriggered | Yes | Boolean | Whether the form is triggered for onboarding | Must be a boolean (true or false) | ||||
isOnboardingSentBack | Yes | Boolean | Whether the onboarding has been sent back | Must be a boolean (true or false) | ||||
|
|
|
|
| ||||
Sub-Object: overallStatus |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
name | No | String | Name of the overall status | Optional, can be empty | ||||
code | No | String | Code representing the overall status | Optional, can be empty | ||||
translationCode | No | String | Translation code for the status | Optional, can be empty | ||||
|
|
|
|
| ||||
Sub-Object: usageType |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
usageTypeId | Yes | Integer | ID of the usage type | Must be a valid integer | ||||
usageTypeName | Yes | String | Name of the usage type | Must be a valid string | ||||
|
|
|
|
| ||||
Sub-Object: vendorType |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
name | No | String | Name of the vendor type | Optional, can be empty | ||||
code | No | String | Code representing the vendor type | Optional, can be empty | ||||
|
|
|
|
| ||||
Team Member |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
rows | Yes | Array of Objects | List of team members associated with the relationship | Each object in the array must contain relevant team member details | ||||
|
|
|
|
| ||||
Sub-Object: rows |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
id | Yes | String | Unique identifier for the team member | Must be a valid unique identifier | ||||
teamMemberId | No | String | Team member ID | Optional, can be empty | ||||
createdBy | No | String | User who created the team member record | Optional, can be empty | ||||
contactCode | Yes | String | Contact code for the team member | Must be a valid string | ||||
stakeholderName | Yes | String | Name of the stakeholder | Must be a valid string | ||||
emailAddress | Yes | String | Email address of the team member | Must be a valid email address | ||||
roleId | Yes | String | ID representing the role of the team member | Must be a valid role ID | ||||
roleName | Yes | String | Name of the role of the team member | Must be a valid role name | ||||
businessUnits | No | Array of Objects | List of business units associated with the team member | Optional, can be empty | ||||
isRowDisabled | Yes | Boolean | Whether the team member row is disabled | Must be a boolean (true or false) | ||||
isDeleted | Yes | Boolean | Whether the team member record is deleted | Must be a boolean (true or false) | ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
RelationshipInfo |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
businessCriticality | Yes | Object | Business criticality information | Contains name and code | ||||
vendorType | No | Object | Vendor type information | Contains name and code | ||||
relationshipType | Yes | Object | Type of the relationship | Contains name and code | ||||
supplierRiskType | Yes | Object | Risk type of the supplier | Contains name and code | ||||
matchingType | Yes | Object | Matching type for the relationship | Contains name and code | ||||
sourceType | No | Object | Source type of the relationship | Contains name and code | ||||
|
|
|
|
| ||||
Sub-Object: businessCriticality |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
name | Yes | String | Name of the business criticality | Must be a valid string | ||||
code | Yes | String | Code representing the business criticality | Must be a valid string | ||||
|
|
|
|
| ||||
Sub-Object: vendorType |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
name | No | String | Name of the vendor type | Optional, can be empty | ||||
code | No | String | Code representing the vendor type | Optional, can be empty | ||||
|
|
|
|
| ||||
Sub-Object: relationshipType |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description | Validations / Exceptions | ||||
name | Yes | String | Name of the relationship type | Must be a valid string | ||||
code | Yes | String | Code representing the relationship type | Must be a valid string | ||||
Sub-Object: supplierRiskType |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
name | Yes | String | Name of the supplier risk type |
| ||||
code | Yes | String | Code representing the supplier risk type |
| ||||
|
|
|
|
| ||||
Sub-Object: matchingType |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
name | Yes | String | Name of the matching type |
| ||||
code | Yes | String | Code representing the matching type |
| ||||
|
|
|
|
| ||||
Sub-Object: sourceType |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
name | No | String | Name of the source type |
| ||||
code | No | String | Code representing the source type |
| ||||
|
|
|
|
| ||||
BusinessInfo |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
annualRevenue | Yes | Number | Annual revenue of the business |
| ||||
annualProfit | Yes | Number | Annual profit of the business |
| ||||
employees | Yes | Number | Number of employees in the business |
| ||||
website | Yes | String | Business website URL |
| ||||
facebookURL | No | String | Facebook URL of the business |
| ||||
linkedInURL | No | String | LinkedIn URL of the business |
| ||||
twitterURL | No | String | Twitter URL of the business |
| ||||
about | Yes | String | Information about the business |
| ||||
currentCustomers | No | String | Current customers details |
| ||||
widgetId | Yes | String | Unique identifier for the widget |
| ||||
autoAcknowledgeOrder | Yes | Boolean | Whether to auto acknowledge orders |
| ||||
isPCardSupported | Yes | Boolean | Whether the business supports PCard |
| ||||
isAllowCreateASN | Yes | Boolean | Whether ASN creation is allowed |
| ||||
isAllowAutoReceiving | Yes | Boolean | Whether auto receiving is allowed |
| ||||
isERSEnabled | Yes | Boolean | Whether ERS is enabled |
| ||||
dateOfIncorporation | Yes | Date | Date of business incorporation |
| ||||
amount | No | String | Amount details for the business |
| ||||
commercialOffering | No | String | Details about the commercial offering |
| ||||
clients | No | String | Details about business clients |
| ||||
onboardingApprovalInfo | Yes | Object | Information related to onboarding approval |
| ||||
paymentType | No | Object | Payment type information |
| ||||
languageDetails | Yes | Array of Objects | List of language details |
| ||||
multiselectcurrency | No | Array | List of multiple selected currencies |
| ||||
businessType | No | Object | Business type information |
| ||||
currency | Yes | Object | Currency information |
| ||||
testBusinessInfoDemoAttachment | No | Array | Attachments related to business demo info |
| ||||
fOnBoard | No | Object | Onboarding information |
| ||||
prepaidFrieght | No | Object | Prepaid freight information |
| ||||
shippingMethod | No | Object | Shipping method information |
| ||||
taxIndicator | No | Object | Tax indicator information |
| ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
Sub-Object: paymentType |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
name | No | String | Name of the payment type |
| ||||
code | No | String | Code representing the payment type |
| ||||
|
|
|
|
| ||||
Sub-Object: languageDetails |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
code | Yes | String | Language code |
| ||||
displayName | Yes | String | Display name of the language |
| ||||
|
|
|
|
| ||||
Sub-Object: businessType |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
name | No | String | Name of the business type |
| ||||
code | No | String | Code representing the business type |
| ||||
|
|
|
|
| ||||
Sub-Object: currency |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
name | Yes | String | Name of the currency |
| ||||
code | Yes | String | Currency code |
| ||||
|
|
|
|
| ||||
Sub-Object: fOnBoard |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
name | No | String | Name of the onboarding type |
| ||||
code | No | String | Code representing the onboarding type |
| ||||
|
|
|
|
| ||||
Sub-Object: prepaidFrieght |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
name | No | String | Name of the prepaid freight type |
| ||||
code | No | String | Code representing the prepaid freight type |
| ||||
|
|
|
|
| ||||
Sub-Object: shippingMethod |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
name | No | String | Name of the shipping method |
| ||||
code | No | String | Code representing the shipping method |
| ||||
|
|
|
|
| ||||
Sub-Object: taxIndicator |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
name | No | String | Name of the tax indicator |
| ||||
code | No | String | Code representing the tax indicator |
| ||||
|
|
|
|
| ||||
Attachments |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
root_id | Yes | String | Root ID of the attachment |
| ||||
parent_id | Yes | String | Parent ID of the attachment |
| ||||
rows | Yes | Array | List of attachment rows |
| ||||
referenceMetaData | Yes | Object | Metadata related to the attachment |
| ||||
auditFields | Yes | Object | Fields related to audit logs |
| ||||
|
|
|
|
| ||||
Sub-Object: rows |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
isDeleted | Yes | Boolean | Flag indicating whether the attachment is deleted |
| ||||
isNewlyCreated | Yes | Boolean | Flag indicating whether the attachment is newly created |
| ||||
isFormsAttachment | Yes | Boolean | Flag indicating whether the attachment is related to a form |
| ||||
createdBy | Yes | String | User ID of the person who created the attachment |
| ||||
fileId | Yes | String | Unique identifier for the attachment file |
| ||||
fileName | Yes | String | Name of the attachment file |
| ||||
fileSize | Yes | Number | Size of the file in bytes |
| ||||
fileSizeInKB | Yes | Number | Size of the file in kilobytes |
| ||||
id | Yes | String | Unique identifier for the row |
| ||||
uploadedBy | Yes | String | Name of the person who uploaded the attachment |
| ||||
visibility | Yes | String | Visibility of the attachment (e.g., Public, Private) |
| ||||
classification | Yes | Object | Classification of the attachment |
| ||||
uploadedOn | Yes | Date | Date when the attachment was uploaded |
| ||||
|
|
|
|
| ||||
Sub-Object: classification |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
code | Yes | String | Classification code for the attachment |
| ||||
name | Yes | String | Classification name for the attachment |
| ||||
|
|
|
|
| ||||
Sub-Object: referenceMetaData |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
partnerCode | Yes | String | Partner code associated with the attachment |
| ||||
isChangeRequest | Yes | Boolean | Flag indicating whether this is a change request |
| ||||
isDraft | Yes | Boolean | Flag indicating whether this is a draft |
| ||||
draftId | No | String | Draft ID if applicable |
| ||||
isDeleted | Yes | Boolean | Flag indicating whether the attachment is deleted |
| ||||
draftContactCode | No | String | Draft contact code if applicable |
| ||||
changeRequestVersionId | No | String | Version ID of the change request |
| ||||
isSupplierRequest | Yes | Boolean | Flag indicating whether this is a supplier request |
| ||||
|
|
|
|
| ||||
Sub-Object: auditFields |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
createdBy | Yes | String | User ID of the person who created the attachment |
| ||||
createdDateTime | Yes | Date | Date when the attachment was created |
| ||||
modifiedBy | Yes | String | User ID of the person who last modified the attachment |
| ||||
modifiedDateTime | Yes | Date | Date when the attachment was last modified |
| ||||
Main Table (Contact Information) |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
root_id | Yes | String | Root identifier for the contact information. |
| ||||
parent_id | Yes | String | Parent identifier for contact information. |
| ||||
isDeleted | Yes | Boolean | Flag indicating whether the contact information is deleted. |
| ||||
|
|
|
|
| ||||
2. Contacts |
|
|
|
| ||||
|
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
contactCode | Yes | String | Unique identifier for the contact. |
| ||||
id | Yes | String | Identifier for the contact. |
| ||||
contactMappingId | Yes | String | ID that links the contact to its mapping. |
| ||||
forwardedByContactCode | Yes | String | Contact code of the person who forwarded this contact (if applicable). |
| ||||
forwardedByContactEmailId | Yes | String | Email ID of the person who forwarded this contact (if applicable). |
| ||||
isDeleted | Yes | Boolean | Flag to indicate if the contact is deleted. |
| ||||
isAICreatedContact | Yes | Boolean | Whether the contact was created by AI. |
| ||||
|
|
|
|
| ||||
3. Contact State Table |
|
|
|
| ||||
|
|
|
|
| ||||
Stores the status and details for each contact (e.g., first name, last name, email, etc.). |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required | Data Type | Description |
| ||||
contactCode | Yes | String | Unique identifier for the contact. |
| ||||
emailId | Yes | String | Email address of the contact. |
| ||||
firstName | Yes | String | First name of the contact. |
| ||||
lastName | Yes | String | Last name of the contact. |
| ||||
statusCode.name | Yes | String | The status of the contact (e.g., "Invited"). |
| ||||
statusCode.code | Yes | String | Status code associated with the contact. |
| ||||
timezone.name | Yes | String | The time zone of the contact. |
| ||||
timezone.code | Yes | String | Time zone code associated with the contact. |
| ||||
language.name | Yes | String | Language name used by the contact. |
| ||||
language.code | Yes | String | Language code used by the contact. |
| ||||
|
|
|
|
| ||||
4. Row Audit Table |
|
|
|
| ||||
|
|
|
|
| ||||
Tracks the creation, update, and deletion details of the contact record. |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
createdBy | Yes | String | User who created the record. |
| ||||
createdDate | No | DateTime | The date and time when the record was created. |
| ||||
updatedBy | No | String | User who last updated the record. |
| ||||
updatedDate | No | DateTime | The date and time when the record was last updated. |
| ||||
deletedDate | No | DateTime | The date and time when the record was deleted. |
| ||||
Primary Contact Info |
|
|
|
| ||||
|
|
|
|
| ||||
This table holds the basic details about the primary contact. |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required | Data Type | Description |
| ||||
firstName | Yes | String | First name of the primary contact. |
| ||||
lastName | Yes | String | Last name of the primary contact. |
| ||||
emailId | Yes | String | Email ID of the primary contact. |
| ||||
primaryPhoneNumber | No | String | Primary phone number of the contact. |
| ||||
primaryPhoneExtension | No | String | Primary phone extension. |
| ||||
isFollower | Yes | Boolean | Flag to indicate if the contact is a follower. |
| ||||
isInvite | Yes | Boolean | Flag to indicate if the contact was invited. |
| ||||
contactCode | Yes | String | Unique code for the contact. |
| ||||
clientContactCode | Yes | String | Client-specific code for the contact. |
| ||||
primaryContactLanguage.code | No | String | Language code for the contact. |
| ||||
primaryContactLanguage.displayName | No | String | Display name of the language. |
| ||||
timezone.name | No | String | Name of the timezone. |
| ||||
timezone.code | No | String | Code for the timezone (e.g., PST). |
| ||||
Contact Mapping |
|
|
|
| ||||
|
|
|
|
| ||||
This table stores mapping information about contacts, including roles, categories, business units, regions, and personas. |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required | Data Type | Description |
| ||||
clientContactCode | Yes | String | Client contact code. |
| ||||
contactCode | Yes | String | Unique code for the contact. |
| ||||
contactMappingCode | Yes | String | Unique mapping code for this contact. |
| ||||
isDeleted | Yes | Boolean | Flag to indicate if the mapping is deleted. |
| ||||
isNewlyCreated | Yes | Boolean | Flag to indicate if the contact mapping is newly created. |
| ||||
roleId | Yes | Integer | Role identifier for the contact. |
| ||||
roleName | Yes | String | Role name of the contact (e.g., Accounts Payable). |
| ||||
contactMappingId | Yes | String | Unique ID for the contact mapping. |
| ||||
smartContactCode | Yes | String | Code for the smart contact. |
| ||||
|
|
|
|
| ||||
Categories |
|
|
|
| ||||
|
|
|
|
| ||||
This table stores categories related to the contact mapping. |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Data Type | Description | Validations / Exceptions |
| ||||
contactMappingId | String | Foreign key to the contact mapping ID. | GUID format required |
| ||||
categoryId | Integer | Unique ID of the category. | Integer |
| ||||
categoryName | String | Name of the category (e.g., Drilling Services). | Non-empty string required |
| ||||
parentId | Integer | Parent category ID. | Integer or NULL |
| ||||
clientCode | String | Client-specific code for the category. | Alphanumeric format |
| ||||
isDefault | Boolean | Flag to indicate if it's the default category. | Boolean (true or false) |
| ||||
|
|
|
|
| ||||
Business Units |
|
|
|
| ||||
|
|
|
|
| ||||
This table stores information about business units related to contact mappings. |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Data Type | Description | Validations / Exceptions |
| ||||
contactMappingId | String | Foreign key to the contact mapping ID. | GUID format required |
| ||||
entityDetailCode | Integer | Unique code for the business unit entity. | Integer |
| ||||
entityName | String | Name of the entity (e.g., Organization). | Non-empty string required |
| ||||
entityType | String | Type of the entity (e.g., Organization). | Non-empty string required |
| ||||
entityCode | String | Code for the entity. | Alphanumeric format |
| ||||
gepId | String | GEP ID for the business unit. | GUID format required |
| ||||
lobName | String | Line of business name (e.g., Default). | Non-empty string required |
| ||||
lobCode | String | Line of business code (e.g., DF). | Non-empty string required |
| ||||
|
|
|
|
| ||||
Regions Table |
|
|
|
| ||||
|
|
|
|
| ||||
Stores information about regions related to the contact mapping. |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Data Type | Description | Validations / Exceptions |
| ||||
contactMappingId | String | Foreign key to the contact mapping ID. | GUID format required |
| ||||
regionId | Integer | Unique ID for the region. | Integer |
| ||||
regionCode | String | Code for the region (e.g., 370). | Non-empty string required |
| ||||
regionName | String | Name of the region (e.g., ANDORRA). | Non-empty string required |
| ||||
level | Integer | Region hierarchy level. | Integer |
| ||||
parentDetails | JSON | Parent regions' details. | JSON object with details about parent regions. |
| ||||
|
|
|
|
| ||||
Personas Table |
|
|
|
| ||||
|
|
|
|
| ||||
Stores information about personas assigned to the contact mapping. |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Required? | Data Type | Description |
| ||||
contactMappingId | Yes | String | Foreign key to the contact mapping ID. |
| ||||
personaCode | No | String | Persona code. |
| ||||
smartPersonaCode | No | String | Smart persona code. |
| ||||
personaName | No | String | Name of the persona. |
| ||||
relationshipCode | Yes | String | Code for the relationship type. |
| ||||
tradingPartnerCode | Yes | String | Code for the trading partner. |
| ||||
|
|
|
|
| ||||
Divisions Table |
|
|
|
| ||||
|
|
|
|
| ||||
Stores information about the divisions related to the contact mapping. |
|
|
|
| ||||
|
|
|
|
| ||||
Property Name | Data Type | Description | Validations / Exceptions |
| ||||
contactMappingId | String | Foreign key to the contact mapping ID. | GUID format required |
| ||||
divisionId | Integer | Unique ID for the division. | Integer |
| ||||
divisionName | String | Name of the division. | Optional |
| ||||