SavePartnerCertificateDetails (POST)

Partner

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1

PartnerCode

Yes

String(100)

Note: Client Partner Code must be unique from the <CLIENT NAME> systems, so if there are duplicates within the service layer, the SSID will have to be appended to the Client Partner Code, and the resulting value will be ClientPartnerCode-SSID

• Partnercode is mandatory

• Max length for PartnerCode is 100

2

LegalCompanyName

Yes

String(100)

Legal company name of the partner

Note: LegalCompanyName will also have the SSID appended due to name search. 

Example: “Grainger | LL012”, “Grainger | JD001”, “Grainger | CP001”

• Legal Company Name is mandatory

• Max length for LegalCompanyName is 100

3

PartnerContact

Yes

List of PartnerContact object

An array of partner contacts

4

AutoAcknowledgeOrder

Yes

String

Auto Acknowledge Order of entity

• Invalid Auto Acknowledge Order

5

GEPPartnerCode

No

Long

Unique ID for this Partner in GEP systems

This field is available only on Outbound not on Inbound

6

DunAndBradNumber

No

String(20)

Dun & Brad number of the partner

• Max length for DunAndBradNumber is 20

• Allow only numeric value

7

Address

No

Address object

Address of partner’s head quarters

8

CompanyIdentification

No

String(30)

A string used to identify the partner

• Max length for CompanyIdentification is 30

9

YearOfEstablishment

No

Int

The year of establishment of the partner

10

ParentCompanyName

No

String(100)

Parent company of the partner if any

• Max length for ParentCompanyName is 100

11

CompanyWebsite

No

String(50)

Partner’s website

• Max length for CompanyWebsite is 50

12

IsActive

No

Boolean

Status of the partner if they are active or not

13

IsDeleted

No

Boolean

Status of the partner if they are to be visible or not, on the application

14

PartnerLocations

No

List of Location object

An array of locations where the partner operates

15

OtherIdentificationTypes

No

List of OtherIdentificationType object

Identification attribute to uniquely identify partner

16

DoingBusinessAs

No

String

Name with which the partner conducts the business

17

PartnerRelationshipTypeName

No

String

Name of Partner Relationship Type

• Invalid Relationship Type

18

ParentCompanyIdentificationType

No

String

Type of Parent Company Identification

19

GoodsAndServices

No

List of long

An array of categories in which the partner supplies goods or services

20

Categories

No

List of PAS object

Check Data Type PAS for details

21

Regions

No

List of string

An array of regions where the partner operates

22

PartnerManagers

No

List of string

An array of partner managers

23

BusinessUnits

No

List of string

An array of business units to which the partner is associated

24

ParentCompanyIdentificationValue

No

String

Value of Parent Company Identification

25

SupportsPCARD

No

Boolean

Boolean value whether partner supports PCARD or not

26

CurrenciesSupported

No

List of string

An array of currencies that are supported by the partner

27

PartnerStatus

No

String

Status of the partner on SMART platform

28

DiversityDetails

No

List of DiversityDetails object

An array of diversity details that are applicable to the partner

29

Certifications

No

List of Certificate object

An array of certificates that this partner has obtained

This field is available only on Outbound not on Inbound

30

AdditionalInformation

No

List of Question object

An array of questions and their responses, that are available in the partner profile

This field is available only on Outbound not on Inbound

Check Data Type Question for details

31

PaymentTerms

No

List of PaymentTerm object

An array of payment terms

This field is available only on Outbound not on Inbound

32

BlockingReason

No

List of string

An array of strings which denote reasons for blocking this partner

This field is available only on Outbound not on Inbound

33

SourceType

No

String

Source Type of entity

34

TransactionTypes

No

List of Transationtype object

Check Data Type Transationtype for details

35

MatchType

No

String

Match Type of entity

36

NormalizedName

No

String(256)

Normalized name of the partner

• Max length is 256

37

