DownloadThe GetPartnerDetails Outbound API allows you to retrieve partner-related data from the system. It is designed to integrate with external services to fetch partner information using simple HTTP requests. This API supports three independent use cases, enabling retrieval of various partner details.
API Endpoint:
https://<Instance>/leoV2-supplier-composite-microservice/api/v1/PLSOutbound/GetPartnerDetails
{
"clientPartnerCode": "string",
"pageNumber": "1",
"pageSize": "1",
"filters": {
"partnerStatus": "string",
"overallStatus": "string",
"interfacedStatus": {
"isInterfaced": boolean,
"sourceSystemName": "string"
},
"partnerStatus": "string",
"overallStatus": "string"
}
}
{
"totalNoOfRecords": "integer",
"pageSize": "integer",
"pageNumber": "integer",
"getPartnerDetails": [
{
"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"
}
]
}
}
],
"statusCode": 200,
"errorDetails": [],
"bpc": "70022201"
}
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 |
|
|
|
|
|
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 |