SourceSystemDetails

No

List of SourceSystemDetails object

An array of strings that contain information on source systems of partner data

38

EngagementType

No

List of string

Engagement Type of entity

39

IsAllLocationORGMapped

No

Boolean

40

IsPreferredSupplier

No

Boolean

41

LanguagesSupported

No

List of Language object

Check Data Type Language for details

42

ShippingDetails

No

List of ShippingDetails object

Check Data Type ShippingDetails for details

43

OrgEntities

No

List of OrgEntity object

Check data type OrgEntity for details

44

CurrencyOrgMapping

No

 List of Currency object

Check Data Type Currency for details

45

SourceSystemName

No

String

Source System Name of entity

46

DateModified

No

DateTime

Date Modified for partner

47

PaymentType

No

String

Payment Type of entity

• Invalid Payment Type

48

IsAllowCreateASN

No

Boolean

49

AverageProfit

No

Double

Average Profit

50

TotalEmployees

No

Long

Total Employees of partner

51

PartnerRiskTypeName

No

String

Name of Partner Risk Type

52

SupplierApprovers

No

List of String

Supplier Approvers

53

FormerlyKnownAs

No

List of FormerlyKnownAs object

Check Data Type FormerlyKnownAs for details

54

BusinessCriticalityName

No

String

55

PartnerStatusHistory

No

String

Partner Status History

56

BusinessType

No

String

Business Type

Address

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

7.1

AddressLine1

Yes

String (500)

Address line 1 of the entity

• AddressLine1 is mandatory

• Max length for AddressLine1 is 500

7.2

CountryCode

Yes

String (2)

Country code of the entity

• CountryCode is mandatory

• Max length for CountryCode is 2

• Invalid Country

7.3

StateCode

Yes

String (10)

State code of the entity

• StateCode is mandatory

• Max length for StateCode is 10

• Invalid State

7.4

ZipCode

Yes

String (10)

Zip code of the entity

• ZipCode is mandatory

• Max length for ZipCode is 10

7.5

AddressLine2

No

String

Address line 2 of the entity

• Max length for AddressLine2 is 500

7.6

AddressLine3

No

String (100)

Address line 3 of the entity

• Max length for AddressLine3 is 100

7.7

City

No

String (50)

City of the entity

• Max length for City is 50

7.8

FaxNo

No

String (20)

Fax number of the entity

• Max length for FaxNo is 20

• Special characters and spaces are not allowed for Fax number except these +(-./ )#@&

7.9

PhoneExtension

No

String (10)

Phone extension of the entity

• Max length for PhoneExtension is 10

7.10

PhoneNo

No

String (50)

Phone number of the entity

• Max length for PhoneNo is 50

• Special characters and spaces are not allowed for phone except these +(-./ )#@&

7.11

PhoneOther

No

String (20)

Phone 2 of the entity

• Max length for PhoneOther is 20

• Special characters and spaces are not allowed for PhoneOther except these +(-./ )#@&

7.12

PhoneOtherExtension

No

String (10)

Phone 2’s extension of the entity

• Max length for PhoneOtherExtension is 10

7.13

StateOther

No

String

State name (in case of others) of the entity

• Max length for StateOther is 50

7.14

PoBoxNumber

No

String

7.15

County

No

String (50)

County of the address

• Max length for County is 50

PartnerContact

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

3.1

ContactCode

Yes

String(100)

Contact code of the partner contact

• ContactCode is mandatory

• Max length for ContactCode is 100

3.2

FirstName

Yes

String(50)

First name of the partner contact

• FirstName is mandatory

• Max length for FirstName is 50

• Special characters are not allowed for FirstName except these (@&-_ #/.)',

3.3

EmailAddress

Yes

String(100)

Email address of the partner contact

• Email Address is mandatory

• Max length for EmailAddress is 100

• Invalid Email Address

3.4

UserName

No

String(100)

Username of the partner contact

• UserName is mandatory

• Max length for UserName is 100

• Special characters and spaces are not allowed for UserName (except these _.@-),

3.5

GEPContactCode

No

Long

GEP contact code of the partner contact

This field is available only on Outbound and not on Inbound

3.6

PartnerCode

No

String(100)

Partner code of the partner to which this contact belongs

• Max length for PartnerCode is 100

3.7

Address

No

Address object

Check Data Type Address for details

3.8

LastName

No

String

Last name of the partner contact

• Max length for LastName is 30

• Special characters are not allowed for LastName except these (@&-_ #/.)',

3.9

TimeZone

No

String(100)

Partner code of the partner to which this contact belongs

• Max length for TimeZone is 100

• Invalid Timezone if time zone is invalid

3.10

Locations

No

List of Location object

Check Data Type Location for details

3.11

IsPrimary

No

Boolean

Status of the partner contact if this contact is the primary contact or not

3.12

IsActive

No

Boolean

Status of the partner contact if active or not

3.13

IsDeleted

No

Boolean

Visibility status of the partner contact if visible on the application platform of not

3.14

UserActivities

No

List of Activity object

Check Data Type Activity for details

3.15

SourceSystemDetails

No

List of SourceSystemDetails object

An array of strings that contain information on source systems of contact data

3.16

CultureCode

No

String

Culture Code of partner

• Invalid Culture Code

3.17

ContactTrackingTypeName

No

List of String

Contact Tracking Type Name

Locations

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

3.10.1

LocationCode

Yes

String

Location code of this location

• LocationCode is mandatory

• Max length for LocationCode is 50

3.10.2

LocationName

Yes

String(100)

Name of this location

• LocationName is mandatory

• Max length for LocationName is 100

3.10.3

GEPLocationCode

No

Long

GEP location code of the entity

This field is only available on Outbound and not on Inbound

3.10.4

Address

No

Address object

Check Data Type Address for details

3.10.5

IsDeleted

No

Boolean

Visibility status of the entity on whether it should be visible on the application or not

3.10.6

LocationType

No

LocationType Enum

An Array of location types. The list of location types that are available to select are as follows; “None”, “RemitToLocation”, “OrderingLocation”, “SolicitationLocation”, “InvoicingLocation”, “Other”

Note: The values in this field are case sensitive

3.10.7

LocationTypes

No

List of string

• Invalid Location Type

3.10.8

PartnerContact

No

List of PartnerContact object

Check Data Type PartnerContact for details

This field is only available on Outbound and not on Inbound

3.10.9

EngagementModel

No

List of EngagementEntityDetail object

Check Data Type EngagementEntityDetail for details

3.10.10

SourceSystemDetails

No

List of SourceSystemDetails object

An array of strings that contain information on source systems of location data

3.10.11

OtherIdentificationTypes

No

List of OtherIdentificationType object

Check Data type OtherIdentificationType for Details

3.10.12

LinkedLocationDetails

No

List of LinkedLocationDetails object

Check Data Type LinkedLocationDetails for details

3.10.13

BankingStatus

No

String

3.10.14

PaymentMethod

No

String

3.10.15

ContactRole

No

List of string

Any array of contact role

3.10.16

IsDefault

No

Boolean

Status of location if this location is default or not

3.10.17

BankingInfo

No

List of PartnerBankingInformations object

Check Data Type PartnerBankingInformations for details

EngagementModel

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

3.10.9.1

EntityCode

No

String

Entity Code of entity

3.10.9.2

EntityType

No

String

Entity type of entity

3.10.9.3

EngagementType

No

List of String

Engagement Type of entity

3.10.9.4

LobEntityCode

No

String

Lob Entity Code of entity

SourceSystemDetails

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

3.10.10.1

Name

Yes

String

Source system name

• Invalid source system Name

3.10.10.2

Value

Yes

String

Source system value

• Source system value is mandatory

OtherIdentificationTypes

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

3.10.11.1

IdentificationNumber

No

String(30)

Identification number of the entity

• IdentificationNumber is mandatory

• Max length for IdentificationNumber is 30

3.10.11.2

IdentificationType

No

IdentificationType Enum

One of the following values will be provided in this field; “NONE”, “US_FEDERAL_TAX_ID_EIN_NUMBER”, “SOCIAL_SECURITY_NUMBER”, “VAT_REGISTRATION_NUMBER”, “GST_QST_HST”, “LEI”, “SIC_CODE”, “NACIS_CODE”, “TIN_NUMBER”.

Note: The values in this field are case sensitive

LinkedLocationDetails

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

3.10.12.1

LinkedGEPLocationID

No

Long

GEP Linked Location Id

3.10.12.2

SourceSystemDetails

No

List of SourceSystemDetails object

Check data type SourceSystemDetails for details

3.10.12.3

GEPLocationID

No

Long

GEP Location Id

3.10.12.4

isDeleted

No

Boolean

Visibility status of the entity on whether it should be visible on the application or not

3.10.12.5

LocationCode

No

String

Location code of linked location

BankingInfo

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

3.10.17.1

BankName

No

String

Bank Name of the entity

3.10.17.2

BeneficiaryName

No

String

Beneficiary Name of the entity

3.10.17.3

BankBranch

No

String

Bank Branch of the entity

3.10.17.4

Country

No

String

Country name of the entity

3.10.17.5

BankAccountNumber

No

String

Bank Account Number of the entity

3.10.17.6

Swift_BIC

No

String

3.10.17.7

IBAN

No

String

3.10.17.8

BankKey_ABA

No

String

3.10.17.9

ChipUid

No

String

3.10.17.10

AccountTypeName

No

String

Account Type Name of entity

3.10.17.11

PaymentMethodName

No

String

Payment Method Name

3.10.17.12

IsDeleted

No

Boolean

Visibility status of the entity on whether it should be visible on the application or not

3.10.17.13

FIKCode

No

String

3.10.17.14

FactoringCompanyName

No

String

GEP Linked Location Id

3.10.17.15

FactoringCompanyCVR

No

String

3.10.17.16

Comments

No

String

Comments

UserActivities

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

3.14.1

UserActivity

No

String

Categories

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

20.1

PasCode

No

Long

Pas Code of entity

20.2

IsDefault

No

Boolean

Status of the entity if this is default or not

20.3

ClientPasCode

No

String

Client Pas Code of entity

• Invalid Client Pas Code

20.4

IsDeleted

No

Boolean

status of the entity on whether it should be visible on the application or not

DiversityDetails

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

28.1

DiversityName

Yes

String(2000)

Name of the diversity

• Diversity name is mandatory

• Max length for DiversityName is 2000

28.2

DiversityDescription

No

String

Description of the diversity

28.3

CertificateDetails

No

Certificate object

Check Data Type Certificates for details

This field is only available on Outbound and not on Inbound

Certifications

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

29.1

CertificateName

Yes

String(100)

Name of the certificate

• CertificateName is mandatory

• Max length for CertificateName is 100

29.2

CertificateNumber

Yes

String(100)

Number of the certificate

• CertificateNumber is mandatory

• Max length for CertificateNumber is 100

29.3

CertificateType

Yes

Certificate object

One of the following values will be provided in this field; “None", "Other”, "COICertificateOfInsurance", "Diversity",

"ISO_InternationalStandardizationOrganization",

"PCI_PaymentCardIndustrySecurityStandardsReports", "RStamp",

"SOC_ServiceOrganizationControlReports", “TQM_TotalQualityManagement”.

Note: The values in this field are case sensitive

• CertificateType is mandatory

• Invalid Certificate Type

29.4

IssuingAuthority

Yes

String (100)

Organization or authority which issued this certificate

• IssuingAuthority is mandatory

• Max length for IssuingAuthority is 100

29.5

EffectiveDate

No

dateTime

Date from when the certificate is effective

29.6

ExpiryDate

No

dateTime

Date from when the certificate will expire

29.7

TypeOfCertificate

No

String (100)

Certificate Type

29.8

IsDeleted

No

Boolean

Status of the certificate

29.9

FileDetail

No

List of BZFileDetails object

Check Data Type BZFileDetails for details

FileDetail

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

29.9.1

FileName

No

String

File Name of entity

29.9.2

FileData

No

Byte

File Data of entity

29.9.3

FileExtn

No

String

File Extn of entity

29.9.4

ContentType

No

String

Content Type of entity

29.9.5

IsDeleted

No

Boolean

Visibility status of the entity on whether it should be visible on the application or not

29.9.6

AttachmentID

No

Long

Attachment ID of entity

29.9.7

CertificateID

No

Long

Attachment ID of entity

AdditionalInformation

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

30.1

QuestionText

No

String

Text of the question

30.2

QuestionsResponseList

No

List of QuestionResponse object

An array of question response

30.3

QuestionId

No

Long

Id of question

30.4

isDeleted

No

Boolean

Status of the entity if they are to be visible or not, on the application

QuestionsResponseList

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

30.2.1

ChildQuestionList

No

List of Question object

An array of child questions (if any) under this parent question

30.2.2

ResponseValue

No

String

Response value that is available under a question

30.2.3

ColumnText

No

String

Text of the column

30.2.4

RowId

No

Long

Row Id

PaymentTerms

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

31.1

PaymentTermName

No

String

The name of the payment term

31.2

IsDefault

No

Boolean

Status of the payment term if this payment term is default or not

31.3

PaymentTermCode

No

String

The code of the payment term

31.4

OrgEntities

No

List of OrgEntity object

Check data type OrgEntity for details

31.5

LobEntityCode

No

String

LobEntityCode of the payment term

OrgEntities

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

31.4.1

EntityCode

No

String

Entity Code of entity

• Invalid Entity Code

31.4.2

IsDefault

No

Boolean

Status of the entity if this is default or not

31.4.3

EntityType

No

String

Entity Type of entity

31.4.4

LOBEntityCode

No

String

LOB Entity Code of entity

TransactionTypes

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

34.1

TransactionTypeName

No

String

Name of Transaction Type

34.2

TransactionMethod

No

String

Method of Transaction

34.3

ClientPartnerCode

No

String

Client Partner Code of transaction

LanguagesSupported

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

41.1

LanguageCode

No

String

Language Code of entity

• Invalid Language Details

41.2

LanguageDescription

No

String

Language Description of entity

• Invalid Language Details

ShippingDetails

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

42.1

FOBCode

Yes

String

FOB Code for shipping

• Invalid FOB Code

42.2

LocationCode

Yes

String

Location Code for shipping

• Invalid FOB Location Code

42.3

FOBDescription

No

String

FOB Description for shipping

42.4

LOBEntityCode

No

String

LOB Entity Code for shipping

• Invalid LOB Entity Code

42.5

LocationDescription

No

String

Location Description for shipping

42.6

OrgEntities

No

List of OrgEntity object

Check data type OrgEntity for details

CurrencyOrgMapping

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

44.1

CurrencyCode

Yes

String

44.2

OrgEntities

No

List of OrgEntity object

Check data type OrgEntity for details

• Entity code and entity type is mandatory for Currency or Mapping

44.3

LOBEntityCode

No

String

FormerlyKnownAs

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

53.1

SequenceNumber

No

Long

Sequence Number of entity

53.2

Name

No

String

Name for FormelyKnownAs

53.3

ModifiedDate

No

DateTime

Modified Date

53.4

IsDeleted

No

Boolean

Status of the entity on whether it should be visible on the application or not